From acae9e266508cac47bf97fd971e20148a42ba7a6 Mon Sep 17 00:00:00 2001 From: ejMina226 <118474890+ejMina226@users.noreply.github.com> Date: Fri, 24 Jan 2025 09:58:42 +0000 Subject: [PATCH 01/37] Initial draft --- src/pages/docs/_meta.json | 7 ++++- src/pages/docs/workers.mdx | 64 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 src/pages/docs/workers.mdx diff --git a/src/pages/docs/_meta.json b/src/pages/docs/_meta.json index 3c4a703..0a32bd4 100644 --- a/src/pages/docs/_meta.json +++ b/src/pages/docs/_meta.json @@ -15,5 +15,10 @@ "runtime": "Runtime", "library": "Library", "advanced": "Advanced", - "tutorials": "Tutorials" + "tutorials": "Tutorials", + "-- Contributor Documentation": { + "type": "separator", + "title": "Developer Documentation" + }, + "workers": "Worker Architecture" } diff --git a/src/pages/docs/workers.mdx b/src/pages/docs/workers.mdx new file mode 100644 index 0000000..206fb3f --- /dev/null +++ b/src/pages/docs/workers.mdx @@ -0,0 +1,64 @@ +# Worker Architecture + +All sequencer modules are registered, resolved and then started when the AppChain is started. Several of these modules +are what define the process to be a worker. This can be considered a lightweight instance of the AppChain that is responsible +for executing expensive asynchronous `tasks`, such as Block Proving, so that the main AppChain isn't blocked by them. For testing purposes, +it is fine to have the main AppChain be the worker, but in production set-ups you will likely want multiple workers defined, +separately. + +## LocalWorkerTaskModule +This module is used to create a worker locally. Without this being defined in some process no worker will be spawned and +this means no tasks will be processed. This module is itself defined with several tasks that it will be capable of executing, such as + - StateTransitionTask, + - StateTransitionReductionTask, + - RuntimeProvingTask, + - BlockProvingTask, + - BlockReductionTask, + - BlockBuildingTak, + - NewBlockTask, + - CircuitCompilerTask + - WorkerRegistrationTask. + +When the LocalWorkerTaskModule is started it has a set of start-up tasks, like those above, passed to it. These tasks basically +define what sort of computations the worker can handle, as you may want different workers to handle different tasks for resourcing reasons. +There are two types of tasks: `Unprepared`, i.e. tasks that don’t have a prepare method and therefore don’t need to wait for registration to get initialized, and + `Regular`, i.e. all other tasks that require registration. + +When the worker is started it first registers the required callback functions for the `Unprepared` tasks, i.e. CircuitCompilerTask and WorkerRegistrationTask, +with the queue, so that when the queue receives these tasks the worker can process them. Then, the LocalWorkerTaskModule +calls the `prepare` method for non-startup/normal tasks, before registering them with the queue. This registration ensures the worker is ready to handle any request +when one later comes in. Once these are completed a promise is resolved, called `prepareResolve`. This tells the LocalWorkerTaskModule +it is ready, and the LocalWorkerTaskModule emits a `ready` event of its own that other modules like the WorkerReadyModule are waiting for to proceed. + +## WorkerReadyModule + +This is another sequencer module that waits until key events have been emitted by the LocalTaskWorkerModule to signal that the worker +is ready and that the app chain can continue. The WorkerReadyModule is called by the AppChain.ts at the end of the start() method. +If the WorkerReadyModule + +## SequencerStartUpModule + +This is module is designed to ensure that all zk-circuits are compiled and their +verification keys are accessible to the workers that will need them. This spares workers from having to waste resources compiling the circuits +themselves. This is achieved by having the AppChain use the verification keys, and compilation artifacts, which are static parameters, as input to the +WorkerRegistrationFlow. This in turns leaves it as a task on the queue. A worker when starting-up will process the task that has been pushed onto the queue +and access these static parameters that way. In order for subsequent workers to have access to the same task, which will be removed from the queue after having +been executed, the sequencer uses the WorkerRegistrationFlow to push the same task again in a boundless loop. This loop consumes no resources as it is just a Promise +that awaits until a worker has registered. We ensure it's the new worker that picks up this task from the queue and not an older worker that is already configured, by having the old worker be configured +to delete the task-handler for the registration from its local queue so that it can't handle that particular kind of task, anymore. + +## TaskQueue + +The TaskQueue has two different implementations: + +### BullQueue +This is Redis underneath. Each worker registers to consume specific jobs. Redis takes care of a lot of the implementation details. +This uses a separate Redis instance, whose configuration details are shared with the AppChain on start-up. +In the starter-kit, this is run from Docker. + +### LocalTaskQueue +LocalTaskQueue, which can only be used by one worker built into the AppChain, as it's not really a queue, executing tasks directly where possible. +The `workNextTasks()` is called whenever a task is added to the queue and again after tasks have already been executed (in case any others have been added in the meanwhile). +The LocalTaskQueue isn't suitable for production usage because it runs only one instance in-process. But for mock-proofs it's good enough. + + From 273d985745d1e39980b29fbb641f57fe62cdeabc Mon Sep 17 00:00:00 2001 From: ejMina226 <118474890+ejMina226@users.noreply.github.com> Date: Fri, 24 Jan 2025 10:11:39 +0000 Subject: [PATCH 02/37] Corrections. --- src/pages/docs/workers.mdx | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/src/pages/docs/workers.mdx b/src/pages/docs/workers.mdx index 206fb3f..64034bd 100644 --- a/src/pages/docs/workers.mdx +++ b/src/pages/docs/workers.mdx @@ -6,7 +6,8 @@ for executing expensive asynchronous `tasks`, such as Block Proving, so that the it is fine to have the main AppChain be the worker, but in production set-ups you will likely want multiple workers defined, separately. -## LocalWorkerTaskModule +## LocalTaskWorkerModule + This module is used to create a worker locally. Without this being defined in some process no worker will be spawned and this means no tasks will be processed. This module is itself defined with several tasks that it will be capable of executing, such as - StateTransitionTask, @@ -19,33 +20,34 @@ this means no tasks will be processed. This module is itself defined with severa - CircuitCompilerTask - WorkerRegistrationTask. -When the LocalWorkerTaskModule is started it has a set of start-up tasks, like those above, passed to it. These tasks basically +When the `LocalTaskWorkerModule` is started it has a set of start-up tasks, like those above, passed to it. These tasks basically define what sort of computations the worker can handle, as you may want different workers to handle different tasks for resourcing reasons. There are two types of tasks: `Unprepared`, i.e. tasks that don’t have a prepare method and therefore don’t need to wait for registration to get initialized, and `Regular`, i.e. all other tasks that require registration. -When the worker is started it first registers the required callback functions for the `Unprepared` tasks, i.e. CircuitCompilerTask and WorkerRegistrationTask, +When the worker is started it first registers the required callback functions for the `Unprepared` tasks, i.e. `CircuitCompilerTask` and `WorkerRegistrationTask`, with the queue, so that when the queue receives these tasks the worker can process them. Then, the LocalWorkerTaskModule calls the `prepare` method for non-startup/normal tasks, before registering them with the queue. This registration ensures the worker is ready to handle any request when one later comes in. Once these are completed a promise is resolved, called `prepareResolve`. This tells the LocalWorkerTaskModule -it is ready, and the LocalWorkerTaskModule emits a `ready` event of its own that other modules like the WorkerReadyModule are waiting for to proceed. +it is ready, and the `LocalTaskWorkerModule` emits a `ready` event of its own that other modules like the `WorkerReadyModule` are waiting for to proceed. ## WorkerReadyModule This is another sequencer module that waits until key events have been emitted by the LocalTaskWorkerModule to signal that the worker -is ready and that the app chain can continue. The WorkerReadyModule is called by the AppChain.ts at the end of the start() method. -If the WorkerReadyModule +is ready and that the app chain can continue. The `WorkerReadyModule` is called by the `AppChain.ts` at the end of the `start()` method. +If the `waitForReady()` method on the `WorkerReadyModule` is never resolved then the AppChain will never finish it's start-up. Note that the +`waitForReady()` is will always complete if the AppChain is not a worker, in particular if LocalTaskWorkerModule is not defined. ## SequencerStartUpModule -This is module is designed to ensure that all zk-circuits are compiled and their -verification keys are accessible to the workers that will need them. This spares workers from having to waste resources compiling the circuits -themselves. This is achieved by having the AppChain use the verification keys, and compilation artifacts, which are static parameters, as input to the -WorkerRegistrationFlow. This in turns leaves it as a task on the queue. A worker when starting-up will process the task that has been pushed onto the queue -and access these static parameters that way. In order for subsequent workers to have access to the same task, which will be removed from the queue after having -been executed, the sequencer uses the WorkerRegistrationFlow to push the same task again in a boundless loop. This loop consumes no resources as it is just a Promise -that awaits until a worker has registered. We ensure it's the new worker that picks up this task from the queue and not an older worker that is already configured, by having the old worker be configured -to delete the task-handler for the registration from its local queue so that it can't handle that particular kind of task, anymore. +This is module is designed to ensure that all zk-circuits are compiled and their verification keys are accessible to the workers that +will need them. This spares workers from having to waste resources compiling the circuits themselves. This is achieved by having the AppChain +use the verification keys, and compilation artifacts, which are static parameters, as input to the `WorkerRegistrationFlow`. This in turns leaves +it as a task on the queue. A worker when starting-up will process the task that has been pushed onto the queue and access these static parameters +that way. In order for subsequent workers to have access to the same task, which will be removed from the queue after having been executed, the +sequencer uses the `WorkerRegistrationFlow` to push the same task again in a boundless loop. This loop consumes no resources as it is just a `Promise` that +awaits until a worker has registered. We ensure it's the new worker that picks up this task from the queue and not an older worker that is already configured, +by having the old worker be configured to delete the task-handler for the registration from its local queue so that it can't handle that particular kind of task, anymore. ## TaskQueue @@ -57,8 +59,8 @@ This uses a separate Redis instance, whose configuration details are shared with In the starter-kit, this is run from Docker. ### LocalTaskQueue -LocalTaskQueue, which can only be used by one worker built into the AppChain, as it's not really a queue, executing tasks directly where possible. +This can only be used by one worker built into the AppChain, as it's not really a queue, executing tasks directly where possible. The `workNextTasks()` is called whenever a task is added to the queue and again after tasks have already been executed (in case any others have been added in the meanwhile). -The LocalTaskQueue isn't suitable for production usage because it runs only one instance in-process. But for mock-proofs it's good enough. +The `LocalTaskQueue` isn't suitable for production usage because it runs only one instance in-process. But for mock-proofs it's good enough. From f5dc26ca0663febb0d8684e8574dcb459e65524d Mon Sep 17 00:00:00 2001 From: ejMina226 <118474890+ejMina226@users.noreply.github.com> Date: Fri, 24 Jan 2025 10:17:46 +0000 Subject: [PATCH 03/37] Corrections. --- src/pages/docs/workers.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/pages/docs/workers.mdx b/src/pages/docs/workers.mdx index 64034bd..c6b0396 100644 --- a/src/pages/docs/workers.mdx +++ b/src/pages/docs/workers.mdx @@ -33,10 +33,10 @@ it is ready, and the `LocalTaskWorkerModule` emits a `ready` event of its own th ## WorkerReadyModule -This is another sequencer module that waits until key events have been emitted by the LocalTaskWorkerModule to signal that the worker +This is another sequencer module that waits until key events have been emitted by the `LocalTaskWorkerModule` to signal that the worker is ready and that the app chain can continue. The `WorkerReadyModule` is called by the `AppChain.ts` at the end of the `start()` method. -If the `waitForReady()` method on the `WorkerReadyModule` is never resolved then the AppChain will never finish it's start-up. Note that the -`waitForReady()` is will always complete if the AppChain is not a worker, in particular if LocalTaskWorkerModule is not defined. +If the `waitForReady()` method on the `WorkerReadyModule` is never resolved then the AppChain will never finish its start-up. Note that the +`waitForReady()` is will always complete if the AppChain is not a worker, in particular if `LocalTaskWorkerModule` is not defined. ## SequencerStartUpModule From d5a6158f0de28c7ef88a294247dfaef5d6669382 Mon Sep 17 00:00:00 2001 From: ejMina226 <118474890+ejMina226@users.noreply.github.com> Date: Fri, 24 Jan 2025 10:21:57 +0000 Subject: [PATCH 04/37] Corrections. --- src/pages/docs/_meta.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/_meta.json b/src/pages/docs/_meta.json index 0a32bd4..f83a6e1 100644 --- a/src/pages/docs/_meta.json +++ b/src/pages/docs/_meta.json @@ -18,7 +18,7 @@ "tutorials": "Tutorials", "-- Contributor Documentation": { "type": "separator", - "title": "Developer Documentation" + "title": "Contributor Documentation" }, "workers": "Worker Architecture" } From f92ac88d505a25f673fd85df447741c39936c1c8 Mon Sep 17 00:00:00 2001 From: ejMina226 <118474890+ejMina226@users.noreply.github.com> Date: Fri, 24 Jan 2025 10:28:17 +0000 Subject: [PATCH 05/37] Corrections. --- src/pages/docs/workers.mdx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/src/pages/docs/workers.mdx b/src/pages/docs/workers.mdx index c6b0396..7c8bdd3 100644 --- a/src/pages/docs/workers.mdx +++ b/src/pages/docs/workers.mdx @@ -26,15 +26,14 @@ There are two types of tasks: `Unprepared`, i.e. tasks that don’t have a prepa `Regular`, i.e. all other tasks that require registration. When the worker is started it first registers the required callback functions for the `Unprepared` tasks, i.e. `CircuitCompilerTask` and `WorkerRegistrationTask`, -with the queue, so that when the queue receives these tasks the worker can process them. Then, the LocalWorkerTaskModule -calls the `prepare` method for non-startup/normal tasks, before registering them with the queue. This registration ensures the worker is ready to handle any request -when one later comes in. Once these are completed a promise is resolved, called `prepareResolve`. This tells the LocalWorkerTaskModule -it is ready, and the `LocalTaskWorkerModule` emits a `ready` event of its own that other modules like the `WorkerReadyModule` are waiting for to proceed. +with its local instance of the queue. Then, the `LocalTaskWorkerModule` calls the `prepare` method for non-startup/normal tasks, before registering their callbacks with the queue. +This registration ensures the worker is ready to handle any request when one later arrives via the queue. Once all the tasks are registered a promise is resolved, called `prepareResolve`. +This tells the `LocalTaskWorkerModule` it is ready, and the `LocalTaskWorkerModule` emits a `ready` event of its own that other modules like the `WorkerReadyModule` are waiting for to proceed. ## WorkerReadyModule This is another sequencer module that waits until key events have been emitted by the `LocalTaskWorkerModule` to signal that the worker -is ready and that the app chain can continue. The `WorkerReadyModule` is called by the `AppChain.ts` at the end of the `start()` method. +is ready and that the AppChain can continue. The `WorkerReadyModule` is called by the `AppChain.ts` at the end of the `start()` method. If the `waitForReady()` method on the `WorkerReadyModule` is never resolved then the AppChain will never finish its start-up. Note that the `waitForReady()` is will always complete if the AppChain is not a worker, in particular if `LocalTaskWorkerModule` is not defined. From b69fab46c98a587fb3f5215ab99f71dd2910ab83 Mon Sep 17 00:00:00 2001 From: ejMina226 <118474890+ejMina226@users.noreply.github.com> Date: Fri, 24 Jan 2025 12:52:31 +0000 Subject: [PATCH 06/37] Add in Worker Start-up Flow --- src/pages/docs/workers.mdx | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/workers.mdx b/src/pages/docs/workers.mdx index 7c8bdd3..aea8ed1 100644 --- a/src/pages/docs/workers.mdx +++ b/src/pages/docs/workers.mdx @@ -38,7 +38,6 @@ If the `waitForReady()` method on the `WorkerReadyModule` is never resolved then `waitForReady()` is will always complete if the AppChain is not a worker, in particular if `LocalTaskWorkerModule` is not defined. ## SequencerStartUpModule - This is module is designed to ensure that all zk-circuits are compiled and their verification keys are accessible to the workers that will need them. This spares workers from having to waste resources compiling the circuits themselves. This is achieved by having the AppChain use the verification keys, and compilation artifacts, which are static parameters, as input to the `WorkerRegistrationFlow`. This in turns leaves @@ -48,8 +47,19 @@ sequencer uses the `WorkerRegistrationFlow` to push the same task again in a bou awaits until a worker has registered. We ensure it's the new worker that picks up this task from the queue and not an older worker that is already configured, by having the old worker be configured to delete the task-handler for the registration from its local queue so that it can't handle that particular kind of task, anymore. -## TaskQueue +## Worker Start-up Flow +A summary of the worker registration flow: +1. The `LocalTaskWorkerModule` creates a worker. +2. The worker is started, which registers the callbacks for `Unprepared` tasks with the queue. +3. The worker calls the `prepare()` method for the `Regular` tasks. +4. The worker registers `Regular` tasks with the queue. +5. The AppChain, specifically `SequencerStartupModule`, compiles the zk-circuits of the various zk-Programs. +6. The `SequencerStartupModule` submits a `WorkerRegistration` task to the queue. +7. The worker listens to the queue and processes the `WorkerRegistration` task. +8. The AppChain continues and starts submitting tasks to the queue, which the worker processes. + +## TaskQueue The TaskQueue has two different implementations: ### BullQueue From 45aa1a1b250d690a448ff49806e0a90a40974724 Mon Sep 17 00:00:00 2001 From: ejMina226 <118474890+ejMina226@users.noreply.github.com> Date: Fri, 24 Jan 2025 12:58:52 +0000 Subject: [PATCH 07/37] Fix typo --- src/pages/docs/workers.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/workers.mdx b/src/pages/docs/workers.mdx index aea8ed1..1324671 100644 --- a/src/pages/docs/workers.mdx +++ b/src/pages/docs/workers.mdx @@ -54,7 +54,7 @@ A summary of the worker registration flow: 3. The worker calls the `prepare()` method for the `Regular` tasks. 4. The worker registers `Regular` tasks with the queue. 5. The AppChain, specifically `SequencerStartupModule`, compiles the zk-circuits of the various zk-Programs. -6. The `SequencerStartupModule` submits a `WorkerRegistration` task to the queue. +6. The `SequencerStartupModule` invokes the `WorkerRegistrationFlow` and submits a `WorkerRegistration` task to the queue. 7. The worker listens to the queue and processes the `WorkerRegistration` task. 8. The AppChain continues and starts submitting tasks to the queue, which the worker processes. From 6e8fb91e8a7ef88a55b3e92a5aca4ca274f2aa38 Mon Sep 17 00:00:00 2001 From: ejMina226 <118474890+ejMina226@users.noreply.github.com> Date: Fri, 24 Jan 2025 13:45:14 +0000 Subject: [PATCH 08/37] Fix typo --- src/pages/docs/workers.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/workers.mdx b/src/pages/docs/workers.mdx index 1324671..58a56a9 100644 --- a/src/pages/docs/workers.mdx +++ b/src/pages/docs/workers.mdx @@ -35,7 +35,7 @@ This tells the `LocalTaskWorkerModule` it is ready, and the `LocalTaskWorkerModu This is another sequencer module that waits until key events have been emitted by the `LocalTaskWorkerModule` to signal that the worker is ready and that the AppChain can continue. The `WorkerReadyModule` is called by the `AppChain.ts` at the end of the `start()` method. If the `waitForReady()` method on the `WorkerReadyModule` is never resolved then the AppChain will never finish its start-up. Note that the -`waitForReady()` is will always complete if the AppChain is not a worker, in particular if `LocalTaskWorkerModule` is not defined. +`waitForReady()` will always complete if the AppChain is not a worker, in particular if `LocalTaskWorkerModule` is not defined. ## SequencerStartUpModule This is module is designed to ensure that all zk-circuits are compiled and their verification keys are accessible to the workers that From 8168f612cdc24dda389c0c86cf92be81ae692ff0 Mon Sep 17 00:00:00 2001 From: ejMina226 <118474890+ejMina226@users.noreply.github.com> Date: Fri, 24 Jan 2025 13:52:51 +0000 Subject: [PATCH 09/37] Add in Provable events --- src/pages/docs/_meta.json | 3 ++- src/pages/docs/provable-events.mdx | 27 +++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 src/pages/docs/provable-events.mdx diff --git a/src/pages/docs/_meta.json b/src/pages/docs/_meta.json index f83a6e1..89f7c84 100644 --- a/src/pages/docs/_meta.json +++ b/src/pages/docs/_meta.json @@ -20,5 +20,6 @@ "type": "separator", "title": "Contributor Documentation" }, - "workers": "Worker Architecture" + "workers": "Worker Architecture", + "provable-events": "Provable Events" } diff --git a/src/pages/docs/provable-events.mdx b/src/pages/docs/provable-events.mdx new file mode 100644 index 0000000..2985be9 --- /dev/null +++ b/src/pages/docs/provable-events.mdx @@ -0,0 +1,27 @@ +# Provable Events +The ability for a runtime method to emit provable events gives the user a way to produce events that are verifiable. +The events appear in the output of the runtime method and are stored in the database. Note that due to variable like nature +of the number of events emitted, we commit to a hash of the events. + +Consider the below example for how to define a runtime module and method which outputs provable events. +```typescript {28-31,36-39} showLineNumbers filename="balances.ts" +export class TestEvent extends Struct({ + message: Bool, +}) {} + +@runtimeModule() +class EventMaker extends RuntimeModule { + public constructor() { + super(); + } + + public events = new RuntimeEvents({ + primary: TestEvent, + }); + + @runtimeMethod() + public async makeEvent() { + this.events.emit("primary", new TestEvent({ message: Bool(false) })); + } +} +``` \ No newline at end of file From c0cc86d1530b7945a6bc776fb43d69496962cdb4 Mon Sep 17 00:00:00 2001 From: ejMina226 <118474890+ejMina226@users.noreply.github.com> Date: Fri, 24 Jan 2025 13:56:15 +0000 Subject: [PATCH 10/37] Remove typo --- src/pages/docs/provable-events.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/provable-events.mdx b/src/pages/docs/provable-events.mdx index 2985be9..4abd28a 100644 --- a/src/pages/docs/provable-events.mdx +++ b/src/pages/docs/provable-events.mdx @@ -4,7 +4,7 @@ The events appear in the output of the runtime method and are stored in the data of the number of events emitted, we commit to a hash of the events. Consider the below example for how to define a runtime module and method which outputs provable events. -```typescript {28-31,36-39} showLineNumbers filename="balances.ts" +```typescript {28-31,36-39} showLineNumbers" export class TestEvent extends Struct({ message: Bool, }) {} From 172e62e517bf8fc30a50a24d6121766dee61682e Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Thu, 30 Jan 2025 09:42:32 +0100 Subject: [PATCH 11/37] wip modularity & configuration docs --- src/pages/docs/_meta.json | 1 + src/pages/docs/common/_meta.json | 3 +++ .../docs/common/modularity-configuration.mdx | 17 +++++++++++++++++ 3 files changed, 21 insertions(+) create mode 100644 src/pages/docs/common/_meta.json create mode 100644 src/pages/docs/common/modularity-configuration.mdx diff --git a/src/pages/docs/_meta.json b/src/pages/docs/_meta.json index 89f7c84..a35d023 100644 --- a/src/pages/docs/_meta.json +++ b/src/pages/docs/_meta.json @@ -20,6 +20,7 @@ "type": "separator", "title": "Contributor Documentation" }, + "common": "Common", "workers": "Worker Architecture", "provable-events": "Provable Events" } diff --git a/src/pages/docs/common/_meta.json b/src/pages/docs/common/_meta.json new file mode 100644 index 0000000..5c0bc88 --- /dev/null +++ b/src/pages/docs/common/_meta.json @@ -0,0 +1,3 @@ +{ + "modularity-configuration": "Modularity & Configuration" +} diff --git a/src/pages/docs/common/modularity-configuration.mdx b/src/pages/docs/common/modularity-configuration.mdx new file mode 100644 index 0000000..93a9723 --- /dev/null +++ b/src/pages/docs/common/modularity-configuration.mdx @@ -0,0 +1,17 @@ +# Modularity + +The Protokit framework is built with modularity in mind. Under the hood, we use [`tsyringe`](https://github.com/microsoft/tsyringe) to facilitate +constructor based dependency injection. + +## Configurability + +Basic building block of our modular architecture is module configurability, implemented as `ConfigurableModule`. This ensures +that any module that requires upfront configuration to work properly, will be configured accordingly and in a type-safe manner. + +## Module containers + +Module containers are a way to group individual related modules into a single tsyringe DI container. At the same time these containers provide +an additional layer of functionality, such as additionaly decorating said modules with configs. + +### Container lifecycle + From b0b05eea516c682e56155a283e85e3c0c5ad8340 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Fri, 31 Jan 2025 15:49:54 +0100 Subject: [PATCH 12/37] Added typedoc reference docs --- .npmrc | 1 + README.md | 4 + generate-reference-meta.mjs | 37 + next.config.js | 6 - next.config.mjs | 14 + package.json | 8 +- pnpm-lock.yaml | 3287 ++++++++++------- src/pages/_app.mdx | 11 - src/pages/_app.tsx | 13 + src/pages/_meta.json | 24 - src/pages/_meta.tsx | 24 + src/pages/docs/_meta.json | 26 - src/pages/docs/_meta.tsx | 27 + src/pages/docs/advanced/_meta.json | 4 - src/pages/docs/advanced/_meta.tsx | 4 + src/pages/docs/architecture.mdx | 8 +- src/pages/docs/architecture/_meta.json | 5 - src/pages/docs/architecture/_meta.tsx | 5 + src/pages/docs/common/_meta.json | 3 - src/pages/docs/common/_meta.tsx | 3 + src/pages/docs/library/_meta.json | 3 - src/pages/docs/library/_meta.tsx | 3 + .../docs/quickstart/{_meta.json => _meta.tsx} | 8 +- src/pages/docs/reference/_meta.tsx | 14 + src/pages/docs/reference/api/README.md | 51 + src/pages/docs/reference/api/_meta.tsx | 3 + .../api/classes/AdvancedNodeStatusResolver.md | 124 + .../api/classes/BatchStorageResolver.md | 134 + .../docs/reference/api/classes/BlockModel.md | 71 + .../reference/api/classes/BlockResolver.md | 134 + .../api/classes/ComputedBlockModel.md | 73 + .../reference/api/classes/GraphqlModule.md | 121 + .../api/classes/GraphqlSequencerModule.md | 662 ++++ .../reference/api/classes/GraphqlServer.md | 251 ++ .../reference/api/classes/MempoolResolver.md | 164 + .../reference/api/classes/MerkleWitnessDTO.md | 69 + .../api/classes/MerkleWitnessResolver.md | 130 + .../api/classes/NodeInformationObject.md | 69 + .../reference/api/classes/NodeStatusObject.md | 73 + .../api/classes/NodeStatusResolver.md | 124 + .../api/classes/NodeStatusService.md | 63 + .../api/classes/ProcessInformationObject.md | 105 + .../api/classes/QueryGraphqlModule.md | 276 ++ .../classes/ResolverFactoryGraphqlModule.md | 127 + .../classes/SchemaGeneratingGraphqlModule.md | 126 + .../docs/reference/api/classes/Signature.md | 51 + .../api/classes/TransactionObject.md | 141 + .../api/classes/VanillaGraphqlModules.md | 81 + .../reference/api/functions/graphqlModule.md | 32 + .../api/interfaces/GraphqlModulesDefintion.md | 33 + .../api/interfaces/NodeInformation.md | 29 + .../api/interfaces/ProcessInformation.md | 69 + .../api/type-aliases/GraphqlModulesRecord.md | 15 + .../VanillaGraphqlModulesRecord.md | 41 + src/pages/docs/reference/common/README.md | 136 + src/pages/docs/reference/common/_meta.tsx | 3 + .../common/classes/AtomicCompileHelper.md | 53 + .../classes/ChildVerificationKeyService.md | 67 + .../common/classes/CompileRegistry.md | 124 + .../common/classes/ConfigurableModule.md | 114 + .../reference/common/classes/EventEmitter.md | 161 + .../common/classes/EventEmitterProxy.md | 196 + .../classes/InMemoryMerkleTreeStorage.md | 100 + .../classes/MockAsyncMerkleTreeStore.md | 103 + .../common/classes/ModuleContainer.md | 520 +++ .../classes/ProvableMethodExecutionContext.md | 187 + .../classes/ProvableMethodExecutionResult.md | 79 + .../classes/ReplayingSingleUseEventEmitter.md | 203 + .../common/classes/RollupMerkleTree.md | 291 ++ .../common/classes/RollupMerkleTreeWitness.md | 575 +++ .../common/classes/ZkProgrammable.md | 93 + .../functions/assertValidTextLogLevel.md | 25 + .../common/functions/compileToMockable.md | 33 + .../common/functions/createMerkleTree.md | 43 + .../reference/common/functions/dummyValue.md | 35 + .../common/functions/expectDefined.md | 29 + .../common/functions/filterNonNull.md | 29 + .../common/functions/filterNonUndefined.md | 29 + .../common/functions/getInjectAliases.md | 25 + .../common/functions/hashWithPrefix.md | 29 + .../reference/common/functions/implement.md | 48 + .../reference/common/functions/injectAlias.md | 40 + .../common/functions/injectOptional.md | 60 + .../common/functions/isSubtypeOfName.md | 32 + .../common/functions/mapSequential.md | 35 + .../docs/reference/common/functions/noop.md | 19 + .../common/functions/prefixToField.md | 25 + .../common/functions/provableMethod.md | 55 + .../docs/reference/common/functions/range.md | 29 + .../common/functions/reduceSequential.md | 39 + .../reference/common/functions/requireTrue.md | 29 + .../common/functions/safeParseJson.md | 29 + .../docs/reference/common/functions/sleep.md | 25 + .../reference/common/functions/splitArray.md | 38 + .../reference/common/functions/toProver.md | 47 + .../common/functions/verifyToMockable.md | 45 + .../common/interfaces/AbstractMerkleTree.md | 177 + .../interfaces/AbstractMerkleTreeClass.md | 79 + .../interfaces/AbstractMerkleWitness.md | 155 + .../common/interfaces/AreProofsEnabled.md | 39 + .../interfaces/BaseModuleInstanceType.md | 51 + .../interfaces/ChildContainerCreatable.md | 35 + .../interfaces/ChildContainerProvider.md | 21 + .../common/interfaces/CompilableModule.md | 36 + .../reference/common/interfaces/Compile.md | 21 + .../common/interfaces/CompileArtifact.md | 29 + .../common/interfaces/Configurable.md | 29 + .../common/interfaces/DependencyFactory.md | 41 + .../interfaces/EventEmittingComponent.md | 29 + .../interfaces/EventEmittingContainer.md | 25 + .../common/interfaces/MerkleTreeStore.md | 61 + .../interfaces/ModuleContainerDefinition.md | 37 + .../common/interfaces/ModulesRecord.md | 21 + .../common/interfaces/PlainZkProgram.md | 237 ++ .../interfaces/StaticConfigurableModule.md | 25 + .../common/interfaces/ToFieldable.md | 25 + .../common/interfaces/ToFieldableStatic.md | 31 + .../common/interfaces/ToJSONableStatic.md | 31 + .../reference/common/interfaces/Verify.md | 33 + .../common/interfaces/WithZkProgrammable.md | 33 + .../common/type-aliases/ArgumentTypes.md | 15 + .../common/type-aliases/ArrayElement.md | 21 + .../common/type-aliases/ArtifactRecord.md | 15 + .../common/type-aliases/BaseModuleType.md | 15 + .../common/type-aliases/CapitalizeAny.md | 19 + .../common/type-aliases/CastToEventsRecord.md | 19 + .../common/type-aliases/CompileTarget.md | 29 + .../common/type-aliases/ContainerEvents.md | 19 + .../common/type-aliases/DecoratedMethod.md | 25 + .../type-aliases/DependenciesFromModules.md | 19 + .../type-aliases/DependencyDeclaration.md | 19 + .../common/type-aliases/DependencyRecord.md | 15 + .../common/type-aliases/EventListenable.md | 19 + .../common/type-aliases/EventsRecord.md | 15 + .../common/type-aliases/FilterNeverValues.md | 19 + .../common/type-aliases/FlattenObject.md | 19 + .../type-aliases/FlattenedContainerEvents.md | 19 + .../common/type-aliases/InferDependencies.md | 19 + .../common/type-aliases/InferProofBase.md | 19 + .../MapDependencyRecordToTypes.md | 19 + .../common/type-aliases/MergeObjects.md | 19 + .../common/type-aliases/ModuleEvents.md | 19 + .../common/type-aliases/ModulesConfig.md | 19 + .../reference/common/type-aliases/NoConfig.md | 15 + .../common/type-aliases/NonMethods.md | 19 + .../common/type-aliases/O1JSPrimitive.md | 15 + .../reference/common/type-aliases/OmitKeys.md | 21 + .../type-aliases/OverwriteObjectType.md | 21 + .../reference/common/type-aliases/Preset.md | 19 + .../reference/common/type-aliases/Presets.md | 19 + .../common/type-aliases/ProofTypes.md | 15 + .../common/type-aliases/RecursivePartial.md | 26 + .../common/type-aliases/ResolvableModules.md | 19 + .../common/type-aliases/StringKeyOf.md | 22 + .../TypeFromDependencyDeclaration.md | 19 + .../common/type-aliases/TypedClass.md | 29 + .../common/type-aliases/UnTypedClass.md | 25 + .../type-aliases/UnionToIntersection.md | 21 + .../common/variables/EMPTY_PUBLICKEY.md | 15 + .../common/variables/EMPTY_PUBLICKEY_X.md | 15 + .../reference/common/variables/MAX_FIELD.md | 15 + .../reference/common/variables/MOCK_PROOF.md | 15 + .../common/variables/MOCK_VERIFICATION_KEY.md | 15 + .../common/variables/ModuleContainerErrors.md | 121 + .../variables/injectAliasMetadataKey.md | 15 + .../docs/reference/common/variables/log.md | 355 ++ src/pages/docs/reference/deployment/README.md | 48 + src/pages/docs/reference/deployment/_meta.tsx | 3 + .../reference/deployment/classes/BullQueue.md | 266 ++ .../deployment/classes/Environment.md | 105 + .../docs/reference/deployment/globals.md | 25 + .../deployment/interfaces/BullQueueConfig.md | 49 + .../deployment/interfaces/Startable.md | 25 + .../type-aliases/StartableEnvironment.md | 19 + src/pages/docs/reference/indexer/README.md | 34 + src/pages/docs/reference/indexer/_meta.tsx | 3 + .../GeneratedResolverFactoryGraphqlModule.md | 148 + .../indexer/classes/IndexBlockTask.md | 218 ++ .../IndexBlockTaskParametersSerializer.md | 99 + .../docs/reference/indexer/classes/Indexer.md | 632 ++++ .../indexer/classes/IndexerModule.md | 120 + .../indexer/classes/IndexerNotifier.md | 191 + .../indexer/functions/ValidateTakeArg.md | 19 + .../indexer/functions/cleanResolvers.md | 25 + .../interfaces/IndexBlockTaskParameters.md | 41 + .../type-aliases/IndexerModulesRecord.md | 15 + .../NotifierMandatorySequencerModules.md | 21 + src/pages/docs/reference/library/README.md | 60 + src/pages/docs/reference/library/_meta.tsx | 3 + .../docs/reference/library/classes/Balance.md | 1125 ++++++ .../reference/library/classes/Balances.md | 424 +++ .../reference/library/classes/BalancesKey.md | 451 +++ .../docs/reference/library/classes/FeeTree.md | 291 ++ .../classes/InMemorySequencerModules.md | 45 + .../library/classes/MethodFeeConfigData.md | 597 +++ .../classes/RuntimeFeeAnalyzerService.md | 216 ++ .../library/classes/SimpleSequencerModules.md | 161 + .../docs/reference/library/classes/TokenId.md | 1605 ++++++++ .../library/classes/TransactionFeeHook.md | 291 ++ .../docs/reference/library/classes/UInt.md | 924 +++++ .../docs/reference/library/classes/UInt112.md | 1117 ++++++ .../docs/reference/library/classes/UInt224.md | 1105 ++++++ .../docs/reference/library/classes/UInt32.md | 1117 ++++++ .../docs/reference/library/classes/UInt64.md | 1109 ++++++ .../library/classes/VanillaProtocolModules.md | 155 + .../library/classes/VanillaRuntimeModules.md | 61 + .../library/classes/WithdrawalEvent.md | 489 +++ .../library/classes/WithdrawalKey.md | 421 +++ .../reference/library/classes/Withdrawals.md | 302 ++ .../library/interfaces/BalancesEvents.md | 29 + .../library/interfaces/FeeIndexes.md | 17 + .../library/interfaces/FeeTreeValues.md | 17 + .../library/interfaces/MethodFeeConfig.md | 45 + .../RuntimeFeeAnalyzerServiceConfig.md | 61 + .../interfaces/TransactionFeeHookConfig.md | 81 + .../AdditionalSequencerModules.md | 15 + .../InMemorySequencerModulesRecord.md | 49 + .../library/type-aliases/MinimalBalances.md | 47 + .../MinimumAdditionalSequencerModules.md | 33 + .../SimpleSequencerModulesRecord.md | 15 + .../SimpleSequencerWorkerModulesRecord.md | 25 + .../library/type-aliases/UIntConstructor.md | 99 + .../VanillaProtocolModulesRecord.md | 21 + .../VanillaRuntimeModulesRecord.md | 21 + .../reference/library/variables/errors.md | 33 + .../library/variables/treeFeeHeight.md | 15 + src/pages/docs/reference/module/README.md | 124 + src/pages/docs/reference/module/_meta.tsx | 3 + .../module/classes/InMemoryStateService.md | 93 + .../module/classes/MethodIdFactory.md | 62 + .../module/classes/MethodIdResolver.md | 90 + .../module/classes/MethodParameterEncoder.md | 134 + .../docs/reference/module/classes/Runtime.md | 782 ++++ .../reference/module/classes/RuntimeEvents.md | 91 + .../reference/module/classes/RuntimeModule.md | 209 ++ .../module/classes/RuntimeZkProgrammable.md | 125 + .../module/functions/combineMethodName.md | 29 + .../module/functions/getAllPropertyNames.md | 25 + .../module/functions/isRuntimeMethod.md | 38 + .../module/functions/runtimeMessage.md | 37 + .../module/functions/runtimeMethod.md | 37 + .../module/functions/runtimeModule.md | 35 + .../docs/reference/module/functions/state.md | 40 + .../module/functions/toEventsHash.md | 25 + .../functions/toStateTransitionsHash.md | 25 + .../module/functions/toWrappedMethod.md | 39 + src/pages/docs/reference/module/globals.md | 53 + .../module/interfaces/RuntimeDefinition.md | 35 + .../module/interfaces/RuntimeEnvironment.md | 85 + .../module/type-aliases/AsyncWrappedMethod.md | 25 + .../RuntimeMethodInvocationType.md | 15 + .../type-aliases/RuntimeModulesRecord.md | 20 + .../module/type-aliases/WrappedMethod.md | 25 + .../variables/runtimeMethodMetadataKey.md | 15 + .../runtimeMethodNamesMetadataKey.md | 15 + .../variables/runtimeMethodTypeMetadataKey.md | 15 + .../docs/reference/persistance/README.md | 45 + .../docs/reference/persistance/_meta.tsx | 3 + .../persistance/classes/BatchMapper.md | 71 + .../persistance/classes/BlockMapper.md | 165 + .../persistance/classes/BlockResultMapper.md | 125 + .../persistance/classes/FieldMapper.md | 71 + .../persistance/classes/PrismaBatchStore.md | 116 + .../persistance/classes/PrismaBlockStorage.md | 205 + .../classes/PrismaDatabaseConnection.md | 227 ++ .../classes/PrismaMessageStorage.md | 93 + .../classes/PrismaRedisDatabase.md | 298 ++ .../classes/PrismaSettlementStorage.md | 61 + .../persistance/classes/PrismaStateService.md | 143 + .../classes/PrismaTransactionStorage.md | 104 + .../classes/RedisConnectionModule.md | 269 ++ .../classes/RedisMerkleTreeStore.md | 115 + .../persistance/classes/SettlementMapper.md | 71 + .../classes/StateTransitionArrayMapper.md | 79 + .../classes/StateTransitionMapper.md | 71 + .../TransactionExecutionResultMapper.md | 87 + .../persistance/classes/TransactionMapper.md | 141 + .../interfaces/PrismaConnection.md | 27 + .../interfaces/PrismaDatabaseConfig.md | 21 + .../interfaces/PrismaRedisCombinedConfig.md | 29 + .../persistance/interfaces/RedisConnection.md | 41 + .../interfaces/RedisConnectionConfig.md | 45 + .../type-aliases/RedisTransaction.md | 15 + src/pages/docs/reference/processor/README.md | 42 + src/pages/docs/reference/processor/_meta.tsx | 3 + .../processor/classes/BlockFetching.md | 178 + .../reference/processor/classes/Database.md | 216 ++ .../processor/classes/DatabasePruneModule.md | 128 + .../processor/classes/HandlersExecutor.md | 236 ++ .../reference/processor/classes/Processor.md | 618 ++++ .../processor/classes/ProcessorModule.md | 128 + .../classes/ResolverFactoryGraphqlModule.md | 170 + .../classes/TimedProcessorTrigger.md | 192 + .../processor/functions/ValidateTakeArg.md | 19 + .../processor/functions/cleanResolvers.md | 25 + .../interfaces/BlockFetchingConfig.md | 21 + .../processor/interfaces/BlockResponse.md | 111 + .../interfaces/DatabasePruneModuleConfig.md | 21 + .../interfaces/HandlersExecutorConfig.md | 29 + .../processor/interfaces/HandlersRecord.md | 25 + .../interfaces/TimedProcessorTriggerConfig.md | 21 + .../processor/type-aliases/BlockHandler.md | 33 + .../type-aliases/ClientTransaction.md | 19 + .../type-aliases/ProcessorModulesRecord.md | 15 + src/pages/docs/reference/protocol/README.md | 55 + src/pages/docs/reference/protocol/_meta.tsx | 3 + .../protocol/classes/AccountState.md | 357 ++ .../protocol/classes/AccountStateHook.md | 190 + .../protocol/classes/BlockHashMerkleTree.md | 291 ++ .../classes/BlockHashMerkleTreeWitness.md | 575 +++ .../protocol/classes/BlockHashTreeEntry.md | 433 +++ .../protocol/classes/BlockHeightHook.md | 204 + .../reference/protocol/classes/BlockProver.md | 333 ++ .../classes/BlockProverExecutionData.md | 643 ++++ .../classes/BlockProverProgrammable.md | 318 ++ .../classes/BlockProverPublicInput.md | 741 ++++ .../classes/BlockProverPublicOutput.md | 827 +++++ .../protocol/classes/BridgeContract.md | 1587 ++++++++ .../protocol/classes/BridgeContractBase.md | 1477 ++++++++ .../classes/BridgeContractProtocolModule.md | 147 + .../protocol/classes/ContractModule.md | 159 + .../protocol/classes/CurrentBlock.md | 357 ++ .../classes/DefaultProvableHashList.md | 168 + .../reference/protocol/classes/Deposit.md | 493 +++ .../classes/DispatchContractProtocolModule.md | 175 + .../protocol/classes/DispatchSmartContract.md | 1401 +++++++ .../classes/DispatchSmartContractBase.md | 1245 +++++++ .../protocol/classes/DynamicBlockProof.md | 380 ++ .../protocol/classes/DynamicRuntimeProof.md | 380 ++ .../classes/LastStateRootBlockHook.md | 212 ++ .../protocol/classes/MethodPublicOutput.md | 680 ++++ .../protocol/classes/MethodVKConfigData.md | 433 +++ .../reference/protocol/classes/MinaActions.md | 45 + .../protocol/classes/MinaActionsHashList.md | 172 + .../reference/protocol/classes/MinaEvents.md | 45 + .../classes/MinaPrefixedProvableHashList.md | 184 + .../protocol/classes/NetworkState.md | 449 +++ .../classes/NetworkStateSettlementModule.md | 176 + .../docs/reference/protocol/classes/Option.md | 341 ++ .../reference/protocol/classes/OptionBase.md | 161 + .../classes/OutgoingMessageArgument.md | 501 +++ .../classes/OutgoingMessageArgumentBatch.md | 439 +++ .../protocol/classes/OutgoingMessageKey.md | 421 +++ .../docs/reference/protocol/classes/Path.md | 107 + .../classes/PrefixedProvableHashList.md | 172 + .../protocol/classes/PreviousBlock.md | 357 ++ .../reference/protocol/classes/Protocol.md | 716 ++++ .../protocol/classes/ProtocolModule.md | 150 + .../protocol/classes/ProvableBlockHook.md | 213 ++ .../protocol/classes/ProvableHashList.md | 143 + .../protocol/classes/ProvableOption.md | 433 +++ .../classes/ProvableReductionHashList.md | 210 ++ .../classes/ProvableSettlementHook.md | 180 + .../classes/ProvableStateTransition.md | 549 +++ .../classes/ProvableStateTransitionType.md | 409 ++ .../classes/ProvableTransactionHook.md | 187 + .../protocol/classes/PublicKeyOption.md | 479 +++ .../classes/RuntimeMethodExecutionContext.md | 398 ++ .../RuntimeMethodExecutionDataStruct.md | 591 +++ .../RuntimeProvableMethodExecutionResult.md | 159 + .../protocol/classes/RuntimeTransaction.md | 743 ++++ .../RuntimeVerificationKeyAttestation.md | 467 +++ .../RuntimeVerificationKeyRootService.md | 61 + .../classes/SettlementContractModule.md | 793 ++++ .../SettlementContractProtocolModule.md | 171 + .../classes/SettlementSmartContract.md | 1736 +++++++++ .../classes/SettlementSmartContractBase.md | 1570 ++++++++ .../protocol/classes/SignedTransaction.md | 607 +++ .../docs/reference/protocol/classes/State.md | 182 + .../reference/protocol/classes/StateMap.md | 229 ++ .../protocol/classes/StateServiceProvider.md | 67 + .../protocol/classes/StateTransition.md | 229 ++ .../classes/StateTransitionProvableBatch.md | 507 +++ .../protocol/classes/StateTransitionProver.md | 272 ++ .../StateTransitionProverProgrammable.md | 240 ++ .../StateTransitionProverPublicInput.md | 549 +++ .../StateTransitionProverPublicOutput.md | 549 +++ .../classes/StateTransitionReductionList.md | 236 ++ .../protocol/classes/StateTransitionType.md | 75 + .../classes/TokenBridgeAttestation.md | 445 +++ .../classes/TokenBridgeDeploymentAuth.md | 528 +++ .../protocol/classes/TokenBridgeEntry.md | 441 +++ .../protocol/classes/TokenBridgeTree.md | 344 ++ .../classes/TokenBridgeTreeAddition.md | 453 +++ .../classes/TokenBridgeTreeWitness.md | 575 +++ .../protocol/classes/TokenMapping.md | 429 +++ .../TransitionMethodExecutionResult.md | 31 + .../protocol/classes/UInt64Option.md | 479 +++ .../classes/UpdateMessagesHashAuth.md | 520 +++ .../docs/reference/protocol/classes/VKTree.md | 291 ++ .../protocol/classes/VKTreeWitness.md | 575 +++ .../reference/protocol/classes/WithPath.md | 43 + .../classes/WithStateServiceProvider.md | 43 + .../reference/protocol/classes/Withdrawal.md | 505 +++ .../reference/protocol/functions/assert.md | 38 + .../protocol/functions/emptyActions.md | 19 + .../protocol/functions/emptyEvents.md | 19 + .../protocol/functions/notInCircuit.md | 19 + .../protocol/functions/protocolState.md | 40 + .../functions/reduceStateTransitions.md | 25 + .../protocol/functions/singleFieldToString.md | 25 + .../protocol/functions/stringToField.md | 25 + src/pages/docs/reference/protocol/globals.md | 163 + .../protocol/interfaces/BlockProvable.md | 145 + .../protocol/interfaces/BlockProverState.md | 76 + .../protocol/interfaces/BlockProverType.md | 272 ++ .../interfaces/ContractAuthorization.md | 36 + .../interfaces/DispatchContractType.md | 87 + .../interfaces/MinimalVKTreeService.md | 25 + .../protocol/interfaces/ProtocolDefinition.md | 33 + .../interfaces/ProtocolEnvironment.md | 53 + .../protocol/interfaces/RuntimeLike.md | 35 + .../interfaces/RuntimeMethodExecutionData.md | 29 + .../interfaces/SettlementContractType.md | 137 + .../interfaces/SimpleAsyncStateService.md | 53 + .../interfaces/StateTransitionProvable.md | 103 + .../interfaces/StateTransitionProverType.md | 226 ++ .../TransitionMethodExecutionContext.md | 72 + .../protocol/type-aliases/BlockProof.md | 15 + .../protocol/type-aliases/BlockProverProof.md | 15 + .../type-aliases/BridgeContractConfig.md | 25 + .../type-aliases/BridgeContractType.md | 93 + .../type-aliases/DispatchContractConfig.md | 21 + .../protocol/type-aliases/InputBlockProof.md | 15 + .../MandatoryProtocolModulesRecord.md | 37 + .../MandatorySettlementModulesRecord.md | 29 + .../type-aliases/ProtocolModulesRecord.md | 15 + .../protocol/type-aliases/ReturnType.md | 19 + .../type-aliases/RuntimeMethodIdMapping.md | 15 + .../RuntimeMethodInvocationType.md | 15 + .../protocol/type-aliases/RuntimeProof.md | 15 + .../type-aliases/SettlementContractConfig.md | 21 + .../type-aliases/SettlementHookInputs.md | 41 + .../type-aliases/SettlementModulesRecord.md | 15 + .../type-aliases/SettlementStateRecord.md | 37 + .../SmartContractClassFromInterface.md | 19 + .../type-aliases/StateTransitionProof.md | 15 + .../protocol/type-aliases/Subclass.md | 25 + .../protocol/variables/ACTIONS_EMPTY_HASH.md | 15 + .../variables/BATCH_SIGNATURE_PREFIX.md | 15 + .../protocol/variables/MINA_EVENT_PREFIXES.md | 29 + .../variables/OUTGOING_MESSAGE_BATCH_SIZE.md | 15 + .../protocol/variables/ProtocolConstants.md | 21 + .../protocol/variables/treeFeeHeight.md | 15 + src/pages/docs/reference/sdk/README.md | 57 + src/pages/docs/reference/sdk/_meta.tsx | 3 + .../docs/reference/sdk/classes/AppChain.md | 754 ++++ .../reference/sdk/classes/AppChainModule.md | 137 + .../sdk/classes/AppChainTransaction.md | 137 + .../sdk/classes/AreProofsEnabledFactory.md | 62 + .../docs/reference/sdk/classes/AuroSigner.md | 154 + .../classes/BlockStorageNetworkStateModule.md | 191 + .../reference/sdk/classes/ClientAppChain.md | 799 ++++ .../reference/sdk/classes/GraphqlClient.md | 142 + .../GraphqlNetworkStateTransportModule.md | 188 + .../classes/GraphqlQueryTransportModule.md | 184 + .../sdk/classes/GraphqlTransactionSender.md | 178 + .../sdk/classes/InMemoryAreProofsEnabled.md | 67 + .../reference/sdk/classes/InMemorySigner.md | 156 + .../sdk/classes/InMemoryTransactionSender.md | 194 + .../sdk/classes/SharedDependencyFactory.md | 54 + .../sdk/classes/StateServiceQueryModule.md | 220 ++ .../reference/sdk/classes/TestingAppChain.md | 845 +++++ src/pages/docs/reference/sdk/globals.md | 53 + .../sdk/interfaces/AppChainConfig.md | 57 + .../sdk/interfaces/AppChainDefinition.md | 55 + .../interfaces/ExpandAppChainDefinition.md | 31 + .../sdk/interfaces/GraphqlClientConfig.md | 21 + .../sdk/interfaces/InMemorySignerConfig.md | 21 + .../sdk/interfaces/SharedDependencyRecord.md | 37 + .../docs/reference/sdk/interfaces/Signer.md | 31 + .../sdk/interfaces/TransactionSender.md | 120 + .../sdk/type-aliases/AppChainModulesRecord.md | 15 + .../sdk/type-aliases/ExpandAppChainModules.md | 39 + .../PartialVanillaRuntimeModulesRecord.md | 21 + .../TestingSequencerModulesRecord.md | 49 + .../sdk/variables/randomFeeRecipient.md | 15 + src/pages/docs/reference/sequencer/README.md | 40 + src/pages/docs/reference/sequencer/_meta.tsx | 3 + .../sequencer/classes/AbstractTaskQueue.md | 190 + .../classes/ArtifactRecordSerializer.md | 59 + .../sequencer/classes/BatchProducerModule.md | 204 + .../sequencer/classes/BlockProducerModule.md | 229 ++ .../sequencer/classes/BlockProofSerializer.md | 43 + .../sequencer/classes/BlockTaskFlowService.md | 144 + .../sequencer/classes/BlockTriggerBase.md | 296 ++ .../classes/CachedMerkleTreeStore.md | 289 ++ .../sequencer/classes/CachedStateService.md | 265 ++ .../sequencer/classes/CompressedSignature.md | 84 + .../sequencer/classes/DatabasePruneModule.md | 147 + .../classes/DecodedStateSerializer.md | 59 + .../sequencer/classes/DummyStateService.md | 75 + .../classes/DynamicProofTaskSerializer.md | 167 + .../docs/reference/sequencer/classes/Flow.md | 213 ++ .../sequencer/classes/FlowCreator.md | 57 + .../sequencer/classes/FlowTaskWorker.md | 121 + .../classes/InMemoryAsyncMerkleTreeStore.md | 103 + .../sequencer/classes/InMemoryBatchStorage.md | 104 + .../sequencer/classes/InMemoryBlockStorage.md | 201 + .../sequencer/classes/InMemoryDatabase.md | 217 ++ .../classes/InMemoryMessageStorage.md | 81 + .../classes/InMemorySettlementStorage.md | 57 + .../classes/InMemoryTransactionStorage.md | 104 + .../sequencer/classes/ListenerList.md | 93 + .../sequencer/classes/LocalTaskQueue.md | 290 ++ .../classes/LocalTaskWorkerModule.md | 682 ++++ .../sequencer/classes/ManualBlockTrigger.md | 339 ++ .../sequencer/classes/MinaBaseLayer.md | 220 ++ .../classes/MinaIncomingMessageAdapter.md | 82 + .../classes/MinaSimulationService.md | 83 + .../classes/MinaTransactionSender.md | 65 + .../classes/MinaTransactionSimulator.md | 203 + .../sequencer/classes/NetworkStateQuery.md | 73 + .../NewBlockProvingParametersSerializer.md | 83 + .../sequencer/classes/NewBlockTask.md | 206 ++ .../sequencer/classes/NoopBaseLayer.md | 171 + .../classes/PairProofTaskSerializer.md | 85 + .../sequencer/classes/PendingTransaction.md | 298 ++ .../classes/PreFilledStateService.md | 102 + .../sequencer/classes/PrivateMempool.md | 241 ++ .../sequencer/classes/ProofTaskSerializer.md | 167 + .../classes/ProvenSettlementPermissions.md | 91 + .../sequencer/classes/ReductionTaskFlow.md | 152 + .../RuntimeProofParametersSerializer.md | 71 + .../sequencer/classes/RuntimeProvingTask.md | 222 ++ ...imeVerificationKeyAttestationSerializer.md | 97 + .../reference/sequencer/classes/Sequencer.md | 687 ++++ .../sequencer/classes/SequencerModule.md | 155 + .../classes/SequencerStartupModule.md | 205 + .../sequencer/classes/SettlementModule.md | 422 +++ .../classes/SettlementProvingTask.md | 217 ++ .../classes/SignedSettlementPermissions.md | 91 + .../sequencer/classes/SomeProofSubclass.md | 301 ++ .../StateTransitionParametersSerializer.md | 71 + .../classes/StateTransitionReductionTask.md | 214 ++ .../sequencer/classes/StateTransitionTask.md | 214 ++ .../classes/SyncCachedMerkleTreeStore.md | 123 + .../sequencer/classes/TaskWorkerModule.md | 114 + .../sequencer/classes/TimedBlockTrigger.md | 345 ++ .../classes/TransactionExecutionService.md | 65 + .../classes/TransactionProvingTask.md | 214 ++ ...ansactionProvingTaskParameterSerializer.md | 83 + .../classes/TransactionTraceService.md | 130 + .../sequencer/classes/UnsignedTransaction.md | 220 ++ .../sequencer/classes/UntypedOption.md | 264 ++ .../classes/UntypedStateTransition.md | 231 ++ .../classes/VanillaTaskWorkerModules.md | 167 + .../classes/VerificationKeySerializer.md | 59 + .../sequencer/classes/WithdrawalEvent.md | 489 +++ .../sequencer/classes/WithdrawalKey.md | 421 +++ .../sequencer/classes/WithdrawalQueue.md | 214 ++ .../sequencer/classes/WorkerReadyModule.md | 46 + .../sequencer/functions/closeable.md | 29 + .../reference/sequencer/functions/distinct.md | 37 + .../functions/distinctByPredicate.md | 47 + .../sequencer/functions/distinctByString.md | 37 + .../functions/executeWithExecutionContext.md | 37 + .../sequencer/functions/sequencerModule.md | 32 + src/pages/docs/reference/sequencer/globals.md | 198 + .../interfaces/AsyncMerkleTreeStore.md | 73 + .../sequencer/interfaces/AsyncStateService.md | 95 + .../sequencer/interfaces/BaseLayer.md | 44 + .../BaseLayerContractPermissions.md | 61 + .../interfaces/BaseLayerDependencyRecord.md | 37 + .../reference/sequencer/interfaces/Batch.md | 41 + .../sequencer/interfaces/BatchStorage.md | 55 + .../sequencer/interfaces/BatchTransaction.md | 37 + .../reference/sequencer/interfaces/Block.md | 109 + .../sequencer/interfaces/BlockConfig.md | 29 + .../interfaces/BlockProverParameters.md | 45 + .../sequencer/interfaces/BlockQueue.md | 73 + .../sequencer/interfaces/BlockResult.md | 61 + .../sequencer/interfaces/BlockStorage.md | 55 + .../sequencer/interfaces/BlockTrace.md | 37 + .../sequencer/interfaces/BlockTrigger.md | 16 + .../interfaces/BlockWithMaybeResult.md | 29 + .../interfaces/BlockWithPreviousResult.md | 29 + .../sequencer/interfaces/BlockWithResult.md | 33 + .../sequencer/interfaces/Closeable.md | 30 + .../sequencer/interfaces/Database.md | 94 + .../interfaces/HistoricalBatchStorage.md | 31 + .../interfaces/HistoricalBlockStorage.md | 49 + .../interfaces/IncomingMessageAdapter.md | 50 + .../sequencer/interfaces/InstantiatedQueue.md | 105 + .../interfaces/LocalTaskQueueConfig.md | 21 + .../reference/sequencer/interfaces/Mempool.md | 75 + .../sequencer/interfaces/MerkleTreeNode.md | 49 + .../interfaces/MerkleTreeNodeQuery.md | 33 + .../sequencer/interfaces/MessageStorage.md | 59 + .../interfaces/MinaBaseLayerConfig.md | 21 + .../interfaces/NetworkStateTransportModule.md | 49 + .../interfaces/NewBlockProverParameters.md | 45 + .../sequencer/interfaces/OutgoingMessage.md | 33 + .../interfaces/OutgoingMessageQueue.md | 68 + .../interfaces/PairingDerivedInput.md | 48 + .../sequencer/interfaces/QueryGetterState.md | 53 + .../interfaces/QueryGetterStateMap.md | 73 + .../interfaces/QueryTransportModule.md | 49 + .../interfaces/RuntimeProofParameters.md | 37 + .../sequencer/interfaces/Sequenceable.md | 25 + .../sequencer/interfaces/SettleableBatch.md | 69 + .../sequencer/interfaces/Settlement.md | 29 + .../interfaces/SettlementModuleConfig.md | 29 + .../sequencer/interfaces/SettlementStorage.md | 31 + .../sequencer/interfaces/StateEntry.md | 29 + .../StateTransitionProofParameters.md | 45 + .../interfaces/StorageDependencyFactory.md | 48 + .../StorageDependencyMinimumDependencies.md | 109 + .../reference/sequencer/interfaces/Task.md | 81 + .../sequencer/interfaces/TaskPayload.md | 53 + .../sequencer/interfaces/TaskQueue.md | 62 + .../sequencer/interfaces/TaskSerializer.md | 53 + .../interfaces/TimedBlockTriggerConfig.md | 51 + .../interfaces/TimedBlockTriggerEvent.md | 61 + .../interfaces/TransactionExecutionResult.md | 69 + .../interfaces/TransactionStorage.md | 66 + .../sequencer/interfaces/TransactionTrace.md | 37 + .../sequencer/interfaces/TxEvents.md | 45 + .../type-aliases/AllTaskWorkerModules.md | 15 + .../sequencer/type-aliases/BlockEvents.md | 29 + .../type-aliases/ChainStateTaskArgs.md | 25 + .../type-aliases/DatabasePruneConfig.md | 21 + .../type-aliases/JSONEncodableState.md | 15 + .../type-aliases/MapStateMapToQuery.md | 19 + .../sequencer/type-aliases/MapStateToQuery.md | 19 + .../sequencer/type-aliases/MempoolEvents.md | 21 + .../sequencer/type-aliases/ModuleQuery.md | 19 + .../type-aliases/NewBlockProvingParameters.md | 15 + .../sequencer/type-aliases/PairTuple.md | 19 + .../sequencer/type-aliases/PickByType.md | 21 + .../type-aliases/PickStateMapProperties.md | 19 + .../type-aliases/PickStateProperties.md | 19 + .../reference/sequencer/type-aliases/Query.md | 21 + .../RuntimeContextReducedExecutionResult.md | 15 + .../type-aliases/SequencerModulesRecord.md | 15 + .../type-aliases/SerializedArtifactRecord.md | 15 + .../type-aliases/SettlementModuleEvents.md | 21 + .../type-aliases/SomeRuntimeMethod.md | 25 + .../sequencer/type-aliases/StateRecord.md | 15 + .../sequencer/type-aliases/TaskStateRecord.md | 15 + .../type-aliases/TaskWorkerModulesRecord.md | 15 + .../TaskWorkerModulesWithoutSettlement.md | 15 + .../TransactionProvingTaskParameters.md | 15 + .../type-aliases/TransactionTaskArgs.md | 25 + .../type-aliases/TransactionTaskResult.md | 21 + .../sequencer/type-aliases/TypedClass.md | 29 + .../type-aliases/UnsignedTransactionBody.md | 44 + .../type-aliases/VerificationKeyJSON.md | 25 + .../reference/sequencer/variables/Block.md | 45 + .../sequencer/variables/BlockWithResult.md | 109 + .../sequencer/variables/JSONTaskSerializer.md | 27 + .../variables/QueryBuilderFactory.md | 77 + src/pages/docs/reference/stack/README.md | 15 + src/pages/docs/reference/stack/_meta.tsx | 3 + .../reference/stack/classes/TestBalances.md | 491 +++ .../reference/stack/functions/startServer.md | 19 + src/pages/docs/reference/stack/globals.md | 19 + src/pages/docs/runtime/_meta.json | 7 - src/pages/docs/runtime/_meta.tsx | 7 + theme.config.tsx | 63 +- tsconfig.json | 19 +- 661 files changed, 97672 insertions(+), 1396 deletions(-) create mode 100644 .npmrc create mode 100644 generate-reference-meta.mjs delete mode 100644 next.config.js create mode 100644 next.config.mjs delete mode 100644 src/pages/_app.mdx create mode 100644 src/pages/_app.tsx delete mode 100644 src/pages/_meta.json create mode 100644 src/pages/_meta.tsx delete mode 100644 src/pages/docs/_meta.json create mode 100644 src/pages/docs/_meta.tsx delete mode 100644 src/pages/docs/advanced/_meta.json create mode 100644 src/pages/docs/advanced/_meta.tsx delete mode 100644 src/pages/docs/architecture/_meta.json create mode 100644 src/pages/docs/architecture/_meta.tsx delete mode 100644 src/pages/docs/common/_meta.json create mode 100644 src/pages/docs/common/_meta.tsx delete mode 100644 src/pages/docs/library/_meta.json create mode 100644 src/pages/docs/library/_meta.tsx rename src/pages/docs/quickstart/{_meta.json => _meta.tsx} (60%) create mode 100644 src/pages/docs/reference/_meta.tsx create mode 100644 src/pages/docs/reference/api/README.md create mode 100644 src/pages/docs/reference/api/_meta.tsx create mode 100644 src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md create mode 100644 src/pages/docs/reference/api/classes/BatchStorageResolver.md create mode 100644 src/pages/docs/reference/api/classes/BlockModel.md create mode 100644 src/pages/docs/reference/api/classes/BlockResolver.md create mode 100644 src/pages/docs/reference/api/classes/ComputedBlockModel.md create mode 100644 src/pages/docs/reference/api/classes/GraphqlModule.md create mode 100644 src/pages/docs/reference/api/classes/GraphqlSequencerModule.md create mode 100644 src/pages/docs/reference/api/classes/GraphqlServer.md create mode 100644 src/pages/docs/reference/api/classes/MempoolResolver.md create mode 100644 src/pages/docs/reference/api/classes/MerkleWitnessDTO.md create mode 100644 src/pages/docs/reference/api/classes/MerkleWitnessResolver.md create mode 100644 src/pages/docs/reference/api/classes/NodeInformationObject.md create mode 100644 src/pages/docs/reference/api/classes/NodeStatusObject.md create mode 100644 src/pages/docs/reference/api/classes/NodeStatusResolver.md create mode 100644 src/pages/docs/reference/api/classes/NodeStatusService.md create mode 100644 src/pages/docs/reference/api/classes/ProcessInformationObject.md create mode 100644 src/pages/docs/reference/api/classes/QueryGraphqlModule.md create mode 100644 src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md create mode 100644 src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md create mode 100644 src/pages/docs/reference/api/classes/Signature.md create mode 100644 src/pages/docs/reference/api/classes/TransactionObject.md create mode 100644 src/pages/docs/reference/api/classes/VanillaGraphqlModules.md create mode 100644 src/pages/docs/reference/api/functions/graphqlModule.md create mode 100644 src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md create mode 100644 src/pages/docs/reference/api/interfaces/NodeInformation.md create mode 100644 src/pages/docs/reference/api/interfaces/ProcessInformation.md create mode 100644 src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md create mode 100644 src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md create mode 100644 src/pages/docs/reference/common/README.md create mode 100644 src/pages/docs/reference/common/_meta.tsx create mode 100644 src/pages/docs/reference/common/classes/AtomicCompileHelper.md create mode 100644 src/pages/docs/reference/common/classes/ChildVerificationKeyService.md create mode 100644 src/pages/docs/reference/common/classes/CompileRegistry.md create mode 100644 src/pages/docs/reference/common/classes/ConfigurableModule.md create mode 100644 src/pages/docs/reference/common/classes/EventEmitter.md create mode 100644 src/pages/docs/reference/common/classes/EventEmitterProxy.md create mode 100644 src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md create mode 100644 src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md create mode 100644 src/pages/docs/reference/common/classes/ModuleContainer.md create mode 100644 src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md create mode 100644 src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md create mode 100644 src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md create mode 100644 src/pages/docs/reference/common/classes/RollupMerkleTree.md create mode 100644 src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md create mode 100644 src/pages/docs/reference/common/classes/ZkProgrammable.md create mode 100644 src/pages/docs/reference/common/functions/assertValidTextLogLevel.md create mode 100644 src/pages/docs/reference/common/functions/compileToMockable.md create mode 100644 src/pages/docs/reference/common/functions/createMerkleTree.md create mode 100644 src/pages/docs/reference/common/functions/dummyValue.md create mode 100644 src/pages/docs/reference/common/functions/expectDefined.md create mode 100644 src/pages/docs/reference/common/functions/filterNonNull.md create mode 100644 src/pages/docs/reference/common/functions/filterNonUndefined.md create mode 100644 src/pages/docs/reference/common/functions/getInjectAliases.md create mode 100644 src/pages/docs/reference/common/functions/hashWithPrefix.md create mode 100644 src/pages/docs/reference/common/functions/implement.md create mode 100644 src/pages/docs/reference/common/functions/injectAlias.md create mode 100644 src/pages/docs/reference/common/functions/injectOptional.md create mode 100644 src/pages/docs/reference/common/functions/isSubtypeOfName.md create mode 100644 src/pages/docs/reference/common/functions/mapSequential.md create mode 100644 src/pages/docs/reference/common/functions/noop.md create mode 100644 src/pages/docs/reference/common/functions/prefixToField.md create mode 100644 src/pages/docs/reference/common/functions/provableMethod.md create mode 100644 src/pages/docs/reference/common/functions/range.md create mode 100644 src/pages/docs/reference/common/functions/reduceSequential.md create mode 100644 src/pages/docs/reference/common/functions/requireTrue.md create mode 100644 src/pages/docs/reference/common/functions/safeParseJson.md create mode 100644 src/pages/docs/reference/common/functions/sleep.md create mode 100644 src/pages/docs/reference/common/functions/splitArray.md create mode 100644 src/pages/docs/reference/common/functions/toProver.md create mode 100644 src/pages/docs/reference/common/functions/verifyToMockable.md create mode 100644 src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md create mode 100644 src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md create mode 100644 src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md create mode 100644 src/pages/docs/reference/common/interfaces/AreProofsEnabled.md create mode 100644 src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md create mode 100644 src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md create mode 100644 src/pages/docs/reference/common/interfaces/ChildContainerProvider.md create mode 100644 src/pages/docs/reference/common/interfaces/CompilableModule.md create mode 100644 src/pages/docs/reference/common/interfaces/Compile.md create mode 100644 src/pages/docs/reference/common/interfaces/CompileArtifact.md create mode 100644 src/pages/docs/reference/common/interfaces/Configurable.md create mode 100644 src/pages/docs/reference/common/interfaces/DependencyFactory.md create mode 100644 src/pages/docs/reference/common/interfaces/EventEmittingComponent.md create mode 100644 src/pages/docs/reference/common/interfaces/EventEmittingContainer.md create mode 100644 src/pages/docs/reference/common/interfaces/MerkleTreeStore.md create mode 100644 src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md create mode 100644 src/pages/docs/reference/common/interfaces/ModulesRecord.md create mode 100644 src/pages/docs/reference/common/interfaces/PlainZkProgram.md create mode 100644 src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md create mode 100644 src/pages/docs/reference/common/interfaces/ToFieldable.md create mode 100644 src/pages/docs/reference/common/interfaces/ToFieldableStatic.md create mode 100644 src/pages/docs/reference/common/interfaces/ToJSONableStatic.md create mode 100644 src/pages/docs/reference/common/interfaces/Verify.md create mode 100644 src/pages/docs/reference/common/interfaces/WithZkProgrammable.md create mode 100644 src/pages/docs/reference/common/type-aliases/ArgumentTypes.md create mode 100644 src/pages/docs/reference/common/type-aliases/ArrayElement.md create mode 100644 src/pages/docs/reference/common/type-aliases/ArtifactRecord.md create mode 100644 src/pages/docs/reference/common/type-aliases/BaseModuleType.md create mode 100644 src/pages/docs/reference/common/type-aliases/CapitalizeAny.md create mode 100644 src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md create mode 100644 src/pages/docs/reference/common/type-aliases/CompileTarget.md create mode 100644 src/pages/docs/reference/common/type-aliases/ContainerEvents.md create mode 100644 src/pages/docs/reference/common/type-aliases/DecoratedMethod.md create mode 100644 src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md create mode 100644 src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md create mode 100644 src/pages/docs/reference/common/type-aliases/DependencyRecord.md create mode 100644 src/pages/docs/reference/common/type-aliases/EventListenable.md create mode 100644 src/pages/docs/reference/common/type-aliases/EventsRecord.md create mode 100644 src/pages/docs/reference/common/type-aliases/FilterNeverValues.md create mode 100644 src/pages/docs/reference/common/type-aliases/FlattenObject.md create mode 100644 src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md create mode 100644 src/pages/docs/reference/common/type-aliases/InferDependencies.md create mode 100644 src/pages/docs/reference/common/type-aliases/InferProofBase.md create mode 100644 src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md create mode 100644 src/pages/docs/reference/common/type-aliases/MergeObjects.md create mode 100644 src/pages/docs/reference/common/type-aliases/ModuleEvents.md create mode 100644 src/pages/docs/reference/common/type-aliases/ModulesConfig.md create mode 100644 src/pages/docs/reference/common/type-aliases/NoConfig.md create mode 100644 src/pages/docs/reference/common/type-aliases/NonMethods.md create mode 100644 src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md create mode 100644 src/pages/docs/reference/common/type-aliases/OmitKeys.md create mode 100644 src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md create mode 100644 src/pages/docs/reference/common/type-aliases/Preset.md create mode 100644 src/pages/docs/reference/common/type-aliases/Presets.md create mode 100644 src/pages/docs/reference/common/type-aliases/ProofTypes.md create mode 100644 src/pages/docs/reference/common/type-aliases/RecursivePartial.md create mode 100644 src/pages/docs/reference/common/type-aliases/ResolvableModules.md create mode 100644 src/pages/docs/reference/common/type-aliases/StringKeyOf.md create mode 100644 src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md create mode 100644 src/pages/docs/reference/common/type-aliases/TypedClass.md create mode 100644 src/pages/docs/reference/common/type-aliases/UnTypedClass.md create mode 100644 src/pages/docs/reference/common/type-aliases/UnionToIntersection.md create mode 100644 src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md create mode 100644 src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md create mode 100644 src/pages/docs/reference/common/variables/MAX_FIELD.md create mode 100644 src/pages/docs/reference/common/variables/MOCK_PROOF.md create mode 100644 src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md create mode 100644 src/pages/docs/reference/common/variables/ModuleContainerErrors.md create mode 100644 src/pages/docs/reference/common/variables/injectAliasMetadataKey.md create mode 100644 src/pages/docs/reference/common/variables/log.md create mode 100644 src/pages/docs/reference/deployment/README.md create mode 100644 src/pages/docs/reference/deployment/_meta.tsx create mode 100644 src/pages/docs/reference/deployment/classes/BullQueue.md create mode 100644 src/pages/docs/reference/deployment/classes/Environment.md create mode 100644 src/pages/docs/reference/deployment/globals.md create mode 100644 src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md create mode 100644 src/pages/docs/reference/deployment/interfaces/Startable.md create mode 100644 src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md create mode 100644 src/pages/docs/reference/indexer/README.md create mode 100644 src/pages/docs/reference/indexer/_meta.tsx create mode 100644 src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md create mode 100644 src/pages/docs/reference/indexer/classes/IndexBlockTask.md create mode 100644 src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md create mode 100644 src/pages/docs/reference/indexer/classes/Indexer.md create mode 100644 src/pages/docs/reference/indexer/classes/IndexerModule.md create mode 100644 src/pages/docs/reference/indexer/classes/IndexerNotifier.md create mode 100644 src/pages/docs/reference/indexer/functions/ValidateTakeArg.md create mode 100644 src/pages/docs/reference/indexer/functions/cleanResolvers.md create mode 100644 src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md create mode 100644 src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md create mode 100644 src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md create mode 100644 src/pages/docs/reference/library/README.md create mode 100644 src/pages/docs/reference/library/_meta.tsx create mode 100644 src/pages/docs/reference/library/classes/Balance.md create mode 100644 src/pages/docs/reference/library/classes/Balances.md create mode 100644 src/pages/docs/reference/library/classes/BalancesKey.md create mode 100644 src/pages/docs/reference/library/classes/FeeTree.md create mode 100644 src/pages/docs/reference/library/classes/InMemorySequencerModules.md create mode 100644 src/pages/docs/reference/library/classes/MethodFeeConfigData.md create mode 100644 src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md create mode 100644 src/pages/docs/reference/library/classes/SimpleSequencerModules.md create mode 100644 src/pages/docs/reference/library/classes/TokenId.md create mode 100644 src/pages/docs/reference/library/classes/TransactionFeeHook.md create mode 100644 src/pages/docs/reference/library/classes/UInt.md create mode 100644 src/pages/docs/reference/library/classes/UInt112.md create mode 100644 src/pages/docs/reference/library/classes/UInt224.md create mode 100644 src/pages/docs/reference/library/classes/UInt32.md create mode 100644 src/pages/docs/reference/library/classes/UInt64.md create mode 100644 src/pages/docs/reference/library/classes/VanillaProtocolModules.md create mode 100644 src/pages/docs/reference/library/classes/VanillaRuntimeModules.md create mode 100644 src/pages/docs/reference/library/classes/WithdrawalEvent.md create mode 100644 src/pages/docs/reference/library/classes/WithdrawalKey.md create mode 100644 src/pages/docs/reference/library/classes/Withdrawals.md create mode 100644 src/pages/docs/reference/library/interfaces/BalancesEvents.md create mode 100644 src/pages/docs/reference/library/interfaces/FeeIndexes.md create mode 100644 src/pages/docs/reference/library/interfaces/FeeTreeValues.md create mode 100644 src/pages/docs/reference/library/interfaces/MethodFeeConfig.md create mode 100644 src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md create mode 100644 src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md create mode 100644 src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md create mode 100644 src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md create mode 100644 src/pages/docs/reference/library/type-aliases/MinimalBalances.md create mode 100644 src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md create mode 100644 src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md create mode 100644 src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md create mode 100644 src/pages/docs/reference/library/type-aliases/UIntConstructor.md create mode 100644 src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md create mode 100644 src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md create mode 100644 src/pages/docs/reference/library/variables/errors.md create mode 100644 src/pages/docs/reference/library/variables/treeFeeHeight.md create mode 100644 src/pages/docs/reference/module/README.md create mode 100644 src/pages/docs/reference/module/_meta.tsx create mode 100644 src/pages/docs/reference/module/classes/InMemoryStateService.md create mode 100644 src/pages/docs/reference/module/classes/MethodIdFactory.md create mode 100644 src/pages/docs/reference/module/classes/MethodIdResolver.md create mode 100644 src/pages/docs/reference/module/classes/MethodParameterEncoder.md create mode 100644 src/pages/docs/reference/module/classes/Runtime.md create mode 100644 src/pages/docs/reference/module/classes/RuntimeEvents.md create mode 100644 src/pages/docs/reference/module/classes/RuntimeModule.md create mode 100644 src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md create mode 100644 src/pages/docs/reference/module/functions/combineMethodName.md create mode 100644 src/pages/docs/reference/module/functions/getAllPropertyNames.md create mode 100644 src/pages/docs/reference/module/functions/isRuntimeMethod.md create mode 100644 src/pages/docs/reference/module/functions/runtimeMessage.md create mode 100644 src/pages/docs/reference/module/functions/runtimeMethod.md create mode 100644 src/pages/docs/reference/module/functions/runtimeModule.md create mode 100644 src/pages/docs/reference/module/functions/state.md create mode 100644 src/pages/docs/reference/module/functions/toEventsHash.md create mode 100644 src/pages/docs/reference/module/functions/toStateTransitionsHash.md create mode 100644 src/pages/docs/reference/module/functions/toWrappedMethod.md create mode 100644 src/pages/docs/reference/module/globals.md create mode 100644 src/pages/docs/reference/module/interfaces/RuntimeDefinition.md create mode 100644 src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md create mode 100644 src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md create mode 100644 src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md create mode 100644 src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md create mode 100644 src/pages/docs/reference/module/type-aliases/WrappedMethod.md create mode 100644 src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md create mode 100644 src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md create mode 100644 src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md create mode 100644 src/pages/docs/reference/persistance/README.md create mode 100644 src/pages/docs/reference/persistance/_meta.tsx create mode 100644 src/pages/docs/reference/persistance/classes/BatchMapper.md create mode 100644 src/pages/docs/reference/persistance/classes/BlockMapper.md create mode 100644 src/pages/docs/reference/persistance/classes/BlockResultMapper.md create mode 100644 src/pages/docs/reference/persistance/classes/FieldMapper.md create mode 100644 src/pages/docs/reference/persistance/classes/PrismaBatchStore.md create mode 100644 src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md create mode 100644 src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md create mode 100644 src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md create mode 100644 src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md create mode 100644 src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md create mode 100644 src/pages/docs/reference/persistance/classes/PrismaStateService.md create mode 100644 src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md create mode 100644 src/pages/docs/reference/persistance/classes/RedisConnectionModule.md create mode 100644 src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md create mode 100644 src/pages/docs/reference/persistance/classes/SettlementMapper.md create mode 100644 src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md create mode 100644 src/pages/docs/reference/persistance/classes/StateTransitionMapper.md create mode 100644 src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md create mode 100644 src/pages/docs/reference/persistance/classes/TransactionMapper.md create mode 100644 src/pages/docs/reference/persistance/interfaces/PrismaConnection.md create mode 100644 src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md create mode 100644 src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md create mode 100644 src/pages/docs/reference/persistance/interfaces/RedisConnection.md create mode 100644 src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md create mode 100644 src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md create mode 100644 src/pages/docs/reference/processor/README.md create mode 100644 src/pages/docs/reference/processor/_meta.tsx create mode 100644 src/pages/docs/reference/processor/classes/BlockFetching.md create mode 100644 src/pages/docs/reference/processor/classes/Database.md create mode 100644 src/pages/docs/reference/processor/classes/DatabasePruneModule.md create mode 100644 src/pages/docs/reference/processor/classes/HandlersExecutor.md create mode 100644 src/pages/docs/reference/processor/classes/Processor.md create mode 100644 src/pages/docs/reference/processor/classes/ProcessorModule.md create mode 100644 src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md create mode 100644 src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md create mode 100644 src/pages/docs/reference/processor/functions/ValidateTakeArg.md create mode 100644 src/pages/docs/reference/processor/functions/cleanResolvers.md create mode 100644 src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md create mode 100644 src/pages/docs/reference/processor/interfaces/BlockResponse.md create mode 100644 src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md create mode 100644 src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md create mode 100644 src/pages/docs/reference/processor/interfaces/HandlersRecord.md create mode 100644 src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md create mode 100644 src/pages/docs/reference/processor/type-aliases/BlockHandler.md create mode 100644 src/pages/docs/reference/processor/type-aliases/ClientTransaction.md create mode 100644 src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md create mode 100644 src/pages/docs/reference/protocol/README.md create mode 100644 src/pages/docs/reference/protocol/_meta.tsx create mode 100644 src/pages/docs/reference/protocol/classes/AccountState.md create mode 100644 src/pages/docs/reference/protocol/classes/AccountStateHook.md create mode 100644 src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md create mode 100644 src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md create mode 100644 src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md create mode 100644 src/pages/docs/reference/protocol/classes/BlockHeightHook.md create mode 100644 src/pages/docs/reference/protocol/classes/BlockProver.md create mode 100644 src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md create mode 100644 src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md create mode 100644 src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md create mode 100644 src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md create mode 100644 src/pages/docs/reference/protocol/classes/BridgeContract.md create mode 100644 src/pages/docs/reference/protocol/classes/BridgeContractBase.md create mode 100644 src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md create mode 100644 src/pages/docs/reference/protocol/classes/ContractModule.md create mode 100644 src/pages/docs/reference/protocol/classes/CurrentBlock.md create mode 100644 src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md create mode 100644 src/pages/docs/reference/protocol/classes/Deposit.md create mode 100644 src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md create mode 100644 src/pages/docs/reference/protocol/classes/DispatchSmartContract.md create mode 100644 src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md create mode 100644 src/pages/docs/reference/protocol/classes/DynamicBlockProof.md create mode 100644 src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md create mode 100644 src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md create mode 100644 src/pages/docs/reference/protocol/classes/MethodPublicOutput.md create mode 100644 src/pages/docs/reference/protocol/classes/MethodVKConfigData.md create mode 100644 src/pages/docs/reference/protocol/classes/MinaActions.md create mode 100644 src/pages/docs/reference/protocol/classes/MinaActionsHashList.md create mode 100644 src/pages/docs/reference/protocol/classes/MinaEvents.md create mode 100644 src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md create mode 100644 src/pages/docs/reference/protocol/classes/NetworkState.md create mode 100644 src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md create mode 100644 src/pages/docs/reference/protocol/classes/Option.md create mode 100644 src/pages/docs/reference/protocol/classes/OptionBase.md create mode 100644 src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md create mode 100644 src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md create mode 100644 src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md create mode 100644 src/pages/docs/reference/protocol/classes/Path.md create mode 100644 src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md create mode 100644 src/pages/docs/reference/protocol/classes/PreviousBlock.md create mode 100644 src/pages/docs/reference/protocol/classes/Protocol.md create mode 100644 src/pages/docs/reference/protocol/classes/ProtocolModule.md create mode 100644 src/pages/docs/reference/protocol/classes/ProvableBlockHook.md create mode 100644 src/pages/docs/reference/protocol/classes/ProvableHashList.md create mode 100644 src/pages/docs/reference/protocol/classes/ProvableOption.md create mode 100644 src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md create mode 100644 src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md create mode 100644 src/pages/docs/reference/protocol/classes/ProvableStateTransition.md create mode 100644 src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md create mode 100644 src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md create mode 100644 src/pages/docs/reference/protocol/classes/PublicKeyOption.md create mode 100644 src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md create mode 100644 src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md create mode 100644 src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md create mode 100644 src/pages/docs/reference/protocol/classes/RuntimeTransaction.md create mode 100644 src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md create mode 100644 src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md create mode 100644 src/pages/docs/reference/protocol/classes/SettlementContractModule.md create mode 100644 src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md create mode 100644 src/pages/docs/reference/protocol/classes/SettlementSmartContract.md create mode 100644 src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md create mode 100644 src/pages/docs/reference/protocol/classes/SignedTransaction.md create mode 100644 src/pages/docs/reference/protocol/classes/State.md create mode 100644 src/pages/docs/reference/protocol/classes/StateMap.md create mode 100644 src/pages/docs/reference/protocol/classes/StateServiceProvider.md create mode 100644 src/pages/docs/reference/protocol/classes/StateTransition.md create mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md create mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionProver.md create mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md create mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md create mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md create mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md create mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionType.md create mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md create mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md create mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md create mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeTree.md create mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md create mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md create mode 100644 src/pages/docs/reference/protocol/classes/TokenMapping.md create mode 100644 src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md create mode 100644 src/pages/docs/reference/protocol/classes/UInt64Option.md create mode 100644 src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md create mode 100644 src/pages/docs/reference/protocol/classes/VKTree.md create mode 100644 src/pages/docs/reference/protocol/classes/VKTreeWitness.md create mode 100644 src/pages/docs/reference/protocol/classes/WithPath.md create mode 100644 src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md create mode 100644 src/pages/docs/reference/protocol/classes/Withdrawal.md create mode 100644 src/pages/docs/reference/protocol/functions/assert.md create mode 100644 src/pages/docs/reference/protocol/functions/emptyActions.md create mode 100644 src/pages/docs/reference/protocol/functions/emptyEvents.md create mode 100644 src/pages/docs/reference/protocol/functions/notInCircuit.md create mode 100644 src/pages/docs/reference/protocol/functions/protocolState.md create mode 100644 src/pages/docs/reference/protocol/functions/reduceStateTransitions.md create mode 100644 src/pages/docs/reference/protocol/functions/singleFieldToString.md create mode 100644 src/pages/docs/reference/protocol/functions/stringToField.md create mode 100644 src/pages/docs/reference/protocol/globals.md create mode 100644 src/pages/docs/reference/protocol/interfaces/BlockProvable.md create mode 100644 src/pages/docs/reference/protocol/interfaces/BlockProverState.md create mode 100644 src/pages/docs/reference/protocol/interfaces/BlockProverType.md create mode 100644 src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md create mode 100644 src/pages/docs/reference/protocol/interfaces/DispatchContractType.md create mode 100644 src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md create mode 100644 src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md create mode 100644 src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md create mode 100644 src/pages/docs/reference/protocol/interfaces/RuntimeLike.md create mode 100644 src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md create mode 100644 src/pages/docs/reference/protocol/interfaces/SettlementContractType.md create mode 100644 src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md create mode 100644 src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md create mode 100644 src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md create mode 100644 src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/BlockProof.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/ReturnType.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md create mode 100644 src/pages/docs/reference/protocol/type-aliases/Subclass.md create mode 100644 src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md create mode 100644 src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md create mode 100644 src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md create mode 100644 src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md create mode 100644 src/pages/docs/reference/protocol/variables/ProtocolConstants.md create mode 100644 src/pages/docs/reference/protocol/variables/treeFeeHeight.md create mode 100644 src/pages/docs/reference/sdk/README.md create mode 100644 src/pages/docs/reference/sdk/_meta.tsx create mode 100644 src/pages/docs/reference/sdk/classes/AppChain.md create mode 100644 src/pages/docs/reference/sdk/classes/AppChainModule.md create mode 100644 src/pages/docs/reference/sdk/classes/AppChainTransaction.md create mode 100644 src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md create mode 100644 src/pages/docs/reference/sdk/classes/AuroSigner.md create mode 100644 src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md create mode 100644 src/pages/docs/reference/sdk/classes/ClientAppChain.md create mode 100644 src/pages/docs/reference/sdk/classes/GraphqlClient.md create mode 100644 src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md create mode 100644 src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md create mode 100644 src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md create mode 100644 src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md create mode 100644 src/pages/docs/reference/sdk/classes/InMemorySigner.md create mode 100644 src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md create mode 100644 src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md create mode 100644 src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md create mode 100644 src/pages/docs/reference/sdk/classes/TestingAppChain.md create mode 100644 src/pages/docs/reference/sdk/globals.md create mode 100644 src/pages/docs/reference/sdk/interfaces/AppChainConfig.md create mode 100644 src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md create mode 100644 src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md create mode 100644 src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md create mode 100644 src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md create mode 100644 src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md create mode 100644 src/pages/docs/reference/sdk/interfaces/Signer.md create mode 100644 src/pages/docs/reference/sdk/interfaces/TransactionSender.md create mode 100644 src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md create mode 100644 src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md create mode 100644 src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md create mode 100644 src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md create mode 100644 src/pages/docs/reference/sdk/variables/randomFeeRecipient.md create mode 100644 src/pages/docs/reference/sequencer/README.md create mode 100644 src/pages/docs/reference/sequencer/_meta.tsx create mode 100644 src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md create mode 100644 src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/BatchProducerModule.md create mode 100644 src/pages/docs/reference/sequencer/classes/BlockProducerModule.md create mode 100644 src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md create mode 100644 src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md create mode 100644 src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md create mode 100644 src/pages/docs/reference/sequencer/classes/CachedStateService.md create mode 100644 src/pages/docs/reference/sequencer/classes/CompressedSignature.md create mode 100644 src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md create mode 100644 src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/DummyStateService.md create mode 100644 src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/Flow.md create mode 100644 src/pages/docs/reference/sequencer/classes/FlowCreator.md create mode 100644 src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md create mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md create mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md create mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md create mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md create mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md create mode 100644 src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md create mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md create mode 100644 src/pages/docs/reference/sequencer/classes/ListenerList.md create mode 100644 src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md create mode 100644 src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md create mode 100644 src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md create mode 100644 src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md create mode 100644 src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md create mode 100644 src/pages/docs/reference/sequencer/classes/MinaSimulationService.md create mode 100644 src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md create mode 100644 src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md create mode 100644 src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md create mode 100644 src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/NewBlockTask.md create mode 100644 src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md create mode 100644 src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/PendingTransaction.md create mode 100644 src/pages/docs/reference/sequencer/classes/PreFilledStateService.md create mode 100644 src/pages/docs/reference/sequencer/classes/PrivateMempool.md create mode 100644 src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md create mode 100644 src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md create mode 100644 src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md create mode 100644 src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/Sequencer.md create mode 100644 src/pages/docs/reference/sequencer/classes/SequencerModule.md create mode 100644 src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md create mode 100644 src/pages/docs/reference/sequencer/classes/SettlementModule.md create mode 100644 src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md create mode 100644 src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md create mode 100644 src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md create mode 100644 src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md create mode 100644 src/pages/docs/reference/sequencer/classes/StateTransitionTask.md create mode 100644 src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md create mode 100644 src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md create mode 100644 src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md create mode 100644 src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md create mode 100644 src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md create mode 100644 src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/TransactionTraceService.md create mode 100644 src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md create mode 100644 src/pages/docs/reference/sequencer/classes/UntypedOption.md create mode 100644 src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md create mode 100644 src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md create mode 100644 src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md create mode 100644 src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md create mode 100644 src/pages/docs/reference/sequencer/classes/WithdrawalKey.md create mode 100644 src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md create mode 100644 src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md create mode 100644 src/pages/docs/reference/sequencer/functions/closeable.md create mode 100644 src/pages/docs/reference/sequencer/functions/distinct.md create mode 100644 src/pages/docs/reference/sequencer/functions/distinctByPredicate.md create mode 100644 src/pages/docs/reference/sequencer/functions/distinctByString.md create mode 100644 src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md create mode 100644 src/pages/docs/reference/sequencer/functions/sequencerModule.md create mode 100644 src/pages/docs/reference/sequencer/globals.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BaseLayer.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/Batch.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BatchStorage.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/Block.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockConfig.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockQueue.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockResult.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockStorage.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockTrace.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/Closeable.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/Database.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/Mempool.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/MessageStorage.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/Sequenceable.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/Settlement.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/StateEntry.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/Task.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/TaskPayload.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/TaskQueue.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md create mode 100644 src/pages/docs/reference/sequencer/interfaces/TxEvents.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/PairTuple.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/PickByType.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/Query.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/StateRecord.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/TypedClass.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md create mode 100644 src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md create mode 100644 src/pages/docs/reference/sequencer/variables/Block.md create mode 100644 src/pages/docs/reference/sequencer/variables/BlockWithResult.md create mode 100644 src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md create mode 100644 src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md create mode 100644 src/pages/docs/reference/stack/README.md create mode 100644 src/pages/docs/reference/stack/_meta.tsx create mode 100644 src/pages/docs/reference/stack/classes/TestBalances.md create mode 100644 src/pages/docs/reference/stack/functions/startServer.md create mode 100644 src/pages/docs/reference/stack/globals.md delete mode 100644 src/pages/docs/runtime/_meta.json create mode 100644 src/pages/docs/runtime/_meta.tsx diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..b7425b9 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +enable-pre-post-scripts=true \ No newline at end of file diff --git a/README.md b/README.md index 7b33473..1a63a3a 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,10 @@ First, run `pnpm i` to install the dependencies. Then, run `pnpm dev` to start the development server and visit localhost:3000. +## Typedoc generation + +Typedoc / reference docs must be generated in the `framework` repo first, and then it can be copied over by running `pnpm run typedoc:replace`. This will also generate all the necessary `_meta.tsx` files for Nextra.js. + ## License This project is licensed under the MIT License. diff --git a/generate-reference-meta.mjs b/generate-reference-meta.mjs new file mode 100644 index 0000000..8afc207 --- /dev/null +++ b/generate-reference-meta.mjs @@ -0,0 +1,37 @@ +import fs from "fs"; +const references = fs.readdirSync("./src/pages/docs/reference"); + +const sidebarTitles = { + README: "Overview", + classes: "Classes", + functions: "Functions", + interfaces: "Interfaces", + "type-aliases": "Type Aliases", + globals: "Globals", + variables: "Variables", +}; + +function categoryToSidebarTitle(category) { + return sidebarTitles[category]; +} + +references.forEach((reference) => { + if (fs.lstatSync(`./src/pages/docs/reference/${reference}`).isDirectory()) { + const metaTsxPath = `./src/pages/docs/reference/${reference}/_meta.tsx`; + fs.rmSync(metaTsxPath, { force: true }); + + const categories = fs.readdirSync( + `./src/pages/docs/reference/${reference}`, + "utf8" + ); + + const metaTsx = `export default { + ${categories.map((category) => { + category = category.replace(".md", ""); + return `"${category}": "${categoryToSidebarTitle(category) ?? category}"`; + })} +};`; + + fs.writeFileSync(metaTsxPath, metaTsx); + } +}); diff --git a/next.config.js b/next.config.js deleted file mode 100644 index 2b9220a..0000000 --- a/next.config.js +++ /dev/null @@ -1,6 +0,0 @@ -const withNextra = require("nextra")({ - theme: "nextra-theme-docs", - themeConfig: "./theme.config.tsx", -}); - -module.exports = withNextra(); diff --git a/next.config.mjs b/next.config.mjs new file mode 100644 index 0000000..4ad81e8 --- /dev/null +++ b/next.config.mjs @@ -0,0 +1,14 @@ +import nextra from "nextra"; + +const withNextra = nextra({ + theme: "nextra-theme-docs", + themeConfig: "./theme.config.tsx", + latex: true, + search: { + codeblocks: false, + }, +}); + +export default withNextra({ + reactStrictMode: true, +}); diff --git a/package.json b/package.json index 4d32afa..0c4ea50 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,8 @@ "name": "@protokit/website", "version": "0.0.1", "scripts": { + "generate-reference-meta": "node generate-reference-meta.mjs", + "typedoc:replace": "rm -rf *./src/pages/docs/reference && cp -r ../framework/docs/@proto-kit/ ./src/pages/docs/reference && npm run generate-reference-meta", "dev": "next dev", "build": "next build", "start": "next start" @@ -51,8 +53,8 @@ "lucide-react": "^0.279.0", "next": "^13.4.0", "next-themes": "^0.2.1", - "nextra": "^2.0.0", - "nextra-theme-docs": "^2.0.0", + "nextra": "3", + "nextra-theme-docs": "3", "node-fetch": "2.6.1", "react": "^18.2.0", "react-day-picker": "^8.8.2", @@ -61,10 +63,12 @@ "react-youtube": "^10.1.0", "tailwind-merge": "^1.14.0", "tailwindcss-animate": "^1.0.7", + "typedoc": "^0.27.6", "zod": "^3.22.2" }, "devDependencies": { "@types/node": "18.11.10", + "@types/react": "19.0.8", "autoprefixer": "^10.4.16", "postcss": "^8.4.31", "tailwindcss": "^3.3.3", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 65710a9..9f097cd 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -29,6 +29,7 @@ specifiers: '@radix-ui/react-toggle': ^1.0.3 '@radix-ui/react-tooltip': ^1.0.7 '@types/node': 18.11.10 + '@types/react': 19.0.8 autoprefixer: ^10.4.16 class-variance-authority: ^0.7.0 clsx: ^2.0.0 @@ -37,8 +38,8 @@ specifiers: lucide-react: ^0.279.0 next: ^13.4.0 next-themes: ^0.2.1 - nextra: ^2.0.0 - nextra-theme-docs: ^2.0.0 + nextra: '3' + nextra-theme-docs: '3' node-fetch: 2.6.1 postcss: ^8.4.31 react: ^18.2.0 @@ -49,46 +50,47 @@ specifiers: tailwind-merge: ^1.14.0 tailwindcss: ^3.3.3 tailwindcss-animate: ^1.0.7 + typedoc: ^0.27.6 typescript: ^5.2.2 zod: ^3.22.2 dependencies: '@hookform/resolvers': 3.10.0_react-hook-form@7.54.2 - '@radix-ui/react-accordion': 1.2.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-alert-dialog': 1.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-aspect-ratio': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-avatar': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-checkbox': 1.1.3_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-collapsible': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-context-menu': 2.2.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-dialog': 1.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-dropdown-menu': 2.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-hover-card': 1.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-label': 2.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-menubar': 1.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-navigation-menu': 1.2.4_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-popover': 1.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-progress': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-radio-group': 1.2.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-scroll-area': 1.2.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-select': 2.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-separator': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-slider': 1.2.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-slot': 1.1.1_react@18.3.1 - '@radix-ui/react-switch': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-tabs': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-toast': 1.2.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-toggle': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-tooltip': 1.1.7_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-accordion': 1.2.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-alert-dialog': 1.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-aspect-ratio': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-avatar': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-checkbox': 1.1.3_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-collapsible': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-context-menu': 2.2.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-dialog': 1.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-dropdown-menu': 2.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-hover-card': 1.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-label': 2.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-menubar': 1.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-navigation-menu': 1.2.4_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-popover': 1.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-progress': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-radio-group': 1.2.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-scroll-area': 1.2.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-select': 2.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-separator': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-slider': 1.2.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-slot': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-switch': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-tabs': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-toast': 1.2.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-toggle': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-tooltip': 1.1.7_6db44ecc8c7d9cf758af9edbd1445878 class-variance-authority: 0.7.1 clsx: 2.1.1 - cmdk: 0.2.1_react-dom@18.3.1+react@18.3.1 + cmdk: 0.2.1_6db44ecc8c7d9cf758af9edbd1445878 date-fns: 2.30.0 lucide-react: 0.279.0_react@18.3.1 next: 13.5.8_react-dom@18.3.1+react@18.3.1 next-themes: 0.2.1_0a643aba9b2308b459046f7d266814af - nextra: 2.13.4_0a643aba9b2308b459046f7d266814af - nextra-theme-docs: 2.13.4_914a2928ba2b1fb9d31bb89368d1a0d6 + nextra: 3.3.1_1cdd235be866fa3cfe463003c7d3272a + nextra-theme-docs: 3.3.1_25198e6f688a28eb74a49cc2bbfeaa41 node-fetch: 2.6.1 react: 18.3.1 react-day-picker: 8.10.1_date-fns@2.30.0+react@18.3.1 @@ -97,10 +99,12 @@ dependencies: react-youtube: 10.1.0_react@18.3.1 tailwind-merge: 1.14.0 tailwindcss-animate: 1.0.7_tailwindcss@3.4.17 + typedoc: 0.27.6_typescript@5.7.3 zod: 3.24.1 devDependencies: '@types/node': 18.11.10 + '@types/react': 19.0.8 autoprefixer: 10.4.20_postcss@8.5.1 postcss: 8.5.1 tailwindcss: 3.4.17 @@ -113,6 +117,17 @@ packages: engines: {node: '>=10'} dev: true + /@antfu/install-pkg/0.4.1: + resolution: {integrity: sha512-T7yB5QNG29afhWVkVq7XeIMBa5U/vs9mX69YqayXypPRmYzUmzwnYltplHmPtZ4HPCn+sQKeXW8I47wCbuBOjw==} + dependencies: + package-manager-detector: 0.2.8 + tinyexec: 0.3.2 + dev: false + + /@antfu/utils/0.7.10: + resolution: {integrity: sha512-+562v9k4aI80m1+VuMHehNJWLOFjBnXn3tdOitzD0il5b7smkSBal4+a3oKiQTbrwMmN/TBUMDvbdoWDehgOww==} + dev: false + /@babel/runtime/7.26.7: resolution: {integrity: sha512-AOPI3D+a8dXnja+iwsUqGRjr1BbZIe771sXdapOtYI531gSqpi92vXivKcq2asu/DFpdl1ceFAKZyRzK2PCVcQ==} engines: {node: '>=6.9.0'} @@ -120,8 +135,35 @@ packages: regenerator-runtime: 0.14.1 dev: false - /@braintree/sanitize-url/6.0.4: - resolution: {integrity: sha512-s3jaWicZd0pkP0jf5ysyHUI/RE7MHos6qlToFcGWXVp+ykHOy77OUMrfbgJ9it2C5bow7OIQwYYaHjk9XlBQ2A==} + /@braintree/sanitize-url/7.1.1: + resolution: {integrity: sha512-i1L7noDNxtFyL5DmZafWy1wRVhGehQmzZaz1HiN5e7iylJMSZR7ekOV7NsIqa5qBldlLrsKv4HbgFUVlQrz8Mw==} + dev: false + + /@chevrotain/cst-dts-gen/11.0.3: + resolution: {integrity: sha512-BvIKpRLeS/8UbfxXxgC33xOumsacaeCKAjAeLyOn7Pcp95HiRbrpl14S+9vaZLolnbssPIUuiUd8IvgkRyt6NQ==} + dependencies: + '@chevrotain/gast': 11.0.3 + '@chevrotain/types': 11.0.3 + lodash-es: 4.17.21 + dev: false + + /@chevrotain/gast/11.0.3: + resolution: {integrity: sha512-+qNfcoNk70PyS/uxmj3li5NiECO+2YKZZQMbmjTqRI3Qchu8Hig/Q9vgkHpI3alNjr7M+a2St5pw5w5F6NL5/Q==} + dependencies: + '@chevrotain/types': 11.0.3 + lodash-es: 4.17.21 + dev: false + + /@chevrotain/regexp-to-ast/11.0.3: + resolution: {integrity: sha512-1fMHaBZxLFvWI067AVbGJav1eRY7N8DDvYCTwGBiE/ytKBgP8azTdgyrKyWZ9Mfh09eHWb5PgTSO8wi7U824RA==} + dev: false + + /@chevrotain/types/11.0.3: + resolution: {integrity: sha512-gsiM3G8b58kZC2HaWR50gu6Y1440cHiJ+i3JUvcp/35JchYejb2+5MVeJK0iKThYpAa/P2PYFV4hoi44HD+aHQ==} + dev: false + + /@chevrotain/utils/11.0.3: + resolution: {integrity: sha512-YslZMgtJUyuMbZ+aKvfF3x1f5liK4mWNxghFRv7jqRR9C3R3fAOGTTKvxXDa2Y1s9zSbcpuO0cAxDYsc9SrXoQ==} dev: false /@floating-ui/core/1.6.9: @@ -148,19 +190,48 @@ packages: react-dom: 18.3.1_react@18.3.1 dev: false + /@floating-ui/react/0.26.28_react-dom@18.3.1+react@18.3.1: + resolution: {integrity: sha512-yORQuuAtVpiRjpMhdc0wJj06b9JFjrYF4qp96j++v2NBpbi6SEGF7donUJ3TMieerQ6qVkAv1tgr7L4r5roTqw==} + peerDependencies: + react: '>=16.8.0' + react-dom: '>=16.8.0' + dependencies: + '@floating-ui/react-dom': 2.1.2_react-dom@18.3.1+react@18.3.1 + '@floating-ui/utils': 0.2.9 + react: 18.3.1 + react-dom: 18.3.1_react@18.3.1 + tabbable: 6.2.0 + dev: false + /@floating-ui/utils/0.2.9: resolution: {integrity: sha512-MDWhGtE+eHw5JW7lq4qhc5yRLS11ERl1c7Z6Xd0a58DozHES6EnNNwUWbMiG4J9Cgj053Bhk8zvlhFYKVhULwg==} dev: false - /@headlessui/react/1.7.19_react-dom@18.3.1+react@18.3.1: - resolution: {integrity: sha512-Ll+8q3OlMJfJbAKM/+/Y2q6PPYbryqNTXDbryx7SXLIDamkF6iQFbriYHga0dY44PvDhvvBWCx1Xj4U5+G4hOw==} + /@formatjs/intl-localematcher/0.5.10: + resolution: {integrity: sha512-af3qATX+m4Rnd9+wHcjJ4w2ijq+rAVP3CCinJQvFv1kgSu1W6jypUmvleJxcewdxmutM8dmIRZFxO/IQBZmP2Q==} + dependencies: + tslib: 2.8.1 + dev: false + + /@gerrit0/mini-shiki/1.27.2: + resolution: {integrity: sha512-GeWyHz8ao2gBiUW4OJnQDxXQnFgZQwwQk05t/CVVgNBN7/rK8XZ7xY6YhLVv9tH3VppWWmr9DCl3MwemB/i+Og==} + dependencies: + '@shikijs/engine-oniguruma': 1.29.1 + '@shikijs/types': 1.29.1 + '@shikijs/vscode-textmate': 10.0.1 + dev: false + + /@headlessui/react/2.2.0_react-dom@18.3.1+react@18.3.1: + resolution: {integrity: sha512-RzCEg+LXsuI7mHiSomsu/gBJSjpupm6A1qIZ5sWjd7JhARNlMiSA4kKfJpCKwU9tE+zMRterhhrP74PvfJrpXQ==} engines: {node: '>=10'} peerDependencies: - react: ^16 || ^17 || ^18 - react-dom: ^16 || ^17 || ^18 + react: ^18 || ^19 || ^19.0.0-rc + react-dom: ^18 || ^19 || ^19.0.0-rc dependencies: + '@floating-ui/react': 0.26.28_react-dom@18.3.1+react@18.3.1 + '@react-aria/focus': 3.19.1_react-dom@18.3.1+react@18.3.1 + '@react-aria/interactions': 3.23.0_react-dom@18.3.1+react@18.3.1 '@tanstack/react-virtual': 3.11.3_react-dom@18.3.1+react@18.3.1 - client-only: 0.0.1 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -173,6 +244,25 @@ packages: react-hook-form: 7.54.2_react@18.3.1 dev: false + /@iconify/types/2.0.0: + resolution: {integrity: sha512-+wluvCrRhXrhyOmRDJ3q8mux9JkKy5SJ/v8ol2tu4FVjyYvtEzkc/3pK15ET6RKg4b4w4BmTk1+gsCUhf21Ykg==} + dev: false + + /@iconify/utils/2.2.1: + resolution: {integrity: sha512-0/7J7hk4PqXmxo5PDBDxmnecw5PxklZJfNjIVG9FM0mEfVrvfudS22rYWsqVk6gR3UJ/mSYS90X4R3znXnqfNA==} + dependencies: + '@antfu/install-pkg': 0.4.1 + '@antfu/utils': 0.7.10 + '@iconify/types': 2.0.0 + debug: 4.4.0 + globals: 15.14.0 + kolorist: 1.8.0 + local-pkg: 0.5.1 + mlly: 1.7.4 + transitivePeerDependencies: + - supports-color + dev: false + /@isaacs/cliui/8.0.2: resolution: {integrity: sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==} engines: {node: '>=12'} @@ -215,33 +305,42 @@ packages: '@jridgewell/sourcemap-codec': 1.5.0 dev: true - /@mdx-js/mdx/2.3.0: - resolution: {integrity: sha512-jLuwRlz8DQfQNiUCJR50Y09CGPq3fLtmtUQfVrj79E0JWu3dvsVcxVIcfhR5h0iXu+/z++zDrYeiJqifRynJkA==} + /@mdx-js/mdx/3.1.0: + resolution: {integrity: sha512-/QxEhPAvGwbQmy1Px8F899L5Uc2KZ6JtXwlCgJmjSTBedwOZkByYcBG4GceIGPXRDsmfxhHazuS+hlOShRLeDw==} dependencies: + '@types/estree': 1.0.6 '@types/estree-jsx': 1.0.5 + '@types/hast': 3.0.4 '@types/mdx': 2.0.13 - estree-util-build-jsx: 2.2.2 - estree-util-is-identifier-name: 2.1.0 - estree-util-to-js: 1.2.0 + collapse-white-space: 2.1.0 + devlop: 1.1.0 + estree-util-is-identifier-name: 3.0.0 + estree-util-scope: 1.0.0 estree-walker: 3.0.3 - hast-util-to-estree: 2.3.3 - markdown-extensions: 1.1.1 - periscopic: 3.1.0 - remark-mdx: 2.3.0 - remark-parse: 10.0.2 - remark-rehype: 10.1.0 - unified: 10.1.2 - unist-util-position-from-estree: 1.1.2 - unist-util-stringify-position: 3.0.3 - unist-util-visit: 4.1.2 - vfile: 5.3.7 + hast-util-to-jsx-runtime: 2.3.2 + markdown-extensions: 2.0.0 + recma-build-jsx: 1.0.0 + recma-jsx: 1.0.0 + recma-stringify: 1.0.0 + rehype-recma: 1.0.0 + remark-mdx: 3.1.0 + remark-parse: 11.0.0 + remark-rehype: 11.1.1 + source-map: 0.7.4 + unified: 11.0.5 + unist-util-position-from-estree: 2.0.0 + unist-util-stringify-position: 4.0.0 + unist-util-visit: 5.0.0 + vfile: 6.0.3 transitivePeerDependencies: + - acorn - supports-color dev: false - /@mdx-js/react/2.3.0_react@18.3.1: - resolution: {integrity: sha512-zQH//gdOmuu7nt2oJR29vFhDv88oGPmVw6BggmrHeMI+xgEkp1B2dX9/bMBSYtK0dyLX/aOmesKS09g222K1/g==} + /@mdx-js/react/3.1.0_@types+react@19.0.8+react@18.3.1: + resolution: {integrity: sha512-QjHtSaoameoalGnKDT3FoIl4+9RwyTmo9ZJGBdLOks/YOiWHoRDI3PUwEzOE7kEmGcV3AFcp9K6dYu9rEuKLAQ==} peerDependencies: + '@types/react': '>=16' react: '>=16' dependencies: '@types/mdx': 2.0.13 @@ -249,6 +348,12 @@ packages: react: 18.3.1 dev: false + /@mermaid-js/parser/0.3.0: + resolution: {integrity: sha512-HsvL6zgE5sUPGgkIDlmAWR1HTNHz2Iy11BAWPTa4Jjabkpguy4Ze2gzfLrg6pdRuBvFwgUYyxiaNqZwrEEXepA==} + dependencies: + langium: 3.0.0 + dev: false + /@napi-rs/simple-git-android-arm-eabi/0.1.19: resolution: {integrity: sha512-XryEH/hadZ4Duk/HS/HC/cA1j0RHmqUGey3MsCf65ZS0VrWMqChXM/xlTPWuY5jfCc/rPubHaqI7DZlbexnX/g==} engines: {node: '>= 10'} @@ -484,10 +589,6 @@ packages: dev: true optional: true - /@popperjs/core/2.11.8: - resolution: {integrity: sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A==} - dev: false - /@radix-ui/number/1.1.0: resolution: {integrity: sha512-V3gRzhVNU1ldS5XhAPTom1fOIo4ccrjjJgmE+LI2h/WaFpHmx0MQApT+KZHnx8abG6Avtfcz4WoEciMnpFT3HQ==} dev: false @@ -502,7 +603,7 @@ packages: resolution: {integrity: sha512-SJ31y+Q/zAyShtXJc8x83i9TYdbAfHZ++tUZnvjJJqFjzsdUnKsxPL6IEtBlxKkU7yzer//GQtZSV4GbldL3YA==} dev: false - /@radix-ui/react-accordion/1.2.2_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-accordion/1.2.2_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-b1oh54x4DMCdGsB4/7ahiSrViXxaBwRPotiZNnYXjLha9vfuURSAZErki6qjDoSIV0eXx5v57XnTGVtGwnfp2g==} peerDependencies: '@types/react': '*' @@ -516,19 +617,20 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-collapsible': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-collection': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-direction': 1.1.0_react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 + '@radix-ui/react-collapsible': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-collection': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-direction': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-alert-dialog/1.1.5_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-alert-dialog/1.1.5_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-1Y2sI17QzSZP58RjGtrklfSGIf3AF7U/HkD3aAcAnhOUJrm7+7GG1wRDFaUlSe0nW5B/t4mYd/+7RNbP2Wexug==} peerDependencies: '@types/react': '*' @@ -542,16 +644,17 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-dialog': 1.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-slot': 1.1.1_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-dialog': 1.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-slot': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-arrow/1.1.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-arrow/1.1.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-NaVpZfmv8SKeZbn4ijN2V3jlHA9ngBG16VnIIm22nUR0Yk8KUALyBxT3KYEUnNuch9sTE8UTsS3whzBgKOL30w==} peerDependencies: '@types/react': '*' @@ -564,12 +667,13 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-aspect-ratio/1.1.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-aspect-ratio/1.1.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-kNU4FIpcFMBLkOUcgeIteH06/8JLBcYY6Le1iKenDGCYNYFX3TQqCZjzkOsz37h7r94/99GTb7YhEr98ZBJibw==} peerDependencies: '@types/react': '*' @@ -582,12 +686,13 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-avatar/1.1.2_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-avatar/1.1.2_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-GaC7bXQZ5VgZvVvsJ5mu/AEbjYLnhhkoidOboC50Z6FFlLA03wG2ianUoH+zgDQ31/9gCF59bE4+2bBgTyMiig==} peerDependencies: '@types/react': '*' @@ -600,15 +705,16 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-checkbox/1.1.3_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-checkbox/1.1.3_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-HD7/ocp8f1B3e6OHygH0n7ZKjONkhciy1Nh0yuBgObqThc3oyx+vuMfFHKAknXRHHWVE9XvXStxJFyjUmB8PIw==} peerDependencies: '@types/react': '*' @@ -622,18 +728,19 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 - '@radix-ui/react-use-previous': 1.1.0_react@18.3.1 - '@radix-ui/react-use-size': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-previous': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-size': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-collapsible/1.1.2_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-collapsible/1.1.2_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-PliMB63vxz7vggcyq0IxNYk8vGDrLXVWw4+W4B8YnwI1s18x7YZYqlG9PLX7XxAJUi0g2DxP4XKJMFHh/iVh9A==} peerDependencies: '@types/react': '*' @@ -647,18 +754,19 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-collection/1.1.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-collection/1.1.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-LwT3pSho9Dljg+wY2KN2mrrh6y3qELfftINERIzBUO9e0N+t0oMTyn3k9iv+ZqgrwGkRnLpNJrsMv9BZlt2yuA==} peerDependencies: '@types/react': '*' @@ -671,10 +779,11 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-slot': 1.1.1_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-slot': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -688,7 +797,7 @@ packages: react: 18.3.1 dev: false - /@radix-ui/react-compose-refs/1.1.1_react@18.3.1: + /@radix-ui/react-compose-refs/1.1.1_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-Y9VzoRDSJtgFMUCoiZBDVo084VQ5hfpXxVE+NgkdNsjiDBByiImMZKKhxMwCbdHvhlENG6a833CbFkOQvTricw==} peerDependencies: '@types/react': '*' @@ -697,10 +806,11 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 dev: false - /@radix-ui/react-context-menu/2.2.5_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-context-menu/2.2.5_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-MY5PFCwo/ICaaQtpQBQ0g19AyjzI0mhz+a2GUWA2pJf4XFkvglAdcgDV2Iqm+lLbXn8hb+6rbLgcmRtc6ImPvg==} peerDependencies: '@types/react': '*' @@ -714,11 +824,12 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-menu': 2.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-menu': 2.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -732,7 +843,7 @@ packages: react: 18.3.1 dev: false - /@radix-ui/react-context/1.1.1_react@18.3.1: + /@radix-ui/react-context/1.1.1_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-UASk9zi+crv9WteK/NU4PLvOoL3OuE6BWVKNF6hPRBtYBDXQ2u5iu3O59zUlJiTVvkyuycnqrztsHVJwcK9K+Q==} peerDependencies: '@types/react': '*' @@ -741,10 +852,11 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 dev: false - /@radix-ui/react-dialog/1.0.0_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-dialog/1.0.0_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-Yn9YU+QlHYLWwV1XfKiqnGVpWYWk6MeBVM6x/bcoyPvxgjQGoeT35482viLPctTMWoMw0PoHgqfSox7Ig+957Q==} peerDependencies: react: ^16.8 || ^17.0 || ^18.0 @@ -766,12 +878,12 @@ packages: aria-hidden: 1.2.4 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 - react-remove-scroll: 2.5.4_react@18.3.1 + react-remove-scroll: 2.5.4_@types+react@19.0.8+react@18.3.1 transitivePeerDependencies: - '@types/react' dev: false - /@radix-ui/react-dialog/1.1.5_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-dialog/1.1.5_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-LaO3e5h/NOEL4OfXjxD43k9Dx+vn+8n+PCFt6uhX/BADFflllyv3WJG6rgvvSVBxpTch938Qq/LGc2MMxipXPw==} peerDependencies: '@types/react': '*' @@ -785,24 +897,25 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-dismissable-layer': 1.1.4_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-focus-guards': 1.1.1_react@18.3.1 - '@radix-ui/react-focus-scope': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-portal': 1.1.3_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-slot': 1.1.1_react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-dismissable-layer': 1.1.4_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-focus-guards': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-focus-scope': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-portal': 1.1.3_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-slot': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 aria-hidden: 1.2.4 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 - react-remove-scroll: 2.6.3_react@18.3.1 + react-remove-scroll: 2.6.3_@types+react@19.0.8+react@18.3.1 dev: false - /@radix-ui/react-direction/1.1.0_react@18.3.1: + /@radix-ui/react-direction/1.1.0_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-BUuBvgThEiAXh2DWu93XsT+a3aWrGqolGlqqw5VU1kG7p/ZH2cuDlM1sRLNnY3QcBS69UIz2mcKhMxDsdewhjg==} peerDependencies: '@types/react': '*' @@ -811,6 +924,7 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 dev: false @@ -830,7 +944,7 @@ packages: react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-dismissable-layer/1.1.4_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-dismissable-layer/1.1.4_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-XDUI0IVYVSwjMXxM6P4Dfti7AH+Y4oS/TB+sglZ/EXc7cqLwGAmp1NlMrcUjj7ks6R5WTZuWKv44FBbLpwU3sA==} peerDependencies: '@types/react': '*' @@ -844,15 +958,16 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 - '@radix-ui/react-use-escape-keydown': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-escape-keydown': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-dropdown-menu/2.1.5_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-dropdown-menu/2.1.5_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-50ZmEFL1kOuLalPKHrLWvPFMons2fGx9TqQCWlPwDVpbAnaUJ1g4XNcKqFNMQymYU0kKWR4MDDi+9vUQBGFgcQ==} peerDependencies: '@types/react': '*' @@ -866,12 +981,13 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-menu': 2.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-menu': 2.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -885,7 +1001,7 @@ packages: react: 18.3.1 dev: false - /@radix-ui/react-focus-guards/1.1.1_react@18.3.1: + /@radix-ui/react-focus-guards/1.1.1_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-pSIwfrT1a6sIoDASCSpFwOasEwKTZWDw/iBdtnqKO7v6FeOzYJ7U53cPzYFVR3geGGXgVHaH+CdngrrAzqUGxg==} peerDependencies: '@types/react': '*' @@ -894,6 +1010,7 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 dev: false @@ -911,7 +1028,7 @@ packages: react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-focus-scope/1.1.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-focus-scope/1.1.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-01omzJAYRxXdG2/he/+xy+c8a8gCydoQ1yOxnWNcRhrrBW5W+RQJ22EK1SaO8tb3WoUsuEw7mJjBozPzihDFjA==} peerDependencies: '@types/react': '*' @@ -924,14 +1041,15 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-hover-card/1.1.5_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-hover-card/1.1.5_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-0jPlX3ZrUIhtMAY0m1SBn1koI4Yqsizq2UwdUiQF1GseSZLZBPa6b8tNS+m32K94Yb4wxtWFSQs85wujQvwahg==} peerDependencies: '@types/react': '*' @@ -945,14 +1063,15 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-dismissable-layer': 1.1.4_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-popper': 1.2.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-portal': 1.1.3_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-dismissable-layer': 1.1.4_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-popper': 1.2.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-portal': 1.1.3_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -967,7 +1086,7 @@ packages: react: 18.3.1 dev: false - /@radix-ui/react-id/1.1.0_react@18.3.1: + /@radix-ui/react-id/1.1.0_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-EJUrI8yYh7WOjNOqpoJaf1jlFIH2LvtgAl+YcFqNCa+4hj64ZXmPkAKOFs/ukjz3byN6bdb/AVUqHkI8/uWWMA==} peerDependencies: '@types/react': '*' @@ -976,11 +1095,12 @@ packages: '@types/react': optional: true dependencies: - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 dev: false - /@radix-ui/react-label/2.1.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-label/2.1.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-UUw5E4e/2+4kFMH7+YxORXGWggtY6sM8WIwh5RZchhLuUg2H1hc98Py+pr8HMz6rdaYrK2t296ZEjYLOCO5uUw==} peerDependencies: '@types/react': '*' @@ -993,12 +1113,13 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-menu/2.1.5_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-menu/2.1.5_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-uH+3w5heoMJtqVCgYOtYVMECk1TOrkUn0OG0p5MqXC0W2ppcuVeESbou8PTHoqAjbdTEK19AGXBWcEtR5WpEQg==} peerDependencies: '@types/react': '*' @@ -1012,28 +1133,29 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-collection': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-direction': 1.1.0_react@18.3.1 - '@radix-ui/react-dismissable-layer': 1.1.4_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-focus-guards': 1.1.1_react@18.3.1 - '@radix-ui/react-focus-scope': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-popper': 1.2.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-portal': 1.1.3_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-roving-focus': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-slot': 1.1.1_react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 + '@radix-ui/react-collection': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-direction': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-dismissable-layer': 1.1.4_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-focus-guards': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-focus-scope': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-popper': 1.2.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-portal': 1.1.3_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-roving-focus': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-slot': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 aria-hidden: 1.2.4 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 - react-remove-scroll: 2.6.3_react@18.3.1 + react-remove-scroll: 2.6.3_@types+react@19.0.8+react@18.3.1 dev: false - /@radix-ui/react-menubar/1.1.5_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-menubar/1.1.5_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-Kzbpcf2bxUmI/G+949+LvSvGkyzIaY7ctb8loydt6YpJR8pQF+j4QbVhYvjs7qxaWK0DEJL3XbP2p46YPRkS3A==} peerDependencies: '@types/react': '*' @@ -1047,20 +1169,21 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-collection': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-direction': 1.1.0_react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-menu': 2.1.5_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-roving-focus': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 + '@radix-ui/react-collection': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-direction': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-menu': 2.1.5_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-roving-focus': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-navigation-menu/1.2.4_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-navigation-menu/1.2.4_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-wUi01RrTDTOoGtjEPHsxlzPtVzVc3R/AZ5wfh0dyqMAqolhHAHvG5iQjBCTi2AjQqa77FWWbA3kE3RkD+bDMgQ==} peerDependencies: '@types/react': '*' @@ -1074,24 +1197,25 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-collection': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-direction': 1.1.0_react@18.3.1 - '@radix-ui/react-dismissable-layer': 1.1.4_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 - '@radix-ui/react-use-previous': 1.1.0_react@18.3.1 - '@radix-ui/react-visually-hidden': 1.1.1_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-collection': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-direction': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-dismissable-layer': 1.1.4_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-previous': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-visually-hidden': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-popover/1.1.5_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-popover/1.1.5_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-YXkTAftOIW2Bt3qKH8vYr6n9gCkVrvyvfiTObVjoHVTHnNj26rmvO87IKa3VgtgCjb8FAQ6qOjNViwl+9iIzlg==} peerDependencies: '@types/react': '*' @@ -1105,25 +1229,26 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-dismissable-layer': 1.1.4_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-focus-guards': 1.1.1_react@18.3.1 - '@radix-ui/react-focus-scope': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-popper': 1.2.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-portal': 1.1.3_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-slot': 1.1.1_react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-dismissable-layer': 1.1.4_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-focus-guards': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-focus-scope': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-popper': 1.2.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-portal': 1.1.3_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-slot': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 aria-hidden: 1.2.4 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 - react-remove-scroll: 2.6.3_react@18.3.1 + react-remove-scroll: 2.6.3_@types+react@19.0.8+react@18.3.1 dev: false - /@radix-ui/react-popper/1.2.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-popper/1.2.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-3kn5Me69L+jv82EKRuQCXdYyf1DqHwD2U/sxoNgBGCB7K9TRc3bQamQ+5EPM9EvyPdli0W41sROd+ZU1dTCztw==} peerDependencies: '@types/react': '*' @@ -1137,15 +1262,16 @@ packages: optional: true dependencies: '@floating-ui/react-dom': 2.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-arrow': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 - '@radix-ui/react-use-rect': 1.1.0_react@18.3.1 - '@radix-ui/react-use-size': 1.1.0_react@18.3.1 + '@radix-ui/react-arrow': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-rect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-size': 1.1.0_@types+react@19.0.8+react@18.3.1 '@radix-ui/rect': 1.1.0 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -1162,7 +1288,7 @@ packages: react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-portal/1.1.3_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-portal/1.1.3_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-NciRqhXnGojhT93RPyDaMPfLH3ZSl4jjIFbZQ1b/vxvZEdHsBZ49wP9w8L3HzUQwep01LcWtkUvm0OVB5JAHTw==} peerDependencies: '@types/react': '*' @@ -1175,8 +1301,9 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -1194,7 +1321,7 @@ packages: react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-presence/1.1.2_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-presence/1.1.2_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-18TFr80t5EVgL9x1SwF/YGtfG+l0BS0PRAlCWBDoBEiDQjeKgnNZRVJp/oVBl24sr3Gbfwc/Qpj4OcWTQMsAEg==} peerDependencies: '@types/react': '*' @@ -1207,8 +1334,9 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -1225,7 +1353,7 @@ packages: react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-primitive/2.0.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-primitive/2.0.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-sHCWTtxwNn3L3fH8qAfnF3WbUZycW93SM1j3NFDzXBiz8D6F5UTTy8G1+WFEaiCdvCVRJWj6N2R4Xq6HdiHmDg==} peerDependencies: '@types/react': '*' @@ -1238,12 +1366,13 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-slot': 1.1.1_react@18.3.1 + '@radix-ui/react-slot': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-progress/1.1.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-progress/1.1.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-6diOawA84f/eMxFHcWut0aE1C2kyE9dOyCTQOMRR2C/qPiXz/X0SaiA/RLbapQaXUCmy0/hLMf9meSccD1N0pA==} peerDependencies: '@types/react': '*' @@ -1256,13 +1385,14 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-radio-group/1.2.2_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-radio-group/1.2.2_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-E0MLLGfOP0l8P/NxgVzfXJ8w3Ch8cdO6UDzJfDChu4EJDy+/WdO5LqpdY8PYnCErkmZH3gZhDL1K7kQ41fAHuQ==} peerDependencies: '@types/react': '*' @@ -1276,20 +1406,21 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-direction': 1.1.0_react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-roving-focus': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 - '@radix-ui/react-use-previous': 1.1.0_react@18.3.1 - '@radix-ui/react-use-size': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-direction': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-roving-focus': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-previous': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-size': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-roving-focus/1.1.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-roving-focus/1.1.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-QE1RoxPGJ/Nm8Qmk0PxP8ojmoaS67i0s7hVssS7KuI2FQoc/uzVlZsqKfQvxPE6D8hICCPHJ4D88zNhT3OOmkw==} peerDependencies: '@types/react': '*' @@ -1303,19 +1434,20 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-collection': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-direction': 1.1.0_react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 + '@radix-ui/react-collection': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-direction': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-scroll-area/1.2.2_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-scroll-area/1.2.2_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-EFI1N/S3YxZEW/lJ/H1jY3njlvTd8tBmgKEn4GHi51+aMm94i6NmAJstsm5cu3yJwYqYc93gpCPm21FeAbFk6g==} peerDependencies: '@types/react': '*' @@ -1330,18 +1462,19 @@ packages: dependencies: '@radix-ui/number': 1.1.0 '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-direction': 1.1.0_react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-direction': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-select/2.1.5_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-select/2.1.5_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-eVV7N8jBXAXnyrc+PsOF89O9AfVgGnbLxUtBb0clJ8y8ENMWLARGMI/1/SBRLz7u4HqxLgN71BJ17eono3wcjA==} peerDependencies: '@types/react': '*' @@ -1356,30 +1489,31 @@ packages: dependencies: '@radix-ui/number': 1.1.0 '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-collection': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-direction': 1.1.0_react@18.3.1 - '@radix-ui/react-dismissable-layer': 1.1.4_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-focus-guards': 1.1.1_react@18.3.1 - '@radix-ui/react-focus-scope': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-popper': 1.2.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-portal': 1.1.3_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-slot': 1.1.1_react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 - '@radix-ui/react-use-previous': 1.1.0_react@18.3.1 - '@radix-ui/react-visually-hidden': 1.1.1_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-collection': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-direction': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-dismissable-layer': 1.1.4_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-focus-guards': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-focus-scope': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-popper': 1.2.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-portal': 1.1.3_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-slot': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-previous': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-visually-hidden': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@types/react': 19.0.8 aria-hidden: 1.2.4 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 - react-remove-scroll: 2.6.3_react@18.3.1 + react-remove-scroll: 2.6.3_@types+react@19.0.8+react@18.3.1 dev: false - /@radix-ui/react-separator/1.1.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-separator/1.1.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-RRiNRSrD8iUiXriq/Y5n4/3iE8HzqgLHsusUSg5jVpU2+3tqcUFPJXHDymwEypunc2sWxDUS3UC+rkZRlHedsw==} peerDependencies: '@types/react': '*' @@ -1392,12 +1526,13 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-slider/1.2.2_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-slider/1.2.2_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-sNlU06ii1/ZcbHf8I9En54ZPW0Vil/yPVg4vQMcFNjrIx51jsHbFl1HYHQvCIWJSr1q0ZmA+iIs/ZTv8h7HHSA==} peerDependencies: '@types/react': '*' @@ -1412,15 +1547,16 @@ packages: dependencies: '@radix-ui/number': 1.1.0 '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-collection': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-direction': 1.1.0_react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 - '@radix-ui/react-use-previous': 1.1.0_react@18.3.1 - '@radix-ui/react-use-size': 1.1.0_react@18.3.1 + '@radix-ui/react-collection': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-direction': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-previous': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-size': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -1435,7 +1571,7 @@ packages: react: 18.3.1 dev: false - /@radix-ui/react-slot/1.1.1_react@18.3.1: + /@radix-ui/react-slot/1.1.1_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-RApLLOcINYJA+dMVbOju7MYv1Mb2EBp2nH4HdDzXTSyaR5optlm6Otrz1euW3HbdOR8UmmFK06TD+A9frYWv+g==} peerDependencies: '@types/react': '*' @@ -1444,11 +1580,12 @@ packages: '@types/react': optional: true dependencies: - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 dev: false - /@radix-ui/react-switch/1.1.2_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-switch/1.1.2_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-zGukiWHjEdBCRyXvKR6iXAQG6qXm2esuAD6kDOi9Cn+1X6ev3ASo4+CsYaD6Fov9r/AQFekqnD/7+V0Cs6/98g==} peerDependencies: '@types/react': '*' @@ -1462,17 +1599,18 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 - '@radix-ui/react-use-previous': 1.1.0_react@18.3.1 - '@radix-ui/react-use-size': 1.1.0_react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-previous': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-size': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-tabs/1.1.2_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-tabs/1.1.2_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-9u/tQJMcC2aGq7KXpGivMm1mgq7oRJKXphDwdypPd/j21j/2znamPU8WkXgnhUaTrSFNIt8XhOyCAupg8/GbwQ==} peerDependencies: '@types/react': '*' @@ -1486,18 +1624,19 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-direction': 1.1.0_react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-roving-focus': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-direction': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-roving-focus': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-toast/1.2.5_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-toast/1.2.5_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-ZzUsAaOx8NdXZZKcFNDhbSlbsCUy8qQWmzTdgrlrhhZAOx2ofLtKrBDW9fkqhFvXgmtv560Uj16pkLkqML7SHA==} peerDependencies: '@types/react': '*' @@ -1511,22 +1650,23 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-collection': 1.1.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-dismissable-layer': 1.1.4_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-portal': 1.1.3_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 - '@radix-ui/react-visually-hidden': 1.1.1_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-collection': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-dismissable-layer': 1.1.4_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-portal': 1.1.3_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-visually-hidden': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-toggle/1.1.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-toggle/1.1.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-i77tcgObYr743IonC1hrsnnPmszDRn8p+EGUsUt+5a/JFn28fxaM88Py6V2mc8J5kELMWishI0rLnuGLFD/nnQ==} peerDependencies: '@types/react': '*' @@ -1540,13 +1680,14 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /@radix-ui/react-tooltip/1.1.7_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-tooltip/1.1.7_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-ss0s80BC0+g0+Zc53MvilcnTYSOi4mSuFWBPYPuTOFGjx+pUU+ZrmamMNwS56t8MTFlniA5ocjd4jYm/CdhbOg==} peerDependencies: '@types/react': '*' @@ -1560,17 +1701,18 @@ packages: optional: true dependencies: '@radix-ui/primitive': 1.1.1 - '@radix-ui/react-compose-refs': 1.1.1_react@18.3.1 - '@radix-ui/react-context': 1.1.1_react@18.3.1 - '@radix-ui/react-dismissable-layer': 1.1.4_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-id': 1.1.0_react@18.3.1 - '@radix-ui/react-popper': 1.2.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-portal': 1.1.3_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-presence': 1.1.2_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 - '@radix-ui/react-slot': 1.1.1_react@18.3.1 - '@radix-ui/react-use-controllable-state': 1.1.0_react@18.3.1 - '@radix-ui/react-visually-hidden': 1.1.1_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-compose-refs': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-context': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-dismissable-layer': 1.1.4_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-id': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-popper': 1.2.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-portal': 1.1.3_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-presence': 1.1.2_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@radix-ui/react-slot': 1.1.1_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-use-controllable-state': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@radix-ui/react-visually-hidden': 1.1.1_6db44ecc8c7d9cf758af9edbd1445878 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -1584,7 +1726,7 @@ packages: react: 18.3.1 dev: false - /@radix-ui/react-use-callback-ref/1.1.0_react@18.3.1: + /@radix-ui/react-use-callback-ref/1.1.0_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-CasTfvsy+frcFkbXtSJ2Zu9JHpN8TYKxkgJGWbjiZhFivxaeW7rMeZt7QELGVLaYVfFMsKHjb7Ak0nMEe+2Vfw==} peerDependencies: '@types/react': '*' @@ -1593,6 +1735,7 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 dev: false @@ -1606,7 +1749,7 @@ packages: react: 18.3.1 dev: false - /@radix-ui/react-use-controllable-state/1.1.0_react@18.3.1: + /@radix-ui/react-use-controllable-state/1.1.0_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-MtfMVJiSr2NjzS0Aa90NPTnvTSg6C/JLCV7ma0W6+OMV78vd8OyRpID+Ng9LxzsPbLeuBnWBA1Nq30AtBIDChw==} peerDependencies: '@types/react': '*' @@ -1615,7 +1758,8 @@ packages: '@types/react': optional: true dependencies: - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 dev: false @@ -1629,7 +1773,7 @@ packages: react: 18.3.1 dev: false - /@radix-ui/react-use-escape-keydown/1.1.0_react@18.3.1: + /@radix-ui/react-use-escape-keydown/1.1.0_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-L7vwWlR1kTTQ3oh7g1O0CBF3YCyyTj8NmhLR+phShpyA50HCfBFKVJTpshm9PzLiKmehsrQzTYTpX9HvmC9rhw==} peerDependencies: '@types/react': '*' @@ -1638,7 +1782,8 @@ packages: '@types/react': optional: true dependencies: - '@radix-ui/react-use-callback-ref': 1.1.0_react@18.3.1 + '@radix-ui/react-use-callback-ref': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 dev: false @@ -1651,7 +1796,7 @@ packages: react: 18.3.1 dev: false - /@radix-ui/react-use-layout-effect/1.1.0_react@18.3.1: + /@radix-ui/react-use-layout-effect/1.1.0_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-+FPE0rOdziWSrH9athwI1R0HDVbWlEhd+FR+aSDk4uWGmSJ9Z54sdZVDQPZAinJhJXwfT+qnj969mCsT2gfm5w==} peerDependencies: '@types/react': '*' @@ -1660,10 +1805,11 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 dev: false - /@radix-ui/react-use-previous/1.1.0_react@18.3.1: + /@radix-ui/react-use-previous/1.1.0_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-Z/e78qg2YFnnXcW88A4JmTtm4ADckLno6F7OXotmkQfeuCVaKuYzqAATPhVzl3delXE7CxIV8shofPn3jPc5Og==} peerDependencies: '@types/react': '*' @@ -1672,10 +1818,11 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 dev: false - /@radix-ui/react-use-rect/1.1.0_react@18.3.1: + /@radix-ui/react-use-rect/1.1.0_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-0Fmkebhr6PiseyZlYAOtLS+nb7jLmpqTrJyv61Pe68MKYW6OWdRE2kI70TaYY27u7H0lajqM3hSMMLFq18Z7nQ==} peerDependencies: '@types/react': '*' @@ -1685,10 +1832,11 @@ packages: optional: true dependencies: '@radix-ui/rect': 1.1.0 + '@types/react': 19.0.8 react: 18.3.1 dev: false - /@radix-ui/react-use-size/1.1.0_react@18.3.1: + /@radix-ui/react-use-size/1.1.0_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-XW3/vWuIXHa+2Uwcc2ABSfcCledmXhhQPlGbfcRXbiUQI5Icjcg19BGCZVKKInYbvUCut/ufbbLLPFC5cbb1hw==} peerDependencies: '@types/react': '*' @@ -1697,11 +1845,12 @@ packages: '@types/react': optional: true dependencies: - '@radix-ui/react-use-layout-effect': 1.1.0_react@18.3.1 + '@radix-ui/react-use-layout-effect': 1.1.0_@types+react@19.0.8+react@18.3.1 + '@types/react': 19.0.8 react: 18.3.1 dev: false - /@radix-ui/react-visually-hidden/1.1.1_react-dom@18.3.1+react@18.3.1: + /@radix-ui/react-visually-hidden/1.1.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-vVfA2IZ9q/J+gEamvj761Oq1FpWgCDaNOOIfbPVp2MVPLEomUr5+Vf7kJGwQ24YxZSlQVar7Bes8kyTo5Dshpg==} peerDependencies: '@types/react': '*' @@ -1714,7 +1863,8 @@ packages: '@types/react-dom': optional: true dependencies: - '@radix-ui/react-primitive': 2.0.1_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-primitive': 2.0.1_6db44ecc8c7d9cf758af9edbd1445878 + '@types/react': 19.0.8 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -1723,6 +1873,143 @@ packages: resolution: {integrity: sha512-A9+lCBZoaMJlVKcRBz2YByCG+Cp2t6nAnMnNba+XiWxnj6r4JUFqfsgwocMBZU9LPtdxC6wB56ySYpc7LQIoJg==} dev: false + /@react-aria/focus/3.19.1_react-dom@18.3.1+react@18.3.1: + resolution: {integrity: sha512-bix9Bu1Ue7RPcYmjwcjhB14BMu2qzfJ3tMQLqDc9pweJA66nOw8DThy3IfVr8Z7j2PHktOLf9kcbiZpydKHqzg==} + peerDependencies: + react: ^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1 + react-dom: ^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1 + dependencies: + '@react-aria/interactions': 3.23.0_react-dom@18.3.1+react@18.3.1 + '@react-aria/utils': 3.27.0_react-dom@18.3.1+react@18.3.1 + '@react-types/shared': 3.27.0_react@18.3.1 + '@swc/helpers': 0.5.15 + clsx: 2.1.1 + react: 18.3.1 + react-dom: 18.3.1_react@18.3.1 + dev: false + + /@react-aria/interactions/3.23.0_react-dom@18.3.1+react@18.3.1: + resolution: {integrity: sha512-0qR1atBIWrb7FzQ+Tmr3s8uH5mQdyRH78n0krYaG8tng9+u1JlSi8DGRSaC9ezKyNB84m7vHT207xnHXGeJ3Fg==} + peerDependencies: + react: ^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1 + react-dom: ^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1 + dependencies: + '@react-aria/ssr': 3.9.7_react@18.3.1 + '@react-aria/utils': 3.27.0_react-dom@18.3.1+react@18.3.1 + '@react-types/shared': 3.27.0_react@18.3.1 + '@swc/helpers': 0.5.15 + react: 18.3.1 + react-dom: 18.3.1_react@18.3.1 + dev: false + + /@react-aria/ssr/3.9.7_react@18.3.1: + resolution: {integrity: sha512-GQygZaGlmYjmYM+tiNBA5C6acmiDWF52Nqd40bBp0Znk4M4hP+LTmI0lpI1BuKMw45T8RIhrAsICIfKwZvi2Gg==} + engines: {node: '>= 12'} + peerDependencies: + react: ^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1 + dependencies: + '@swc/helpers': 0.5.15 + react: 18.3.1 + dev: false + + /@react-aria/utils/3.27.0_react-dom@18.3.1+react@18.3.1: + resolution: {integrity: sha512-p681OtApnKOdbeN8ITfnnYqfdHS0z7GE+4l8EXlfLnr70Rp/9xicBO6d2rU+V/B3JujDw2gPWxYKEnEeh0CGCw==} + peerDependencies: + react: ^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1 + react-dom: ^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1 + dependencies: + '@react-aria/ssr': 3.9.7_react@18.3.1 + '@react-stately/utils': 3.10.5_react@18.3.1 + '@react-types/shared': 3.27.0_react@18.3.1 + '@swc/helpers': 0.5.15 + clsx: 2.1.1 + react: 18.3.1 + react-dom: 18.3.1_react@18.3.1 + dev: false + + /@react-stately/utils/3.10.5_react@18.3.1: + resolution: {integrity: sha512-iMQSGcpaecghDIh3mZEpZfoFH3ExBwTtuBEcvZ2XnGzCgQjeYXcMdIUwAfVQLXFTdHUHGF6Gu6/dFrYsCzySBQ==} + peerDependencies: + react: ^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1 + dependencies: + '@swc/helpers': 0.5.15 + react: 18.3.1 + dev: false + + /@react-types/shared/3.27.0_react@18.3.1: + resolution: {integrity: sha512-gvznmLhi6JPEf0bsq7SwRYTHAKKq/wcmKqFez9sRdbED+SPMUmK5omfZ6w3EwUFQHbYUa4zPBYedQ7Knv70RMw==} + peerDependencies: + react: ^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1 + dependencies: + react: 18.3.1 + dev: false + + /@shikijs/core/1.29.1: + resolution: {integrity: sha512-Mo1gGGkuOYjDu5H8YwzmOuly9vNr8KDVkqj9xiKhhhFS8jisAtDSEWB9hzqRHLVQgFdA310e8XRJcW4tYhRB2A==} + dependencies: + '@shikijs/engine-javascript': 1.29.1 + '@shikijs/engine-oniguruma': 1.29.1 + '@shikijs/types': 1.29.1 + '@shikijs/vscode-textmate': 10.0.1 + '@types/hast': 3.0.4 + hast-util-to-html: 9.0.4 + dev: false + + /@shikijs/engine-javascript/1.29.1: + resolution: {integrity: sha512-Hpi8k9x77rCQ7F/7zxIOUruNkNidMyBnP5qAGbLFqg4kRrg1HZhkB8btib5EXbQWTtLb5gBHOdBwshk20njD7Q==} + dependencies: + '@shikijs/types': 1.29.1 + '@shikijs/vscode-textmate': 10.0.1 + oniguruma-to-es: 2.3.0 + dev: false + + /@shikijs/engine-oniguruma/1.29.1: + resolution: {integrity: sha512-gSt2WhLNgEeLstcweQOSp+C+MhOpTsgdNXRqr3zP6M+BUBZ8Md9OU2BYwUYsALBxHza7hwaIWtFHjQ/aOOychw==} + dependencies: + '@shikijs/types': 1.29.1 + '@shikijs/vscode-textmate': 10.0.1 + dev: false + + /@shikijs/langs/1.29.1: + resolution: {integrity: sha512-iERn4HlyuT044/FgrvLOaZgKVKf3PozjKjyV/RZ5GnlyYEAZFcgwHGkYboeBv2IybQG1KVS/e7VGgiAU4JY2Gw==} + dependencies: + '@shikijs/types': 1.29.1 + dev: false + + /@shikijs/themes/1.29.1: + resolution: {integrity: sha512-lb11zf72Vc9uxkl+aec2oW1HVTHJ2LtgZgumb4Rr6By3y/96VmlU44bkxEb8WBWH3RUtbqAJEN0jljD9cF7H7g==} + dependencies: + '@shikijs/types': 1.29.1 + dev: false + + /@shikijs/twoslash/1.29.1_typescript@5.7.3: + resolution: {integrity: sha512-SN2aam87NjkpjS0O2Zq9SeXSDX1CztLBAROXrJpEe5Qe19dkMUUXY8uhw32Qu/FKjqsK8ycEP2S6FZrd9A2pzw==} + dependencies: + '@shikijs/core': 1.29.1 + '@shikijs/types': 1.29.1 + twoslash: 0.2.12_typescript@5.7.3 + transitivePeerDependencies: + - supports-color + - typescript + dev: false + + /@shikijs/types/1.29.1: + resolution: {integrity: sha512-aBqAuhYRp5vSir3Pc9+QPu9WESBOjUo03ao0IHLC4TyTioSsp/SkbAZSrIH4ghYYC1T1KTEpRSBa83bas4RnPA==} + dependencies: + '@shikijs/vscode-textmate': 10.0.1 + '@types/hast': 3.0.4 + dev: false + + /@shikijs/vscode-textmate/10.0.1: + resolution: {integrity: sha512-fTIQwLF+Qhuws31iw7Ncl1R3HUDtGwIipiJ9iU+UsDUwMhegFcQKQHd51nZjb7CArq0MvON8rbgCGQYWHUKAdg==} + dev: false + + /@swc/helpers/0.5.15: + resolution: {integrity: sha512-JQ5TuMi45Owi4/BIMAJBoSQoOJu12oOk/gADqlcUL9JEdHB8vyjUSsxqeNXnmXHjYKMi2WcYtezGEEhqUI/E2g==} + dependencies: + tslib: 2.8.1 + dev: false + /@swc/helpers/0.5.2: resolution: {integrity: sha512-E4KcWTpoLHqwPHLxidpOqQbcrZVgi0rsmmZXUle1jXmJfuIf/UWpczUJ7MZZ5tlxytgJXyp0w4PGkkeLiuIdZw==} dependencies: @@ -1744,22 +2031,22 @@ packages: resolution: {integrity: sha512-v2mrNSnMwnPJtcVqNvV0c5roGCBqeogN8jDtgtuHCphdwBasOZ17x8UV8qpHUh+u0MLfX43c0uUHKje0s+Zb0w==} dev: false - /@theguild/remark-mermaid/0.0.5_react@18.3.1: - resolution: {integrity: sha512-e+ZIyJkEv9jabI4m7q29wZtZv+2iwPGsXJ2d46Zi7e+QcFudiyuqhLhHG/3gX3ZEB+hxTch+fpItyMS8jwbIcw==} + /@theguild/remark-mermaid/0.1.3_react@18.3.1: + resolution: {integrity: sha512-2FjVlaaKXK7Zj7UJAgOVTyaahn/3/EAfqYhyXg0BfDBVUl+lXcoIWRaxzqfnDr2rv8ax6GsC5mNh6hAaT86PDw==} peerDependencies: react: ^18.2.0 dependencies: - mermaid: 10.9.3 + mermaid: 11.4.1 react: 18.3.1 unist-util-visit: 5.0.0 transitivePeerDependencies: - supports-color dev: false - /@theguild/remark-npm2yarn/0.2.1: - resolution: {integrity: sha512-jUTFWwDxtLEFtGZh/TW/w30ySaDJ8atKWH8dq2/IiQF61dPrGfETpl0WxD0VdBfuLOeU14/kop466oBSRO/5CA==} + /@theguild/remark-npm2yarn/0.3.3: + resolution: {integrity: sha512-ma6DvR03gdbvwqfKx1omqhg9May/VYGdMHvTzB4VuxkyS7KzfZ/lzrj43hmcsggpMje0x7SADA/pcMph0ejRnA==} dependencies: - npm-to-yarn: 2.2.1 + npm-to-yarn: 3.0.1 unist-util-visit: 5.0.0 dev: false @@ -1769,6 +2056,105 @@ packages: '@types/estree': 1.0.6 dev: false + /@types/d3-array/3.2.1: + resolution: {integrity: sha512-Y2Jn2idRrLzUfAKV2LyRImR+y4oa2AntrgID95SHJxuMUrkNXmanDSed71sRNZysveJVt1hLLemQZIady0FpEg==} + dev: false + + /@types/d3-axis/3.0.6: + resolution: {integrity: sha512-pYeijfZuBd87T0hGn0FO1vQ/cgLk6E1ALJjfkC0oJ8cbwkZl3TpgS8bVBLZN+2jjGgg38epgxb2zmoGtSfvgMw==} + dependencies: + '@types/d3-selection': 3.0.11 + dev: false + + /@types/d3-brush/3.0.6: + resolution: {integrity: sha512-nH60IZNNxEcrh6L1ZSMNA28rj27ut/2ZmI3r96Zd+1jrZD++zD3LsMIjWlvg4AYrHn/Pqz4CF3veCxGjtbqt7A==} + dependencies: + '@types/d3-selection': 3.0.11 + dev: false + + /@types/d3-chord/3.0.6: + resolution: {integrity: sha512-LFYWWd8nwfwEmTZG9PfQxd17HbNPksHBiJHaKuY1XeqscXacsS2tyoo6OdRsjf+NQYeB6XrNL3a25E3gH69lcg==} + dev: false + + /@types/d3-color/3.1.3: + resolution: {integrity: sha512-iO90scth9WAbmgv7ogoq57O9YpKmFBbmoEoCHDB2xMBY0+/KVrqAaCDyCE16dUspeOvIxFFRI+0sEtqDqy2b4A==} + dev: false + + /@types/d3-contour/3.0.6: + resolution: {integrity: sha512-BjzLgXGnCWjUSYGfH1cpdo41/hgdWETu4YxpezoztawmqsvCeep+8QGfiY6YbDvfgHz/DkjeIkkZVJavB4a3rg==} + dependencies: + '@types/d3-array': 3.2.1 + '@types/geojson': 7946.0.16 + dev: false + + /@types/d3-delaunay/6.0.4: + resolution: {integrity: sha512-ZMaSKu4THYCU6sV64Lhg6qjf1orxBthaC161plr5KuPHo3CNm8DTHiLw/5Eq2b6TsNP0W0iJrUOFscY6Q450Hw==} + dev: false + + /@types/d3-dispatch/3.0.6: + resolution: {integrity: sha512-4fvZhzMeeuBJYZXRXrRIQnvUYfyXwYmLsdiN7XXmVNQKKw1cM8a5WdID0g1hVFZDqT9ZqZEY5pD44p24VS7iZQ==} + dev: false + + /@types/d3-drag/3.0.7: + resolution: {integrity: sha512-HE3jVKlzU9AaMazNufooRJ5ZpWmLIoc90A37WU2JMmeq28w1FQqCZswHZ3xR+SuxYftzHq6WU6KJHvqxKzTxxQ==} + dependencies: + '@types/d3-selection': 3.0.11 + dev: false + + /@types/d3-dsv/3.0.7: + resolution: {integrity: sha512-n6QBF9/+XASqcKK6waudgL0pf/S5XHPPI8APyMLLUHd8NqouBGLsU8MgtO7NINGtPBtk9Kko/W4ea0oAspwh9g==} + dev: false + + /@types/d3-ease/3.0.2: + resolution: {integrity: sha512-NcV1JjO5oDzoK26oMzbILE6HW7uVXOHLQvHshBUW4UMdZGfiY6v5BeQwh9a9tCzv+CeefZQHJt5SRgK154RtiA==} + dev: false + + /@types/d3-fetch/3.0.7: + resolution: {integrity: sha512-fTAfNmxSb9SOWNB9IoG5c8Hg6R+AzUHDRlsXsDZsNp6sxAEOP0tkP3gKkNSO/qmHPoBFTxNrjDprVHDQDvo5aA==} + dependencies: + '@types/d3-dsv': 3.0.7 + dev: false + + /@types/d3-force/3.0.10: + resolution: {integrity: sha512-ZYeSaCF3p73RdOKcjj+swRlZfnYpK1EbaDiYICEEp5Q6sUiqFaFQ9qgoshp5CzIyyb/yD09kD9o2zEltCexlgw==} + dev: false + + /@types/d3-format/3.0.4: + resolution: {integrity: sha512-fALi2aI6shfg7vM5KiR1wNJnZ7r6UuggVqtDA+xiEdPZQwy/trcQaHnwShLuLdta2rTymCNpxYTiMZX/e09F4g==} + dev: false + + /@types/d3-geo/3.1.0: + resolution: {integrity: sha512-856sckF0oP/diXtS4jNsiQw/UuK5fQG8l/a9VVLeSouf1/PPbBE1i1W852zVwKwYCBkFJJB7nCFTbk6UMEXBOQ==} + dependencies: + '@types/geojson': 7946.0.16 + dev: false + + /@types/d3-hierarchy/3.1.7: + resolution: {integrity: sha512-tJFtNoYBtRtkNysX1Xq4sxtjK8YgoWUNpIiUee0/jHGRwqvzYxkq0hGVbbOGSz+JgFxxRu4K8nb3YpG3CMARtg==} + dev: false + + /@types/d3-interpolate/3.0.4: + resolution: {integrity: sha512-mgLPETlrpVV1YRJIglr4Ez47g7Yxjl1lj7YKsiMCb27VJH9W8NVM6Bb9d8kkpG/uAQS5AmbA48q2IAolKKo1MA==} + dependencies: + '@types/d3-color': 3.1.3 + dev: false + + /@types/d3-path/3.1.0: + resolution: {integrity: sha512-P2dlU/q51fkOc/Gfl3Ul9kicV7l+ra934qBFXCFhrZMOL6du1TM0pm1ThYvENukyOn5h9v+yMJ9Fn5JK4QozrQ==} + dev: false + + /@types/d3-polygon/3.0.2: + resolution: {integrity: sha512-ZuWOtMaHCkN9xoeEMr1ubW2nGWsp4nIql+OPQRstu4ypeZ+zk3YKqQT0CXVe/PYqrKpZAi+J9mTs05TKwjXSRA==} + dev: false + + /@types/d3-quadtree/3.0.6: + resolution: {integrity: sha512-oUzyO1/Zm6rsxKRHA1vH0NEDG58HrT5icx/azi9MF1TWdtttWl0UIUsjEQBBh+SIkrpd21ZjEv7ptxWys1ncsg==} + dev: false + + /@types/d3-random/3.0.3: + resolution: {integrity: sha512-Imagg1vJ3y76Y2ea0871wpabqp613+8/r0mCLEBfdtqC7xMSfj9idOnmBYyMoULfHePJyxMAw3nWhJxzc+LFwQ==} + dev: false + /@types/d3-scale-chromatic/3.1.0: resolution: {integrity: sha512-iWMJgwkK7yTRmWqRB5plb1kadXyQ5Sj8V/zYlFGMUBbIPKQScw+Dku9cAAMgJG+z5GYDoMjWGLVOvjghDEFnKQ==} dev: false @@ -1779,10 +2165,76 @@ packages: '@types/d3-time': 3.0.4 dev: false + /@types/d3-selection/3.0.11: + resolution: {integrity: sha512-bhAXu23DJWsrI45xafYpkQ4NtcKMwWnAC/vKrd2l+nxMFuvOT3XMYTIj2opv8vq8AO5Yh7Qac/nSeP/3zjTK0w==} + dev: false + + /@types/d3-shape/3.1.7: + resolution: {integrity: sha512-VLvUQ33C+3J+8p+Daf+nYSOsjB4GXp19/S/aGo60m9h1v6XaxjiT82lKVWJCfzhtuZ3yD7i/TPeC/fuKLLOSmg==} + dependencies: + '@types/d3-path': 3.1.0 + dev: false + + /@types/d3-time-format/4.0.3: + resolution: {integrity: sha512-5xg9rC+wWL8kdDj153qZcsJ0FWiFt0J5RB6LYUNZjwSnesfblqrI/bJ1wBdJ8OQfncgbJG5+2F+qfqnqyzYxyg==} + dev: false + /@types/d3-time/3.0.4: resolution: {integrity: sha512-yuzZug1nkAAaBlBBikKZTgzCeA+k1uy4ZFwWANOfKw5z5LRhV0gNA7gNkKm7HoK+HRN0wX3EkxGk0fpbWhmB7g==} dev: false + /@types/d3-timer/3.0.2: + resolution: {integrity: sha512-Ps3T8E8dZDam6fUyNiMkekK3XUsaUEik+idO9/YjPtfj2qruF8tFBXS7XhtE4iIXBLxhmLjP3SXpLhVf21I9Lw==} + dev: false + + /@types/d3-transition/3.0.9: + resolution: {integrity: sha512-uZS5shfxzO3rGlu0cC3bjmMFKsXv+SmZZcgp0KD22ts4uGXp5EVYGzu/0YdwZeKmddhcAccYtREJKkPfXkZuCg==} + dependencies: + '@types/d3-selection': 3.0.11 + dev: false + + /@types/d3-zoom/3.0.8: + resolution: {integrity: sha512-iqMC4/YlFCSlO8+2Ii1GGGliCAY4XdeG748w5vQUbevlbDu0zSjH/+jojorQVBK/se0j6DUFNPBGSqD3YWYnDw==} + dependencies: + '@types/d3-interpolate': 3.0.4 + '@types/d3-selection': 3.0.11 + dev: false + + /@types/d3/7.4.3: + resolution: {integrity: sha512-lZXZ9ckh5R8uiFVt8ogUNf+pIrK4EsWrx2Np75WvF/eTpJ0FMHNhjXk8CKEx/+gpHbNQyJWehbFaTvqmHWB3ww==} + dependencies: + '@types/d3-array': 3.2.1 + '@types/d3-axis': 3.0.6 + '@types/d3-brush': 3.0.6 + '@types/d3-chord': 3.0.6 + '@types/d3-color': 3.1.3 + '@types/d3-contour': 3.0.6 + '@types/d3-delaunay': 6.0.4 + '@types/d3-dispatch': 3.0.6 + '@types/d3-drag': 3.0.7 + '@types/d3-dsv': 3.0.7 + '@types/d3-ease': 3.0.2 + '@types/d3-fetch': 3.0.7 + '@types/d3-force': 3.0.10 + '@types/d3-format': 3.0.4 + '@types/d3-geo': 3.1.0 + '@types/d3-hierarchy': 3.1.7 + '@types/d3-interpolate': 3.0.4 + '@types/d3-path': 3.1.0 + '@types/d3-polygon': 3.0.2 + '@types/d3-quadtree': 3.0.6 + '@types/d3-random': 3.0.3 + '@types/d3-scale': 4.0.8 + '@types/d3-scale-chromatic': 3.1.0 + '@types/d3-selection': 3.0.11 + '@types/d3-shape': 3.1.7 + '@types/d3-time': 3.0.4 + '@types/d3-time-format': 4.0.3 + '@types/d3-timer': 3.0.2 + '@types/d3-transition': 3.0.9 + '@types/d3-zoom': 3.0.8 + dev: false + /@types/debug/4.1.12: resolution: {integrity: sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==} dependencies: @@ -1799,10 +2251,8 @@ packages: resolution: {integrity: sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==} dev: false - /@types/hast/2.3.10: - resolution: {integrity: sha512-McWspRw8xx8J9HurkVBfYj0xKoE25tOFlHGdx4MJ5xORQrMGZNqJhVQWaIbm6Oyla5kYOXtDiopzKRJzEOkwJw==} - dependencies: - '@types/unist': 2.0.11 + /@types/geojson/7946.0.16: + resolution: {integrity: sha512-6C8nqWur3j98U6+lXDfTUWIfgvZU+EumvpHKcYjujKH7woYyLj2sUmff0tRhrqM7BohUw7Pz3ZB1jj2gW9Fvmg==} dev: false /@types/hast/3.0.4: @@ -1811,20 +2261,10 @@ packages: '@types/unist': 3.0.3 dev: false - /@types/js-yaml/4.0.9: - resolution: {integrity: sha512-k4MGaQl5TGo/iipqb2UDG2UwjXziSWkh0uysQelTlJpX1qGlpUZYm8PnO4DxG1qBomtJUdYJ6qR6xdIah10JLg==} - dev: false - /@types/katex/0.16.7: resolution: {integrity: sha512-HMwFiRujE5PjrgwHQ25+bsLJgowjGjm5Z8FVSf0N6PwgJrwxH0QxzHYDcKsTfV3wva0vzrpqMTJS2jXPr5BMEQ==} dev: false - /@types/mdast/3.0.15: - resolution: {integrity: sha512-LnwD+mUEfxWMa1QpDraczIn6k0Ee3SMicuYSSzS6ZYl2gKS09EClnJYGd8Du6rfc5r/GZEk5o1mRb8TaTj03sQ==} - dependencies: - '@types/unist': 2.0.11 - dev: false - /@types/mdast/4.0.4: resolution: {integrity: sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==} dependencies: @@ -1839,6 +2279,12 @@ packages: resolution: {integrity: sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==} dev: false + /@types/nlcst/2.0.3: + resolution: {integrity: sha512-vSYNSDe6Ix3q+6Z7ri9lyWqgGhJTmzRjZRqyq15N0Z/1/UnVsno9G/N40NBijoYx2seFDIl0+B2mgAb9mezUCA==} + dependencies: + '@types/unist': 3.0.3 + dev: false + /@types/node/18.11.10: resolution: {integrity: sha512-juG3RWMBOqcOuXC643OAdSA525V44cVgGV6dUDuiFtss+8Fk5x1hI93Rsld43VeJVIeqlP9I7Fn9/qaVqoEAuQ==} dev: true @@ -1847,7 +2293,12 @@ packages: resolution: {integrity: sha512-9P/o1IGdfmQxrujGbIMDyYaaCykhLKc0NGCtYcECNUr9UAaDe4gwvV9bR6tvd5Br1SG0j+PBpbKr2UYY8CwqSw==} dependencies: csstype: 3.1.3 + dev: true + + /@types/trusted-types/2.0.7: + resolution: {integrity: sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw==} dev: false + optional: true /@types/unist/2.0.11: resolution: {integrity: sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==} @@ -1857,10 +2308,27 @@ packages: resolution: {integrity: sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==} dev: false + /@typescript/vfs/1.6.0_typescript@5.7.3: + resolution: {integrity: sha512-hvJUjNVeBMp77qPINuUvYXj4FyWeeMMKZkxEATEU3hqBAQ7qdTBCUFT7Sp0Zu0faeEtFf+ldXxMEDr/bk73ISg==} + peerDependencies: + typescript: '*' + dependencies: + debug: 4.4.0 + typescript: 5.7.3 + transitivePeerDependencies: + - supports-color + dev: false + /@ungap/structured-clone/1.3.0: resolution: {integrity: sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==} dev: false + /acorn-jsx/5.3.2: + resolution: {integrity: sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==} + peerDependencies: + acorn: ^6.0.0 || ^7.0.0 || ^8.0.0 + dev: false + /acorn-jsx/5.3.2_acorn@8.14.0: resolution: {integrity: sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==} peerDependencies: @@ -1885,17 +2353,6 @@ packages: engines: {node: '>=12'} dev: true - /ansi-sequence-parser/1.1.1: - resolution: {integrity: sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==} - dev: false - - /ansi-styles/3.2.1: - resolution: {integrity: sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==} - engines: {node: '>=4'} - dependencies: - color-convert: 1.9.3 - dev: false - /ansi-styles/4.3.0: resolution: {integrity: sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==} engines: {node: '>=8'} @@ -1920,17 +2377,8 @@ packages: picomatch: 2.3.1 dev: true - /arch/2.2.0: - resolution: {integrity: sha512-Of/R0wqp83cgHozfIYLbBMnej79U/SVGOOyuB3VVFv1NRM/PSFMK12x9KVtiYzJqmnU5WR2qp0Z5rHb7sWGnFQ==} - dev: false - - /arg/1.0.0: - resolution: {integrity: sha512-Wk7TEzl1KqvTGs/uyhmHO/3XLd3t1UeU4IstvPXVzGPM522cTjqjNZ99esCkcL52sjqjo8e8CTBcWhkxvGzoAw==} - dev: false - /arg/5.0.2: resolution: {integrity: sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==} - dev: true /argparse/1.0.10: resolution: {integrity: sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==} @@ -1949,6 +2397,10 @@ packages: tslib: 2.8.1 dev: false + /array-iterate/2.0.1: + resolution: {integrity: sha512-I1jXZMjAgCMmxT4qxXfPXa6SthSoE8h6gkSI9BGGNv8mP8G/v0blc+qFnZu6K42vTOiuME596QaLO0TP3Lk0xg==} + dev: false + /astring/1.9.0: resolution: {integrity: sha512-LElXdjswlqjWrPpJFg1Fx4wpkOCxj1TDHlSV4PlaRxHGWko024xICaa97ZkMfs6DRKlCguiAI+rbXv5GWwXIkg==} hasBin: true @@ -1976,7 +2428,15 @@ packages: /balanced-match/1.0.2: resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==} - dev: true + + /better-react-mathjax/2.0.3_react@18.3.1: + resolution: {integrity: sha512-wfifT8GFOKb1TWm2+E50I6DJpLZ5kLbch283Lu043EJtwSv0XvZDjr4YfR4d2MjAhqP6SH4VjjrKgbX8R00oCQ==} + peerDependencies: + react: '>=16.8' + dependencies: + mathjax-full: 3.2.2 + react: 18.3.1 + dev: false /binary-extensions/2.3.0: resolution: {integrity: sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==} @@ -1987,7 +2447,6 @@ packages: resolution: {integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==} dependencies: balanced-match: 1.0.2 - dev: true /braces/3.0.3: resolution: {integrity: sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==} @@ -2026,13 +2485,9 @@ packages: resolution: {integrity: sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==} dev: false - /chalk/2.3.0: - resolution: {integrity: sha512-Az5zJR2CBujap2rqXGaJKaPHyJ0IrUimvYNX+ncCy8PJP4ltOGTrHUIo097ZaL2zMeKYpiCdqDvS6zdrTFok3Q==} - engines: {node: '>=4'} - dependencies: - ansi-styles: 3.2.1 - escape-string-regexp: 1.0.5 - supports-color: 4.5.0 + /chalk/5.4.1: + resolution: {integrity: sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w==} + engines: {node: ^12.17.0 || ^14.13 || >=16.0.0} dev: false /character-entities-html4/2.1.0: @@ -2051,6 +2506,26 @@ packages: resolution: {integrity: sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==} dev: false + /chevrotain-allstar/0.3.1_chevrotain@11.0.3: + resolution: {integrity: sha512-b7g+y9A0v4mxCW1qUhf3BSVPg+/NvGErk/dOkrDaHA0nQIQGAtrOjlX//9OQtRlSCy+x9rfB5N8yC71lH1nvMw==} + peerDependencies: + chevrotain: ^11.0.0 + dependencies: + chevrotain: 11.0.3 + lodash-es: 4.17.21 + dev: false + + /chevrotain/11.0.3: + resolution: {integrity: sha512-ci2iJH6LeIkvP9eJW6gpueU8cnZhv85ELY8w8WiFtNjMHA5ad6pQLaJo9mEly/9qUyCpvqX8/POVUTf18/HFdw==} + dependencies: + '@chevrotain/cst-dts-gen': 11.0.3 + '@chevrotain/gast': 11.0.3 + '@chevrotain/regexp-to-ast': 11.0.3 + '@chevrotain/types': 11.0.3 + '@chevrotain/utils': 11.0.3 + lodash-es: 4.17.21 + dev: false + /chokidar/3.6.0: resolution: {integrity: sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==} engines: {node: '>= 8.10.0'} @@ -2076,12 +2551,13 @@ packages: resolution: {integrity: sha512-IV3Ou0jSMzZrd3pZ48nLkT9DA7Ag1pnPzaiQhpW7c3RbcqqzvzzVu+L8gfqMp/8IM2MQtSiqaCxrrcfu8I8rMA==} dev: false - /clipboardy/1.2.2: - resolution: {integrity: sha512-16KrBOV7bHmHdxcQiCvfUFYVFyEah4FI8vYT1Fr7CGSA4G+xBWMEfUEQJS1hxeHGtI9ju1Bzs9uXSbj5HZKArw==} - engines: {node: '>=4'} + /clipboardy/4.0.0: + resolution: {integrity: sha512-5mOlNS0mhX0707P2I0aZ2V/cmHUEO/fL7VFLqszkhUsxt7RwnmrInf/eEQKlf5GzvYeHIjT+Ov1HRfNmymlG0w==} + engines: {node: '>=18'} dependencies: - arch: 2.2.0 - execa: 0.8.0 + execa: 8.0.1 + is-wsl: 3.1.0 + is64bit: 2.0.0 dev: false /clsx/2.1.1: @@ -2089,23 +2565,21 @@ packages: engines: {node: '>=6'} dev: false - /cmdk/0.2.1_react-dom@18.3.1+react@18.3.1: + /cmdk/0.2.1_6db44ecc8c7d9cf758af9edbd1445878: resolution: {integrity: sha512-U6//9lQ6JvT47+6OF6Gi8BvkxYQ8SCRRSKIJkthIMsFsLZRG0cKvTtuTaefyIKMQb8rvvXy0wGdpTNq/jPtm+g==} peerDependencies: react: ^18.0.0 react-dom: ^18.0.0 dependencies: - '@radix-ui/react-dialog': 1.0.0_react-dom@18.3.1+react@18.3.1 + '@radix-ui/react-dialog': 1.0.0_6db44ecc8c7d9cf758af9edbd1445878 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 transitivePeerDependencies: - '@types/react' dev: false - /color-convert/1.9.3: - resolution: {integrity: sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==} - dependencies: - color-name: 1.1.3 + /collapse-white-space/2.1.0: + resolution: {integrity: sha512-loKTxY1zCOuG4j9f6EPnuyyYkf58RnhhWTvRoZEokgB+WbdXehfjFviyOVYkqzEWz1Q5kRiZdBYS5SwxbQYwzw==} dev: false /color-convert/2.0.1: @@ -2115,10 +2589,6 @@ packages: color-name: 1.1.4 dev: true - /color-name/1.1.3: - resolution: {integrity: sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==} - dev: false - /color-name/1.1.4: resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==} dev: true @@ -2142,22 +2612,29 @@ packages: engines: {node: '>= 12'} dev: false + /commander/9.2.0: + resolution: {integrity: sha512-e2i4wANQiSXgnrBlIatyHtP1odfUp0BbV5Y5nEGbxtIrStkEOAAzCUirvLBNXHLr7kwLvJl6V+4V3XV9x7Wd9w==} + engines: {node: ^12.20.0 || >=14} + dev: false + /compute-scroll-into-view/3.1.1: resolution: {integrity: sha512-VRhuHOLoKYOy4UbilLbUzbYg93XLjv2PncJC50EuTWPA3gaja1UjBsUP/D/9/juV3vQFr6XBEzn9KCAHdUvOHw==} dev: false + /confbox/0.1.8: + resolution: {integrity: sha512-RMtmw0iFkeR4YV+fUOSucriAQNb9g8zFR52MWCtl+cCZOFRNL6zeB395vPzFhEjjn4fMxXudmELnl/KF/WrK6w==} + dev: false + /cose-base/1.0.3: resolution: {integrity: sha512-s9whTXInMSgAp/NVXVNuVxVKzGH2qck3aQlVHxDCdAEPgtMKwc4Wq6/QKhgdEdgbLSi9rBTAcPoRa6JpiG4ksg==} dependencies: layout-base: 1.0.2 dev: false - /cross-spawn/5.1.0: - resolution: {integrity: sha512-pTgQJ5KC0d2hcY8eyL1IzlBPYjTkyH72XRZPnLyKus2mBfNjQs3klqbJU2VILqZryAZUt9JOb3h/mWMy23/f5A==} + /cose-base/2.2.0: + resolution: {integrity: sha512-AzlgcsCbUMymkADOJtQm3wO9S3ltPfYOFD5033keQn9NJzIbtnZj+UdBJe7DYml/8TdbtHJW3j58SOnKhWY/5g==} dependencies: - lru-cache: 4.1.5 - shebang-command: 1.2.0 - which: 1.3.1 + layout-base: 2.0.1 dev: false /cross-spawn/7.0.6: @@ -2167,7 +2644,6 @@ packages: path-key: 3.1.1 shebang-command: 2.0.0 which: 2.0.2 - dev: true /cssesc/3.0.0: resolution: {integrity: sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==} @@ -2177,7 +2653,7 @@ packages: /csstype/3.1.3: resolution: {integrity: sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==} - dev: false + dev: true /cytoscape-cose-bilkent/4.1.0_cytoscape@3.31.0: resolution: {integrity: sha512-wgQlVIUJF13Quxiv5e1gstZ08rnZj2XaLHGoFMYXz7SkNfCDOOteKBE6SYRfA9WxxI/iBc3ajfDoc6hb/MRAHQ==} @@ -2188,6 +2664,15 @@ packages: cytoscape: 3.31.0 dev: false + /cytoscape-fcose/2.2.0_cytoscape@3.31.0: + resolution: {integrity: sha512-ki1/VuRIHFCzxWNrsshHYPs6L7TvLu3DL+TyIGEsRcvVERmxokbf5Gdk7mFxZnTdiGtnA4cfSmjZJMviqSuZrQ==} + peerDependencies: + cytoscape: ^3.2.0 + dependencies: + cose-base: 2.2.0 + cytoscape: 3.31.0 + dev: false + /cytoscape/3.31.0: resolution: {integrity: sha512-zDGn1K/tfZwEnoGOcHc0H4XazqAAXAuDpcYw9mUnUjATjqljyCNGJv8uEvbvxGaGHaVshxMecyl6oc6uKzRfbw==} engines: {node: '>=0.10'} @@ -2464,8 +2949,8 @@ packages: d3-zoom: 3.0.0 dev: false - /dagre-d3-es/7.0.10: - resolution: {integrity: sha512-qTCQmEhcynucuaZgY5/+ti3X/rnszKZhEQH/ZdWdtP1tA/y3VoHJzcVrO9pjjJCNpigfscAtoUB5ONcd2wNn0A==} + /dagre-d3-es/7.0.11: + resolution: {integrity: sha512-tvlJLyQf834SylNKax8Wkzco/1ias1OPw8DcUMDE7oUIoSEW25riQVuiu/0OWEFqT0cxHT3Pa9/D82Jr47IONw==} dependencies: d3: 7.9.0 lodash-es: 4.17.21 @@ -2531,17 +3016,14 @@ packages: resolution: {integrity: sha512-gxtyfqMg7GKyhQmb056K7M3xszy/myH8w+B4RT+QXBQsvAOdc3XymqDDPHx1BgPgsdAA5SIifona89YtRATDzw==} dev: true - /diff/5.2.0: - resolution: {integrity: sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==} - engines: {node: '>=0.3.1'} - dev: false - /dlv/1.1.3: resolution: {integrity: sha512-+HlytyjlPKnIG8XuRG8WvmBP8xs8P71y+SKKS6ZXWoEgLuePxtDoUEiH7WkdePWrQ5JBpE6aoVqfZfJUQkjXwA==} dev: true - /dompurify/3.1.6: - resolution: {integrity: sha512-cTOAhc36AalkjtBpfG6O8JimdTMWNXjiePT2xQH/ppBGi/4uIpmj8eKyIkMJErXWARyINV/sB38yf8JCLF5pbQ==} + /dompurify/3.2.3: + resolution: {integrity: sha512-U1U5Hzc2MO0oW3DF+G9qYN0aT7atAou4AgI0XjWz061nyBPbdxkfdhfy5uMgGn6+oLFCfn44ZGbdDqCzVmlOWA==} + optionalDependencies: + '@types/trusted-types': 2.0.7 dev: false /eastasianwidth/0.2.0: @@ -2552,8 +3034,8 @@ packages: resolution: {integrity: sha512-K3C2qf1o+bGzbilTDCTBhTQcMS9KW60yTAaTeeXsfvQuTDDwlokLam/AdqlqcSy9u4UainDgsHV23ksXAOgamw==} dev: true - /elkjs/0.9.3: - resolution: {integrity: sha512-f/ZeWvW/BCXbhGEf1Ujp29EASo/lk1FDnETgNKwJrsVvGZhUWCZyg3xLJjAsxfOmt8KjswHmI5EwCQcPMpOYhQ==} + /emoji-regex-xs/1.0.0: + resolution: {integrity: sha512-LRlerrMYoIDrT6jgpeZ2YYl/L8EulRTt5hQcYjy5AInh7HWXKimpqx68aknBFpGL2+/IcogTcaydJEgaTmOpDg==} dev: false /emoji-regex/8.0.0: @@ -2569,38 +3051,57 @@ packages: engines: {node: '>=0.12'} dev: false + /esast-util-from-estree/2.0.0: + resolution: {integrity: sha512-4CyanoAudUSBAn5K13H4JhsMH6L9ZP7XbLVe/dKybkxMO7eDyLsT8UHl9TRNrU2Gr9nz+FovfSIjuXWJ81uVwQ==} + dependencies: + '@types/estree-jsx': 1.0.5 + devlop: 1.1.0 + estree-util-visit: 2.0.0 + unist-util-position-from-estree: 2.0.0 + dev: false + + /esast-util-from-js/2.0.1: + resolution: {integrity: sha512-8Ja+rNJ0Lt56Pcf3TAmpBZjmx8ZcK5Ts4cAzIOjsjevg9oSXJnl6SUQ2EevU8tv3h6ZLWmoKL5H4fgWvdvfETw==} + dependencies: + '@types/estree-jsx': 1.0.5 + acorn: 8.14.0 + esast-util-from-estree: 2.0.0 + vfile-message: 4.0.2 + dev: false + /escalade/3.2.0: resolution: {integrity: sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==} engines: {node: '>=6'} dev: true - /escape-string-regexp/1.0.5: - resolution: {integrity: sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==} - engines: {node: '>=0.8.0'} - dev: false - /escape-string-regexp/5.0.0: resolution: {integrity: sha512-/veY75JbMK4j1yjvuUxuVsiS/hr/4iHs9FTT6cgTexxdE0Ly/glccBAkloH/DofkjRbZU3bnoj38mOmhkZ0lHw==} engines: {node: '>=12'} dev: false + /esm/3.2.25: + resolution: {integrity: sha512-U1suiZ2oDVWv4zPO56S0NcR5QriEahGtdN2OR6FiOG4WJvcjBVFB0qI4+eKoWFH483PKGuLuu6V8Z4T5g63UVA==} + engines: {node: '>=6'} + dev: false + /esprima/4.0.1: resolution: {integrity: sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==} engines: {node: '>=4'} hasBin: true dev: false - /estree-util-attach-comments/2.1.1: - resolution: {integrity: sha512-+5Ba/xGGS6mnwFbXIuQiDPTbuTxuMCooq3arVv7gPZtYpjp+VXH/NkHAP35OOefPhNG/UGqU3vt/LTABwcHX0w==} + /estree-util-attach-comments/3.0.0: + resolution: {integrity: sha512-cKUwm/HUcTDsYh/9FgnuFqpfquUbwIqwKM26BVCGDPVgvaCl/nDCCjUfiLlx6lsEZ3Z4RFxNbOQ60pkaEwFxGw==} dependencies: '@types/estree': 1.0.6 dev: false - /estree-util-build-jsx/2.2.2: - resolution: {integrity: sha512-m56vOXcOBuaF+Igpb9OPAy7f9w9OIkb5yhjsZuaPm7HoGi4oTOQi0h2+yZ+AtKklYFZ+rPC4n0wYCJCEU1ONqg==} + /estree-util-build-jsx/3.0.1: + resolution: {integrity: sha512-8U5eiL6BTrPxp/CHbs2yMgP8ftMhR5ww1eIKoWRMlqvltHF8fZn5LRDvTKuxD3DUn+shRbLGqXemcP51oFCsGQ==} dependencies: '@types/estree-jsx': 1.0.5 - estree-util-is-identifier-name: 2.1.0 + devlop: 1.1.0 + estree-util-is-identifier-name: 3.0.0 estree-walker: 3.0.3 dev: false @@ -2608,8 +3109,19 @@ packages: resolution: {integrity: sha512-bEN9VHRyXAUOjkKVQVvArFym08BTWB0aJPppZZr0UNyAqWsLaVfAqP7hbaTJjzHifmB5ebnR8Wm7r7yGN/HonQ==} dev: false - /estree-util-to-js/1.2.0: - resolution: {integrity: sha512-IzU74r1PK5IMMGZXUVZbmiu4A1uhiPgW5hm1GjcOfr4ZzHaMPpLNJjR7HjXiIOzi25nZDrgFTobHTkV5Q6ITjA==} + /estree-util-is-identifier-name/3.0.0: + resolution: {integrity: sha512-hFtqIDZTIUZ9BXLb8y4pYGyk6+wekIivNVTcmvk8NoOh+VeRn5y6cEHzbURrWbfp1fIqdVipilzj+lfaadNZmg==} + dev: false + + /estree-util-scope/1.0.0: + resolution: {integrity: sha512-2CAASclonf+JFWBNJPndcOpA8EMJwa0Q8LUFJEKqXLW6+qBvbFZuF5gItbQOs/umBUkjviCSDCbBwU2cXbmrhQ==} + dependencies: + '@types/estree': 1.0.6 + devlop: 1.1.0 + dev: false + + /estree-util-to-js/2.0.0: + resolution: {integrity: sha512-WDF+xj5rRWmD5tj6bIqRi6CkLIXbbNQUcxQHzGysQzvHmdYG2G7p/Tf0J0gpxGgkeMZNTIjT/AoSvC9Xehcgdg==} dependencies: '@types/estree-jsx': 1.0.5 astring: 1.9.0 @@ -2623,11 +3135,17 @@ packages: is-plain-obj: 3.0.0 dev: false - /estree-util-visit/1.2.1: - resolution: {integrity: sha512-xbgqcrkIVbIG+lI/gzbvd9SGTJL4zqJKBFttUl5pP27KhAjtMKbX/mQXJ7qgyXpMgVy/zvpm0xoQQaGL8OloOw==} + /estree-util-value-to-estree/3.2.1: + resolution: {integrity: sha512-Vt2UOjyPbNQQgT5eJh+K5aATti0OjCIAGc9SgMdOFYbohuifsWclR74l0iZTJwePMgWYdX1hlVS+dedH9XV8kw==} + dependencies: + '@types/estree': 1.0.6 + dev: false + + /estree-util-visit/2.0.0: + resolution: {integrity: sha512-m5KgiH85xAhhW8Wta0vShLcUvOsh3LLPI2YVwcbio1l7E09NTLL1EyMZFM1OyWowoH0skScNbhOPl4kcBgzTww==} dependencies: '@types/estree-jsx': 1.0.5 - '@types/unist': 2.0.11 + '@types/unist': 3.0.3 dev: false /estree-walker/3.0.3: @@ -2636,17 +3154,19 @@ packages: '@types/estree': 1.0.6 dev: false - /execa/0.8.0: - resolution: {integrity: sha512-zDWS+Rb1E8BlqqhALSt9kUhss8Qq4nN3iof3gsOdyINksElaPyNBtKUMTR62qhvgVWR0CqCX7sdnKe4MnUbFEA==} - engines: {node: '>=4'} + /execa/8.0.1: + resolution: {integrity: sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg==} + engines: {node: '>=16.17'} dependencies: - cross-spawn: 5.1.0 - get-stream: 3.0.0 - is-stream: 1.1.0 - npm-run-path: 2.0.2 - p-finally: 1.0.0 - signal-exit: 3.0.7 - strip-eof: 1.0.0 + cross-spawn: 7.0.6 + get-stream: 8.0.1 + human-signals: 5.0.0 + is-stream: 3.0.0 + merge-stream: 2.0.0 + npm-run-path: 5.3.0 + onetime: 6.0.0 + signal-exit: 4.1.0 + strip-final-newline: 3.0.0 dev: false /extend-shallow/2.0.1: @@ -2681,6 +3201,12 @@ packages: reusify: 1.0.4 dev: true + /fault/2.0.1: + resolution: {integrity: sha512-WtySTkS4OKev5JtpHXnib4Gxiurzh5NCGvWrFaZ34m6JehfTUhKZvn9njTfw48t6JumVQOmrKqpmGcdwxnhqBQ==} + dependencies: + format: 0.2.2 + dev: false + /fill-range/7.1.1: resolution: {integrity: sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==} engines: {node: '>=8'} @@ -2692,10 +3218,6 @@ packages: resolution: {integrity: sha512-c5o/+Um8aqCSOXGcZoqZOm+NqtVwNsvVpWv6lfmSclU954O3wvQKxxK8zj74fPaSJbXpSLTs4PRhh+wnoCXnKg==} dev: false - /focus-visible/5.2.1: - resolution: {integrity: sha512-8Bx950VD1bWTQJEH/AM6SpEk+SU55aVnp4Ujhuuxy3eMEBCRwBnTBnVXr9YAPvZL3/CNjCa8u4IWfNmEO53whA==} - dev: false - /foreground-child/3.3.0: resolution: {integrity: sha512-Ld2g8rrAyMYFXBhEqMz8ZAHBi4J4uS1i/CxGMDnjyFWddMXLVcDp051DZfu+t7+ab7Wv6SMqpWmyFIj5UbfFvg==} engines: {node: '>=14'} @@ -2704,6 +3226,11 @@ packages: signal-exit: 4.1.0 dev: true + /format/0.2.2: + resolution: {integrity: sha512-wzsgA6WOq+09wrU1tsJ09udeR/YZRaeArL9e1wPbFg3GG2yDnC2ldKpxs4xunpFF9DgqCqOIra3bc1HWrJ37Ww==} + engines: {node: '>=0.4.x'} + dev: false + /fraction.js/4.3.7: resolution: {integrity: sha512-ZsDfxO51wGAXREY55a7la9LScWpwv9RxIrYABrlvOFBlH/ShPnrtsXeuUIfXKKOVicNxQ+o8JTbJvjS4M89yew==} dev: true @@ -2724,22 +3251,9 @@ packages: engines: {node: '>=6'} dev: false - /get-stream/3.0.0: - resolution: {integrity: sha512-GlhdIUuVakc8SJ6kK0zAFbiGzRFzNnY4jUuEbV9UROo4Y+0Ny4fjvcZFVTeDA4odpFyOQzaw6hXukJSq/f28sQ==} - engines: {node: '>=4'} - dev: false - - /git-up/7.0.0: - resolution: {integrity: sha512-ONdIrbBCFusq1Oy0sC71F5azx8bVkvtZtMJAsv+a6lz5YAmbNnLD6HAB4gptHZVLPR8S2/kVN6Gab7lryq5+lQ==} - dependencies: - is-ssh: 1.4.0 - parse-url: 8.1.0 - dev: false - - /git-url-parse/13.1.1: - resolution: {integrity: sha512-PCFJyeSSdtnbfhSNRw9Wk96dDCNx+sogTe4YNXeXSJxt7xz5hvXekuRn9JX7m+Mf4OscCu8h+mtAl3+h5Fo8lQ==} - dependencies: - git-up: 7.0.0 + /get-stream/8.0.1: + resolution: {integrity: sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA==} + engines: {node: '>=16'} dev: false /github-slugger/2.0.0: @@ -2776,6 +3290,11 @@ packages: path-scurry: 1.11.1 dev: true + /globals/15.14.0: + resolution: {integrity: sha512-OkToC372DtlQeje9/zHIo5CT8lRP/FUgEOKBEhU4e0abL7J7CD24fD9ohiLN5hagG/kWCYj4K5oaxxtj2Z0Dig==} + engines: {node: '>=18'} + dev: false + /graceful-fs/4.2.11: resolution: {integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==} dev: false @@ -2790,18 +3309,8 @@ packages: strip-bom-string: 1.0.0 dev: false - /has-flag/2.0.0: - resolution: {integrity: sha512-P+1n3MnwjR/Epg9BBo1KT8qbye2g2Ou4sFumihwt6I4tsUX7jnLcX4BTOSKg/B1ZrIYMN9FcEnG4x5a7NB8Eng==} - engines: {node: '>=0.10.0'} - dev: false - - /hash-obj/4.0.0: - resolution: {integrity: sha512-FwO1BUVWkyHasWDW4S8o0ssQXjvyghLV2rfVhnN36b2bbcj45eGiuzdn9XOvOpjV3TKQD7Gm2BWNXdE9V4KKYg==} - engines: {node: '>=12'} - dependencies: - is-obj: 3.0.0 - sort-keys: 5.1.0 - type-fest: 1.4.0 + /hachure-fill/0.5.2: + resolution: {integrity: sha512-3GKBOn+m2LX9iq+JC1064cSFprJY4jL1jCXTcpnfER5HYE2l/4EfWSGzkPa/ZDBmYI0ZOEj5VHV/eKnPGkHuOg==} dev: false /hasown/2.0.2: @@ -2882,24 +3391,63 @@ packages: zwitch: 2.0.4 dev: false - /hast-util-to-estree/2.3.3: - resolution: {integrity: sha512-ihhPIUPxN0v0w6M5+IiAZZrn0LH2uZomeWwhn7uP7avZC6TE7lIiEh2yBMPr5+zi1aUCXq6VoYRgs2Bw9xmycQ==} + /hast-util-to-estree/3.1.1: + resolution: {integrity: sha512-IWtwwmPskfSmma9RpzCappDUitC8t5jhAynHhc1m2+5trOgsrp7txscUSavc5Ic8PATyAjfrCK1wgtxh2cICVQ==} dependencies: '@types/estree': 1.0.6 '@types/estree-jsx': 1.0.5 - '@types/hast': 2.3.10 - '@types/unist': 2.0.11 + '@types/hast': 3.0.4 comma-separated-tokens: 2.0.3 - estree-util-attach-comments: 2.1.1 - estree-util-is-identifier-name: 2.1.0 - hast-util-whitespace: 2.0.1 - mdast-util-mdx-expression: 1.3.2 - mdast-util-mdxjs-esm: 1.3.1 + devlop: 1.1.0 + estree-util-attach-comments: 3.0.0 + estree-util-is-identifier-name: 3.0.0 + hast-util-whitespace: 3.0.0 + mdast-util-mdx-expression: 2.0.1 + mdast-util-mdx-jsx: 3.2.0 + mdast-util-mdxjs-esm: 2.0.1 + property-information: 6.5.0 + space-separated-tokens: 2.0.2 + style-to-object: 1.0.8 + unist-util-position: 5.0.0 + zwitch: 2.0.4 + transitivePeerDependencies: + - supports-color + dev: false + + /hast-util-to-html/9.0.4: + resolution: {integrity: sha512-wxQzXtdbhiwGAUKrnQJXlOPmHnEehzphwkK7aluUPQ+lEc1xefC8pblMgpp2w5ldBTEfveRIrADcrhGIWrlTDA==} + dependencies: + '@types/hast': 3.0.4 + '@types/unist': 3.0.3 + ccount: 2.0.1 + comma-separated-tokens: 2.0.3 + hast-util-whitespace: 3.0.0 + html-void-elements: 3.0.0 + mdast-util-to-hast: 13.2.0 property-information: 6.5.0 space-separated-tokens: 2.0.2 - style-to-object: 0.4.4 - unist-util-position: 4.0.4 + stringify-entities: 4.0.4 zwitch: 2.0.4 + dev: false + + /hast-util-to-jsx-runtime/2.3.2: + resolution: {integrity: sha512-1ngXYb+V9UT5h+PxNRa1O1FYguZK/XL+gkeqvp7EdHlB9oHUG0eYRo/vY5inBdcqo3RkPMC58/H94HvkbfGdyg==} + dependencies: + '@types/estree': 1.0.6 + '@types/hast': 3.0.4 + '@types/unist': 3.0.3 + comma-separated-tokens: 2.0.3 + devlop: 1.1.0 + estree-util-is-identifier-name: 3.0.0 + hast-util-whitespace: 3.0.0 + mdast-util-mdx-expression: 2.0.1 + mdast-util-mdx-jsx: 3.2.0 + mdast-util-mdxjs-esm: 2.0.1 + property-information: 6.5.0 + space-separated-tokens: 2.0.2 + style-to-object: 1.0.8 + unist-util-position: 5.0.0 + vfile-message: 4.0.2 transitivePeerDependencies: - supports-color dev: false @@ -2916,6 +3464,12 @@ packages: zwitch: 2.0.4 dev: false + /hast-util-to-string/3.0.1: + resolution: {integrity: sha512-XelQVTDWvqcl3axRfI0xSeoVKzyIFPwsAGSLIsKdJKQMXDYJS4WYrBNF/8J7RdhIcFI2BOHgAifggsvsxp/3+A==} + dependencies: + '@types/hast': 3.0.4 + dev: false + /hast-util-to-text/4.0.2: resolution: {integrity: sha512-KK6y/BN8lbaq654j7JgBydev7wuNMcID54lkRav1P0CaE1e47P72AWWPiGKXTJU271ooYzcvTAn/Zt0REnvc7A==} dependencies: @@ -2925,8 +3479,10 @@ packages: unist-util-find-after: 5.0.0 dev: false - /hast-util-whitespace/2.0.1: - resolution: {integrity: sha512-nAxA0v8+vXSBDt3AnRUNjyRIQ0rD+ntpbAp4LnPkumc5M9yUbSMa4XDU9Q6etY4f1Wp4bNgvc1yjiZtsTTrSng==} + /hast-util-whitespace/3.0.0: + resolution: {integrity: sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==} + dependencies: + '@types/hast': 3.0.4 dev: false /hastscript/9.0.0: @@ -2943,6 +3499,11 @@ packages: resolution: {integrity: sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==} dev: false + /human-signals/5.0.0: + resolution: {integrity: sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==} + engines: {node: '>=16.17.0'} + dev: false + /iconv-lite/0.6.3: resolution: {integrity: sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==} engines: {node: '>=0.10.0'} @@ -2950,8 +3511,8 @@ packages: safer-buffer: 2.1.2 dev: false - /inline-style-parser/0.1.1: - resolution: {integrity: sha512-7NXolsK4CAS5+xvdj5OMMbI962hU/wvwoxk+LWR9Ek9bVtyuuYScDN6eS0rUm6TxApFpw7CX1o4uJzcd4AyD3Q==} + /inline-style-parser/0.2.4: + resolution: {integrity: sha512-0aO8FkhNZlj/ZIbNi7Lxxr12obT7cL1moPfE4tg1LkX7LlLfC6DeX4l2ZEud1ukP9jNQyNnfzQVqwbwmAATY4Q==} dev: false /internmap/1.0.1: @@ -2963,10 +3524,6 @@ packages: engines: {node: '>=12'} dev: false - /intersection-observer/0.12.2: - resolution: {integrity: sha512-7m1vEcPCxXYI8HqnL8CKI6siDyD+eIWSwgB3DZA+ZTogxk9I4CDnj4wilt9x/+/QbHI4YG5YZNmC6458/e9Ktg==} - dev: false - /is-alphabetical/2.0.1: resolution: {integrity: sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==} dev: false @@ -2985,11 +3542,6 @@ packages: binary-extensions: 2.3.0 dev: true - /is-buffer/2.0.5: - resolution: {integrity: sha512-i2R6zNFDwgEHJyQUtJEk0XFi1i0dPFn/oqjK3/vPCcDeJvW5NQ83V8QbicfF1SupOaB0h8ntgBC2YiE7dfyctQ==} - engines: {node: '>=4'} - dev: false - /is-core-module/2.16.1: resolution: {integrity: sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==} engines: {node: '>= 0.4'} @@ -3001,6 +3553,12 @@ packages: resolution: {integrity: sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==} dev: false + /is-docker/3.0.0: + resolution: {integrity: sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + hasBin: true + dev: false + /is-extendable/0.1.1: resolution: {integrity: sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==} engines: {node: '>=0.10.0'} @@ -3027,16 +3585,19 @@ packages: resolution: {integrity: sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==} dev: false + /is-inside-container/1.0.0: + resolution: {integrity: sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA==} + engines: {node: '>=14.16'} + hasBin: true + dependencies: + is-docker: 3.0.0 + dev: false + /is-number/7.0.0: resolution: {integrity: sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==} engines: {node: '>=0.12.0'} dev: true - /is-obj/3.0.0: - resolution: {integrity: sha512-IlsXEHOjtKhpN8r/tRFj2nDyTmHvcfNeu/nrRIcXE17ROeatXchkojffa1SpdqW4cr/Fj6QkEf/Gn4zf6KKvEQ==} - engines: {node: '>=12'} - dev: false - /is-plain-obj/3.0.0: resolution: {integrity: sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==} engines: {node: '>=10'} @@ -3047,21 +3608,23 @@ packages: engines: {node: '>=12'} dev: false - /is-reference/3.0.3: - resolution: {integrity: sha512-ixkJoqQvAP88E6wLydLGGqCJsrFUnqoH6HnaczB8XmDH1oaWU+xxdptvikTgaEhtZ53Ky6YXiBuUI2WXLMCwjw==} - dependencies: - '@types/estree': 1.0.6 + /is-stream/3.0.0: + resolution: {integrity: sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} dev: false - /is-ssh/1.4.0: - resolution: {integrity: sha512-x7+VxdxOdlV3CYpjvRLBv5Lo9OJerlYanjwFrPR9fuGPjCiNiCzFgAWpiLAohSbsnH4ZAys3SBh+hq5rJosxUQ==} + /is-wsl/3.1.0: + resolution: {integrity: sha512-UcVfVfaK4Sc4m7X3dUSoHoozQGBEFeDC+zVo06t98xe8CzHSZZBekNXH+tu0NalHolcJ/QAGqS46Hef7QXBIMw==} + engines: {node: '>=16'} dependencies: - protocols: 2.0.1 + is-inside-container: 1.0.0 dev: false - /is-stream/1.1.0: - resolution: {integrity: sha512-uQPm8kcs47jx38atAcWTVxyltQYoPT68y9aWYdV6yWXSyW8mzSat0TL6CiWdZeCdF3KrAvpVtnHbTv4RN+rqdQ==} - engines: {node: '>=0.10.0'} + /is64bit/2.0.0: + resolution: {integrity: sha512-jv+8jaWCl0g2lSBkNSVXdzfBA0npK1HGC2KtWM9FumFRoGS94g3NbCCLVnCYHLjp4GrW2KZeeSTMo5ddtznmGw==} + engines: {node: '>=18'} + dependencies: + system-architecture: 0.1.0 dev: false /isexe/2.0.0: @@ -3092,17 +3655,6 @@ packages: esprima: 4.0.1 dev: false - /js-yaml/4.1.0: - resolution: {integrity: sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==} - hasBin: true - dependencies: - argparse: 2.0.1 - dev: false - - /jsonc-parser/3.3.1: - resolution: {integrity: sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==} - dev: false - /katex/0.16.21: resolution: {integrity: sha512-XvqR7FgOHtWupfMiigNzmh+MgUVmDGU2kXZm899ZkPfcuoPuFxyHmXsgATDpFZDAXCI8tvinaVcDo8PIIJSo4A==} hasBin: true @@ -3119,15 +3671,29 @@ packages: engines: {node: '>=0.10.0'} dev: false - /kleur/4.1.5: - resolution: {integrity: sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==} - engines: {node: '>=6'} + /kolorist/1.8.0: + resolution: {integrity: sha512-Y+60/zizpJ3HRH8DCss+q95yr6145JXZo46OTpFvDZWLfRCE4qChOyk1b26nMaNpfHHgxagk9dXT5OP0Tfe+dQ==} + dev: false + + /langium/3.0.0: + resolution: {integrity: sha512-+Ez9EoiByeoTu/2BXmEaZ06iPNXM6thWJp02KfBO/raSMyCJ4jw7AkWWa+zBCTm0+Tw1Fj9FOxdqSskyN5nAwg==} + engines: {node: '>=16.0.0'} + dependencies: + chevrotain: 11.0.3 + chevrotain-allstar: 0.3.1_chevrotain@11.0.3 + vscode-languageserver: 9.0.1 + vscode-languageserver-textdocument: 1.0.12 + vscode-uri: 3.0.8 dev: false /layout-base/1.0.2: resolution: {integrity: sha512-8h2oVEZNktL4BH2JCOI90iD1yXwL6iNW7KcCKT2QZgQJR2vbqDsldCTPRU9NifTCqHZci57XvQQ15YTu+sTYPg==} dev: false + /layout-base/2.0.1: + resolution: {integrity: sha512-dp3s92+uNI1hWIpPGH3jK2kxE2lMjdXdr+DH8ynZHpd6PUlH6x6cbuXnoMmiNumznqaNO31xu9e79F0uuZ0JFg==} + dev: false + /lilconfig/3.1.3: resolution: {integrity: sha512-/vlFKAoH5Cgt3Ie+JLhRbwOsCQePABiU3tJ1egGvyQ+33R/vcwM2Zl2QR/LzjsBeItPt3oSVXapn+m4nQDvpzw==} engines: {node: '>=14'} @@ -3137,17 +3703,26 @@ packages: resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} dev: true + /linkify-it/5.0.0: + resolution: {integrity: sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==} + dependencies: + uc.micro: 2.1.0 + dev: false + /load-script/1.0.0: resolution: {integrity: sha512-kPEjMFtZvwL9TaZo0uZ2ml+Ye9HUMmPwbYRJ324qF9tqMejwykJ5ggTyvzmrbBeapCAbk98BSbTeovHEEP1uCA==} dev: false - /lodash-es/4.17.21: - resolution: {integrity: sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw==} + /local-pkg/0.5.1: + resolution: {integrity: sha512-9rrA30MRRP3gBD3HTGnC6cDFpaE1kVDWxWgqWJUN0RvDNAo+Nz/9GxB+nHOH0ifbVFy0hSA1V6vFDvnx54lTEQ==} + engines: {node: '>=14'} + dependencies: + mlly: 1.7.4 + pkg-types: 1.3.1 dev: false - /lodash.get/4.4.2: - resolution: {integrity: sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==} - deprecated: This package is deprecated. Use the optional chaining (?.) operator instead. + /lodash-es/4.17.21: + resolution: {integrity: sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw==} dev: false /longest-streak/3.1.0: @@ -3165,13 +3740,6 @@ packages: resolution: {integrity: sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==} dev: true - /lru-cache/4.1.5: - resolution: {integrity: sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==} - dependencies: - pseudomap: 1.0.2 - yallist: 2.1.2 - dev: false - /lucide-react/0.279.0_react@18.3.1: resolution: {integrity: sha512-LJ8g66+Bxc3t3x9vKTeK3wn3xucrOQGfJ9ou9GsBwCt2offsrT2BB90XrTrIzE1noYYDe2O8jZaRHi6sAHXNxw==} peerDependencies: @@ -3180,195 +3748,232 @@ packages: react: 18.3.1 dev: false - /markdown-extensions/1.1.1: - resolution: {integrity: sha512-WWC0ZuMzCyDHYCasEGs4IPvLyTGftYwh6wIEOULOF0HXcqZlhwRzrK0w2VUlxWA98xnvb/jszw4ZSkJ6ADpM6Q==} - engines: {node: '>=0.10.0'} + /lunr/2.3.9: + resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==} + dev: false + + /markdown-extensions/2.0.0: + resolution: {integrity: sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==} + engines: {node: '>=16'} + dev: false + + /markdown-it/14.1.0: + resolution: {integrity: sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==} + hasBin: true + dependencies: + argparse: 2.0.1 + entities: 4.5.0 + linkify-it: 5.0.0 + mdurl: 2.0.0 + punycode.js: 2.3.1 + uc.micro: 2.1.0 dev: false /markdown-table/3.0.4: resolution: {integrity: sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw==} dev: false - /match-sorter/6.3.4: - resolution: {integrity: sha512-jfZW7cWS5y/1xswZo8VBOdudUiSd9nifYRWphc9M5D/ee4w4AoXLgBEdRbgVaxbMuagBPeUC5y2Hi8DO6o9aDg==} - dependencies: - '@babel/runtime': 7.26.7 - remove-accents: 0.5.0 + /marked/13.0.3: + resolution: {integrity: sha512-rqRix3/TWzE9rIoFGIn8JmsVfhiuC8VIQ8IdX5TfzmeBucdY05/0UlzKaw0eVtpcN/OdVFpBk7CjKGo9iHJ/zA==} + engines: {node: '>= 18'} + hasBin: true dev: false - /mdast-util-definitions/5.1.2: - resolution: {integrity: sha512-8SVPMuHqlPME/z3gqVwWY4zVXn8lqKv/pAhC57FuJ40ImXyBpmO5ukh98zB2v7Blql2FiHjHv9LVztSIqjY+MA==} + /mathjax-full/3.2.2: + resolution: {integrity: sha512-+LfG9Fik+OuI8SLwsiR02IVdjcnRCy5MufYLi0C3TdMT56L/pjB0alMVGgoWJF8pN9Rc7FESycZB9BMNWIid5w==} dependencies: - '@types/mdast': 3.0.15 - '@types/unist': 2.0.11 - unist-util-visit: 4.1.2 + esm: 3.2.25 + mhchemparser: 4.2.1 + mj-context-menu: 0.6.1 + speech-rule-engine: 4.0.7 dev: false - /mdast-util-find-and-replace/2.2.2: - resolution: {integrity: sha512-MTtdFRz/eMDHXzeK6W3dO7mXUlF82Gom4y0oOgvHhh/HXZAGvIQDUvQ0SuUx+j2tv44b8xTHOm8K/9OoRFnXKw==} + /mdast-util-find-and-replace/3.0.2: + resolution: {integrity: sha512-Tmd1Vg/m3Xz43afeNxDIhWRtFZgM2VLyaf4vSTYwudTyeuTneoL3qtWMA5jeLyz/O1vDJmmV4QuScFCA2tBPwg==} dependencies: - '@types/mdast': 3.0.15 + '@types/mdast': 4.0.4 escape-string-regexp: 5.0.0 - unist-util-is: 5.2.1 - unist-util-visit-parents: 5.1.3 + unist-util-is: 6.0.0 + unist-util-visit-parents: 6.0.1 dev: false - /mdast-util-from-markdown/1.3.1: - resolution: {integrity: sha512-4xTO/M8c82qBcnQc1tgpNtubGUW/Y1tBQ1B0i5CtSoelOLKFYlElIr3bvgREYYO5iRqbMY1YuqZng0GVOI8Qww==} + /mdast-util-from-markdown/2.0.2: + resolution: {integrity: sha512-uZhTV/8NBuw0WHkPTrCqDOl0zVe1BIng5ZtHoDk49ME1qqcjYmmLmOf0gELgcRMxN4w2iuIeVso5/6QymSrgmA==} dependencies: - '@types/mdast': 3.0.15 - '@types/unist': 2.0.11 + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 decode-named-character-reference: 1.0.2 - mdast-util-to-string: 3.2.0 - micromark: 3.2.0 - micromark-util-decode-numeric-character-reference: 1.1.0 - micromark-util-decode-string: 1.1.0 - micromark-util-normalize-identifier: 1.1.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - unist-util-stringify-position: 3.0.3 - uvu: 0.5.6 + devlop: 1.1.0 + mdast-util-to-string: 4.0.0 + micromark: 4.0.1 + micromark-util-decode-numeric-character-reference: 2.0.2 + micromark-util-decode-string: 2.0.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 + unist-util-stringify-position: 4.0.0 + transitivePeerDependencies: + - supports-color + dev: false + + /mdast-util-frontmatter/2.0.1: + resolution: {integrity: sha512-LRqI9+wdgC25P0URIJY9vwocIzCcksduHQ9OF2joxQoyTNVduwLAFUzjoopuRJbJAReaKrNQKAZKL3uCMugWJA==} + dependencies: + '@types/mdast': 4.0.4 + devlop: 1.1.0 + escape-string-regexp: 5.0.0 + mdast-util-from-markdown: 2.0.2 + mdast-util-to-markdown: 2.1.2 + micromark-extension-frontmatter: 2.0.0 transitivePeerDependencies: - supports-color dev: false - /mdast-util-gfm-autolink-literal/1.0.3: - resolution: {integrity: sha512-My8KJ57FYEy2W2LyNom4n3E7hKTuQk/0SES0u16tjA9Z3oFkF4RrC/hPAPgjlSpezsOvI8ObcXcElo92wn5IGA==} + /mdast-util-gfm-autolink-literal/2.0.1: + resolution: {integrity: sha512-5HVP2MKaP6L+G6YaxPNjuL0BPrq9orG3TsrZ9YXbA3vDw/ACI4MEsnoDpn6ZNm7GnZgtAcONJyPhOP8tNJQavQ==} dependencies: - '@types/mdast': 3.0.15 + '@types/mdast': 4.0.4 ccount: 2.0.1 - mdast-util-find-and-replace: 2.2.2 - micromark-util-character: 1.2.0 + devlop: 1.1.0 + mdast-util-find-and-replace: 3.0.2 + micromark-util-character: 2.1.1 dev: false - /mdast-util-gfm-footnote/1.0.2: - resolution: {integrity: sha512-56D19KOGbE00uKVj3sgIykpwKL179QsVFwx/DCW0u/0+URsryacI4MAdNJl0dh+u2PSsD9FtxPFbHCzJ78qJFQ==} + /mdast-util-gfm-footnote/2.0.0: + resolution: {integrity: sha512-5jOT2boTSVkMnQ7LTrd6n/18kqwjmuYqo7JUPe+tRCY6O7dAuTFMtTPauYYrMPpox9hlN0uOx/FL8XvEfG9/mQ==} dependencies: - '@types/mdast': 3.0.15 - mdast-util-to-markdown: 1.5.0 - micromark-util-normalize-identifier: 1.1.0 + '@types/mdast': 4.0.4 + devlop: 1.1.0 + mdast-util-from-markdown: 2.0.2 + mdast-util-to-markdown: 2.1.2 + micromark-util-normalize-identifier: 2.0.1 + transitivePeerDependencies: + - supports-color dev: false - /mdast-util-gfm-strikethrough/1.0.3: - resolution: {integrity: sha512-DAPhYzTYrRcXdMjUtUjKvW9z/FNAMTdU0ORyMcbmkwYNbKocDpdk+PX1L1dQgOID/+vVs1uBQ7ElrBQfZ0cuiQ==} + /mdast-util-gfm-strikethrough/2.0.0: + resolution: {integrity: sha512-mKKb915TF+OC5ptj5bJ7WFRPdYtuHv0yTRxK2tJvi+BDqbkiG7h7u/9SI89nRAYcmap2xHQL9D+QG/6wSrTtXg==} dependencies: - '@types/mdast': 3.0.15 - mdast-util-to-markdown: 1.5.0 + '@types/mdast': 4.0.4 + mdast-util-from-markdown: 2.0.2 + mdast-util-to-markdown: 2.1.2 + transitivePeerDependencies: + - supports-color dev: false - /mdast-util-gfm-table/1.0.7: - resolution: {integrity: sha512-jjcpmNnQvrmN5Vx7y7lEc2iIOEytYv7rTvu+MeyAsSHTASGCCRA79Igg2uKssgOs1i1po8s3plW0sTu1wkkLGg==} + /mdast-util-gfm-table/2.0.0: + resolution: {integrity: sha512-78UEvebzz/rJIxLvE7ZtDd/vIQ0RHv+3Mh5DR96p7cS7HsBhYIICDBCu8csTNWNO6tBWfqXPWekRuj2FNOGOZg==} dependencies: - '@types/mdast': 3.0.15 + '@types/mdast': 4.0.4 + devlop: 1.1.0 markdown-table: 3.0.4 - mdast-util-from-markdown: 1.3.1 - mdast-util-to-markdown: 1.5.0 + mdast-util-from-markdown: 2.0.2 + mdast-util-to-markdown: 2.1.2 transitivePeerDependencies: - supports-color dev: false - /mdast-util-gfm-task-list-item/1.0.2: - resolution: {integrity: sha512-PFTA1gzfp1B1UaiJVyhJZA1rm0+Tzn690frc/L8vNX1Jop4STZgOE6bxUhnzdVSB+vm2GU1tIsuQcA9bxTQpMQ==} + /mdast-util-gfm-task-list-item/2.0.0: + resolution: {integrity: sha512-IrtvNvjxC1o06taBAVJznEnkiHxLFTzgonUdy8hzFVeDun0uTjxxrRGVaNFqkU1wJR3RBPEfsxmU6jDWPofrTQ==} dependencies: - '@types/mdast': 3.0.15 - mdast-util-to-markdown: 1.5.0 + '@types/mdast': 4.0.4 + devlop: 1.1.0 + mdast-util-from-markdown: 2.0.2 + mdast-util-to-markdown: 2.1.2 + transitivePeerDependencies: + - supports-color dev: false - /mdast-util-gfm/2.0.2: - resolution: {integrity: sha512-qvZ608nBppZ4icQlhQQIAdc6S3Ffj9RGmzwUKUWuEICFnd1LVkN3EktF7ZHAgfcEdvZB5owU9tQgt99e2TlLjg==} + /mdast-util-gfm/3.0.0: + resolution: {integrity: sha512-dgQEX5Amaq+DuUqf26jJqSK9qgixgd6rYDHAv4aTBuA92cTknZlKpPfa86Z/s8Dj8xsAQpFfBmPUHWJBWqS4Bw==} dependencies: - mdast-util-from-markdown: 1.3.1 - mdast-util-gfm-autolink-literal: 1.0.3 - mdast-util-gfm-footnote: 1.0.2 - mdast-util-gfm-strikethrough: 1.0.3 - mdast-util-gfm-table: 1.0.7 - mdast-util-gfm-task-list-item: 1.0.2 - mdast-util-to-markdown: 1.5.0 + mdast-util-from-markdown: 2.0.2 + mdast-util-gfm-autolink-literal: 2.0.1 + mdast-util-gfm-footnote: 2.0.0 + mdast-util-gfm-strikethrough: 2.0.0 + mdast-util-gfm-table: 2.0.0 + mdast-util-gfm-task-list-item: 2.0.0 + mdast-util-to-markdown: 2.1.2 transitivePeerDependencies: - supports-color dev: false - /mdast-util-math/2.0.2: - resolution: {integrity: sha512-8gmkKVp9v6+Tgjtq6SYx9kGPpTf6FVYRa53/DLh479aldR9AyP48qeVOgNZ5X7QUK7nOy4yw7vg6mbiGcs9jWQ==} + /mdast-util-math/3.0.0: + resolution: {integrity: sha512-Tl9GBNeG/AhJnQM221bJR2HPvLOSnLE/T9cJI9tlc6zwQk2nPk/4f0cHkOdEixQPC/j8UtKDdITswvLAy1OZ1w==} dependencies: - '@types/mdast': 3.0.15 + '@types/hast': 3.0.4 + '@types/mdast': 4.0.4 + devlop: 1.1.0 longest-streak: 3.1.0 - mdast-util-to-markdown: 1.5.0 + mdast-util-from-markdown: 2.0.2 + mdast-util-to-markdown: 2.1.2 + unist-util-remove-position: 5.0.0 + transitivePeerDependencies: + - supports-color dev: false - /mdast-util-mdx-expression/1.3.2: - resolution: {integrity: sha512-xIPmR5ReJDu/DHH1OoIT1HkuybIfRGYRywC+gJtI7qHjCJp/M9jrmBEJW22O8lskDWm562BX2W8TiAwRTb0rKA==} + /mdast-util-mdx-expression/2.0.1: + resolution: {integrity: sha512-J6f+9hUp+ldTZqKRSg7Vw5V6MqjATc+3E4gf3CFNcuZNWD8XdyI6zQ8GqH7f8169MM6P7hMBRDVGnn7oHB9kXQ==} dependencies: '@types/estree-jsx': 1.0.5 - '@types/hast': 2.3.10 - '@types/mdast': 3.0.15 - mdast-util-from-markdown: 1.3.1 - mdast-util-to-markdown: 1.5.0 + '@types/hast': 3.0.4 + '@types/mdast': 4.0.4 + devlop: 1.1.0 + mdast-util-from-markdown: 2.0.2 + mdast-util-to-markdown: 2.1.2 transitivePeerDependencies: - supports-color dev: false - /mdast-util-mdx-jsx/2.1.4: - resolution: {integrity: sha512-DtMn9CmVhVzZx3f+optVDF8yFgQVt7FghCRNdlIaS3X5Bnym3hZwPbg/XW86vdpKjlc1PVj26SpnLGeJBXD3JA==} + /mdast-util-mdx-jsx/3.2.0: + resolution: {integrity: sha512-lj/z8v0r6ZtsN/cGNNtemmmfoLAFZnjMbNyLzBafjzikOM+glrjNHPlf6lQDOTccj9n5b0PPihEBbhneMyGs1Q==} dependencies: '@types/estree-jsx': 1.0.5 - '@types/hast': 2.3.10 - '@types/mdast': 3.0.15 - '@types/unist': 2.0.11 + '@types/hast': 3.0.4 + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 ccount: 2.0.1 - mdast-util-from-markdown: 1.3.1 - mdast-util-to-markdown: 1.5.0 + devlop: 1.1.0 + mdast-util-from-markdown: 2.0.2 + mdast-util-to-markdown: 2.1.2 parse-entities: 4.0.2 stringify-entities: 4.0.4 - unist-util-remove-position: 4.0.2 - unist-util-stringify-position: 3.0.3 - vfile-message: 3.1.4 + unist-util-stringify-position: 4.0.0 + vfile-message: 4.0.2 transitivePeerDependencies: - supports-color dev: false - /mdast-util-mdx/2.0.1: - resolution: {integrity: sha512-38w5y+r8nyKlGvNjSEqWrhG0w5PmnRA+wnBvm+ulYCct7nsGYhFVb0lljS9bQav4psDAS1eGkP2LMVcZBi/aqw==} + /mdast-util-mdx/3.0.0: + resolution: {integrity: sha512-JfbYLAW7XnYTTbUsmpu0kdBUVe+yKVJZBItEjwyYJiDJuZ9w4eeaqks4HQO+R7objWgS2ymV60GYpI14Ug554w==} dependencies: - mdast-util-from-markdown: 1.3.1 - mdast-util-mdx-expression: 1.3.2 - mdast-util-mdx-jsx: 2.1.4 - mdast-util-mdxjs-esm: 1.3.1 - mdast-util-to-markdown: 1.5.0 + mdast-util-from-markdown: 2.0.2 + mdast-util-mdx-expression: 2.0.1 + mdast-util-mdx-jsx: 3.2.0 + mdast-util-mdxjs-esm: 2.0.1 + mdast-util-to-markdown: 2.1.2 transitivePeerDependencies: - supports-color dev: false - /mdast-util-mdxjs-esm/1.3.1: - resolution: {integrity: sha512-SXqglS0HrEvSdUEfoXFtcg7DRl7S2cwOXc7jkuusG472Mmjag34DUDeOJUZtl+BVnyeO1frIgVpHlNRWc2gk/w==} + /mdast-util-mdxjs-esm/2.0.1: + resolution: {integrity: sha512-EcmOpxsZ96CvlP03NghtH1EsLtr0n9Tm4lPUJUBccV9RwUOneqSycg19n5HGzCf+10LozMRSObtVr3ee1WoHtg==} dependencies: '@types/estree-jsx': 1.0.5 - '@types/hast': 2.3.10 - '@types/mdast': 3.0.15 - mdast-util-from-markdown: 1.3.1 - mdast-util-to-markdown: 1.5.0 + '@types/hast': 3.0.4 + '@types/mdast': 4.0.4 + devlop: 1.1.0 + mdast-util-from-markdown: 2.0.2 + mdast-util-to-markdown: 2.1.2 transitivePeerDependencies: - supports-color dev: false - /mdast-util-phrasing/3.0.1: - resolution: {integrity: sha512-WmI1gTXUBJo4/ZmSk79Wcb2HcjPJBzM1nlI/OUWA8yk2X9ik3ffNbBGsU+09BFmXaL1IBb9fiuvq6/KMiNycSg==} - dependencies: - '@types/mdast': 3.0.15 - unist-util-is: 5.2.1 - dev: false - - /mdast-util-to-hast/12.3.0: - resolution: {integrity: sha512-pits93r8PhnIoU4Vy9bjW39M2jJ6/tdHyja9rrot9uujkN7UTU9SDnE6WNJz/IGyQk3XHX6yNNtrBH6cQzm8Hw==} + /mdast-util-phrasing/4.1.0: + resolution: {integrity: sha512-TqICwyvJJpBwvGAMZjj4J2n0X8QWp21b9l0o7eXyVJ25YNWYbJDVIyD1bZXE6WtV6RmKJVYmQAKWa0zWOABz2w==} dependencies: - '@types/hast': 2.3.10 - '@types/mdast': 3.0.15 - mdast-util-definitions: 5.1.2 - micromark-util-sanitize-uri: 1.2.0 - trim-lines: 3.0.1 - unist-util-generated: 2.0.1 - unist-util-position: 4.0.4 - unist-util-visit: 4.1.2 + '@types/mdast': 4.0.4 + unist-util-is: 6.0.0 dev: false /mdast-util-to-hast/13.2.0: @@ -3385,23 +3990,32 @@ packages: vfile: 6.0.3 dev: false - /mdast-util-to-markdown/1.5.0: - resolution: {integrity: sha512-bbv7TPv/WC49thZPg3jXuqzuvI45IL2EVAr/KxF0BSdHsU0ceFHOmwQn6evxAh1GaoK/6GQ1wp4R4oW2+LFL/A==} + /mdast-util-to-markdown/2.1.2: + resolution: {integrity: sha512-xj68wMTvGXVOKonmog6LwyJKrYXZPvlwabaryTjLh9LuvovB/KAH+kvi8Gjj+7rJjsFi23nkUxRQv1KqSroMqA==} dependencies: - '@types/mdast': 3.0.15 - '@types/unist': 2.0.11 + '@types/mdast': 4.0.4 + '@types/unist': 3.0.3 longest-streak: 3.1.0 - mdast-util-phrasing: 3.0.1 - mdast-util-to-string: 3.2.0 - micromark-util-decode-string: 1.1.0 - unist-util-visit: 4.1.2 + mdast-util-phrasing: 4.1.0 + mdast-util-to-string: 4.0.0 + micromark-util-classify-character: 2.0.1 + micromark-util-decode-string: 2.0.1 + unist-util-visit: 5.0.0 zwitch: 2.0.4 dev: false - /mdast-util-to-string/3.2.0: - resolution: {integrity: sha512-V4Zn/ncyN1QNSqSBxTrMOLpjr+IKdHl2v3KVLoWmDPscP4r9GcCi71gjgvUV1SFSKh92AjAG4peFuBl2/YgCJg==} + /mdast-util-to-string/4.0.0: + resolution: {integrity: sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==} dependencies: - '@types/mdast': 3.0.15 + '@types/mdast': 4.0.4 + dev: false + + /mdurl/2.0.0: + resolution: {integrity: sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==} + dev: false + + /merge-stream/2.0.0: + resolution: {integrity: sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==} dev: false /merge2/1.4.1: @@ -3409,259 +4023,267 @@ packages: engines: {node: '>= 8'} dev: true - /mermaid/10.9.3: - resolution: {integrity: sha512-V80X1isSEvAewIL3xhmz/rVmc27CVljcsbWxkxlWJWY/1kQa4XOABqpDl2qQLGKzpKm6WbTfUEKImBlUfFYArw==} + /mermaid/11.4.1: + resolution: {integrity: sha512-Mb01JT/x6CKDWaxigwfZYuYmDZ6xtrNwNlidKZwkSrDaY9n90tdrJTV5Umk+wP1fZscGptmKFXHsXMDEVZ+Q6A==} dependencies: - '@braintree/sanitize-url': 6.0.4 - '@types/d3-scale': 4.0.8 - '@types/d3-scale-chromatic': 3.1.0 + '@braintree/sanitize-url': 7.1.1 + '@iconify/utils': 2.2.1 + '@mermaid-js/parser': 0.3.0 + '@types/d3': 7.4.3 cytoscape: 3.31.0 cytoscape-cose-bilkent: 4.1.0_cytoscape@3.31.0 + cytoscape-fcose: 2.2.0_cytoscape@3.31.0 d3: 7.9.0 d3-sankey: 0.12.3 - dagre-d3-es: 7.0.10 + dagre-d3-es: 7.0.11 dayjs: 1.11.13 - dompurify: 3.1.6 - elkjs: 0.9.3 + dompurify: 3.2.3 katex: 0.16.21 khroma: 2.1.0 lodash-es: 4.17.21 - mdast-util-from-markdown: 1.3.1 - non-layered-tidy-tree-layout: 2.0.2 + marked: 13.0.3 + roughjs: 4.6.6 stylis: 4.3.5 ts-dedent: 2.2.0 uuid: 9.0.1 - web-worker: 1.3.0 transitivePeerDependencies: - supports-color dev: false - /micromark-core-commonmark/1.1.0: - resolution: {integrity: sha512-BgHO1aRbolh2hcrzL2d1La37V0Aoz73ymF8rAcKnohLy93titmv62E0gP8Hrx9PKcKrqCZ1BbLGbP3bEhoXYlw==} + /mhchemparser/4.2.1: + resolution: {integrity: sha512-kYmyrCirqJf3zZ9t/0wGgRZ4/ZJw//VwaRVGA75C4nhE60vtnIzhl9J9ndkX/h6hxSN7pjg/cE0VxbnNM+bnDQ==} + dev: false + + /micromark-core-commonmark/2.0.2: + resolution: {integrity: sha512-FKjQKbxd1cibWMM1P9N+H8TwlgGgSkWZMmfuVucLCHaYqeSvJ0hFeHsIa65pA2nYbes0f8LDHPMrd9X7Ujxg9w==} dependencies: decode-named-character-reference: 1.0.2 - micromark-factory-destination: 1.1.0 - micromark-factory-label: 1.1.0 - micromark-factory-space: 1.1.0 - micromark-factory-title: 1.1.0 - micromark-factory-whitespace: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-chunked: 1.1.0 - micromark-util-classify-character: 1.1.0 - micromark-util-html-tag-name: 1.2.0 - micromark-util-normalize-identifier: 1.1.0 - micromark-util-resolve-all: 1.1.0 - micromark-util-subtokenize: 1.1.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 + devlop: 1.1.0 + micromark-factory-destination: 2.0.1 + micromark-factory-label: 2.0.1 + micromark-factory-space: 2.0.1 + micromark-factory-title: 2.0.1 + micromark-factory-whitespace: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-chunked: 2.0.1 + micromark-util-classify-character: 2.0.1 + micromark-util-html-tag-name: 2.0.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-resolve-all: 2.0.1 + micromark-util-subtokenize: 2.0.4 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-gfm-autolink-literal/1.0.5: - resolution: {integrity: sha512-z3wJSLrDf8kRDOh2qBtoTRD53vJ+CWIyo7uyZuxf/JAbNJjiHsOpG1y5wxk8drtv3ETAHutCu6N3thkOOgueWg==} + /micromark-extension-frontmatter/2.0.0: + resolution: {integrity: sha512-C4AkuM3dA58cgZha7zVnuVxBhDsbttIMiytjgsM2XbHAB2faRVaHRle40558FBN+DJcrLNCoqG5mlrpdU4cRtg==} dependencies: - micromark-util-character: 1.2.0 - micromark-util-sanitize-uri: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 + fault: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 + dev: false + + /micromark-extension-gfm-autolink-literal/2.1.0: + resolution: {integrity: sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw==} + dependencies: + micromark-util-character: 2.1.1 + micromark-util-sanitize-uri: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-gfm-footnote/1.1.2: - resolution: {integrity: sha512-Yxn7z7SxgyGWRNa4wzf8AhYYWNrwl5q1Z8ii+CSTTIqVkmGZF1CElX2JI8g5yGoM3GAman9/PVCUFUSJ0kB/8Q==} + /micromark-extension-gfm-footnote/2.1.0: + resolution: {integrity: sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw==} dependencies: - micromark-core-commonmark: 1.1.0 - micromark-factory-space: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-normalize-identifier: 1.1.0 - micromark-util-sanitize-uri: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 + devlop: 1.1.0 + micromark-core-commonmark: 2.0.2 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-sanitize-uri: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-gfm-strikethrough/1.0.7: - resolution: {integrity: sha512-sX0FawVE1o3abGk3vRjOH50L5TTLr3b5XMqnP9YDRb34M0v5OoZhG+OHFz1OffZ9dlwgpTBKaT4XW/AsUVnSDw==} + /micromark-extension-gfm-strikethrough/2.1.0: + resolution: {integrity: sha512-ADVjpOOkjz1hhkZLlBiYA9cR2Anf8F4HqZUO6e5eDcPQd0Txw5fxLzzxnEkSkfnD0wziSGiv7sYhk/ktvbf1uw==} dependencies: - micromark-util-chunked: 1.1.0 - micromark-util-classify-character: 1.1.0 - micromark-util-resolve-all: 1.1.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 + devlop: 1.1.0 + micromark-util-chunked: 2.0.1 + micromark-util-classify-character: 2.0.1 + micromark-util-resolve-all: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-gfm-table/1.0.7: - resolution: {integrity: sha512-3ZORTHtcSnMQEKtAOsBQ9/oHp9096pI/UvdPtN7ehKvrmZZ2+bbWhi0ln+I9drmwXMt5boocn6OlwQzNXeVeqw==} + /micromark-extension-gfm-table/2.1.1: + resolution: {integrity: sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg==} dependencies: - micromark-factory-space: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 + devlop: 1.1.0 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-gfm-tagfilter/1.0.2: - resolution: {integrity: sha512-5XWB9GbAUSHTn8VPU8/1DBXMuKYT5uOgEjJb8gN3mW0PNW5OPHpSdojoqf+iq1xo7vWzw/P8bAHY0n6ijpXF7g==} + /micromark-extension-gfm-tagfilter/2.0.0: + resolution: {integrity: sha512-xHlTOmuCSotIA8TW1mDIM6X2O1SiX5P9IuDtqGonFhEK0qgRI4yeC6vMxEV2dgyr2TiD+2PQ10o+cOhdVAcwfg==} dependencies: - micromark-util-types: 1.1.0 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-gfm-task-list-item/1.0.5: - resolution: {integrity: sha512-RMFXl2uQ0pNQy6Lun2YBYT9g9INXtWJULgbt01D/x8/6yJ2qpKyzdZD3pi6UIkzF++Da49xAelVKUeUMqd5eIQ==} + /micromark-extension-gfm-task-list-item/2.1.0: + resolution: {integrity: sha512-qIBZhqxqI6fjLDYFTBIa4eivDMnP+OZqsNwmQ3xNLE4Cxwc+zfQEfbs6tzAo2Hjq+bh6q5F+Z8/cksrLFYWQQw==} dependencies: - micromark-factory-space: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 + devlop: 1.1.0 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-gfm/2.0.3: - resolution: {integrity: sha512-vb9OoHqrhCmbRidQv/2+Bc6pkP0FrtlhurxZofvOEy5o8RtuuvTq+RQ1Vw5ZDNrVraQZu3HixESqbG+0iKk/MQ==} + /micromark-extension-gfm/3.0.0: + resolution: {integrity: sha512-vsKArQsicm7t0z2GugkCKtZehqUm31oeGBV/KVSorWSy8ZlNAv7ytjFhvaryUiCUJYqs+NoE6AFhpQvBTM6Q4w==} dependencies: - micromark-extension-gfm-autolink-literal: 1.0.5 - micromark-extension-gfm-footnote: 1.1.2 - micromark-extension-gfm-strikethrough: 1.0.7 - micromark-extension-gfm-table: 1.0.7 - micromark-extension-gfm-tagfilter: 1.0.2 - micromark-extension-gfm-task-list-item: 1.0.5 - micromark-util-combine-extensions: 1.1.0 - micromark-util-types: 1.1.0 + micromark-extension-gfm-autolink-literal: 2.1.0 + micromark-extension-gfm-footnote: 2.1.0 + micromark-extension-gfm-strikethrough: 2.1.0 + micromark-extension-gfm-table: 2.1.1 + micromark-extension-gfm-tagfilter: 2.0.0 + micromark-extension-gfm-task-list-item: 2.1.0 + micromark-util-combine-extensions: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-math/2.1.2: - resolution: {integrity: sha512-es0CcOV89VNS9wFmyn+wyFTKweXGW4CEvdaAca6SWRWPyYCbBisnjaHLjWO4Nszuiud84jCpkHsqAJoa768Pvg==} + /micromark-extension-math/3.1.0: + resolution: {integrity: sha512-lvEqd+fHjATVs+2v/8kg9i5Q0AP2k85H0WUOwpIVvUML8BapsMvh1XAogmQjOCsLpoKRCVQqEkQBB3NhVBcsOg==} dependencies: '@types/katex': 0.16.7 + devlop: 1.1.0 katex: 0.16.21 - micromark-factory-space: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-mdx-expression/1.0.8: - resolution: {integrity: sha512-zZpeQtc5wfWKdzDsHRBY003H2Smg+PUi2REhqgIhdzAa5xonhP03FcXxqFSerFiNUr5AWmHpaNPQTBVOS4lrXw==} + /micromark-extension-mdx-expression/3.0.0: + resolution: {integrity: sha512-sI0nwhUDz97xyzqJAbHQhp5TfaxEvZZZ2JDqUo+7NvyIYG6BZ5CPPqj2ogUoPJlmXHBnyZUzISg9+oUmU6tUjQ==} dependencies: '@types/estree': 1.0.6 - micromark-factory-mdx-expression: 1.0.9 - micromark-factory-space: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-events-to-acorn: 1.2.3 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 + devlop: 1.1.0 + micromark-factory-mdx-expression: 2.0.2 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-events-to-acorn: 2.0.2 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-mdx-jsx/1.0.5: - resolution: {integrity: sha512-gPH+9ZdmDflbu19Xkb8+gheqEDqkSpdCEubQyxuz/Hn8DOXiXvrXeikOoBA71+e8Pfi0/UYmU3wW3H58kr7akA==} + /micromark-extension-mdx-jsx/3.0.1: + resolution: {integrity: sha512-vNuFb9czP8QCtAQcEJn0UJQJZA8Dk6DXKBqx+bg/w0WGuSxDxNr7hErW89tHUY31dUW4NqEOWwmEUNhjTFmHkg==} dependencies: '@types/acorn': 4.0.6 '@types/estree': 1.0.6 - estree-util-is-identifier-name: 2.1.0 - micromark-factory-mdx-expression: 1.0.9 - micromark-factory-space: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 - vfile-message: 3.1.4 + devlop: 1.1.0 + estree-util-is-identifier-name: 3.0.0 + micromark-factory-mdx-expression: 2.0.2 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-events-to-acorn: 2.0.2 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 + vfile-message: 4.0.2 dev: false - /micromark-extension-mdx-md/1.0.1: - resolution: {integrity: sha512-7MSuj2S7xjOQXAjjkbjBsHkMtb+mDGVW6uI2dBL9snOBCbZmoNgDAeZ0nSn9j3T42UE/g2xVNMn18PJxZvkBEA==} + /micromark-extension-mdx-md/2.0.0: + resolution: {integrity: sha512-EpAiszsB3blw4Rpba7xTOUptcFeBFi+6PY8VnJ2hhimH+vCQDirWgsMpz7w1XcZE7LVrSAUGb9VJpG9ghlYvYQ==} dependencies: - micromark-util-types: 1.1.0 + micromark-util-types: 2.0.1 dev: false - /micromark-extension-mdxjs-esm/1.0.5: - resolution: {integrity: sha512-xNRBw4aoURcyz/S69B19WnZAkWJMxHMT5hE36GtDAyhoyn/8TuAeqjFJQlwk+MKQsUD7b3l7kFX+vlfVWgcX1w==} + /micromark-extension-mdxjs-esm/3.0.0: + resolution: {integrity: sha512-DJFl4ZqkErRpq/dAPyeWp15tGrcrrJho1hKK5uBS70BCtfrIFg81sqcTVu3Ta+KD1Tk5vAtBNElWxtAa+m8K9A==} dependencies: '@types/estree': 1.0.6 - micromark-core-commonmark: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-events-to-acorn: 1.2.3 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - unist-util-position-from-estree: 1.1.2 - uvu: 0.5.6 - vfile-message: 3.1.4 + devlop: 1.1.0 + micromark-core-commonmark: 2.0.2 + micromark-util-character: 2.1.1 + micromark-util-events-to-acorn: 2.0.2 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 + unist-util-position-from-estree: 2.0.0 + vfile-message: 4.0.2 dev: false - /micromark-extension-mdxjs/1.0.1: - resolution: {integrity: sha512-7YA7hF6i5eKOfFUzZ+0z6avRG52GpWR8DL+kN47y3f2KhxbBZMhmxe7auOeaTBrW2DenbbZTf1ea9tA2hDpC2Q==} + /micromark-extension-mdxjs/3.0.0: + resolution: {integrity: sha512-A873fJfhnJ2siZyUrJ31l34Uqwy4xIFmvPY1oj+Ean5PHcPBYzEsvqvWGaWcfEIr11O5Dlw3p2y0tZWpKHDejQ==} dependencies: acorn: 8.14.0 acorn-jsx: 5.3.2_acorn@8.14.0 - micromark-extension-mdx-expression: 1.0.8 - micromark-extension-mdx-jsx: 1.0.5 - micromark-extension-mdx-md: 1.0.1 - micromark-extension-mdxjs-esm: 1.0.5 - micromark-util-combine-extensions: 1.1.0 - micromark-util-types: 1.1.0 + micromark-extension-mdx-expression: 3.0.0 + micromark-extension-mdx-jsx: 3.0.1 + micromark-extension-mdx-md: 2.0.0 + micromark-extension-mdxjs-esm: 3.0.0 + micromark-util-combine-extensions: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-factory-destination/1.1.0: - resolution: {integrity: sha512-XaNDROBgx9SgSChd69pjiGKbV+nfHGDPVYFs5dOoDd7ZnMAE+Cuu91BCpsY8RT2NP9vo/B8pds2VQNCLiu0zhg==} + /micromark-factory-destination/2.0.1: + resolution: {integrity: sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==} dependencies: - micromark-util-character: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-factory-label/1.1.0: - resolution: {integrity: sha512-OLtyez4vZo/1NjxGhcpDSbHQ+m0IIGnT8BoPamh+7jVlzLJBH98zzuCoUeMxvM6WsNeh8wx8cKvqLiPHEACn0w==} + /micromark-factory-label/2.0.1: + resolution: {integrity: sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==} dependencies: - micromark-util-character: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 + devlop: 1.1.0 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-factory-mdx-expression/1.0.9: - resolution: {integrity: sha512-jGIWzSmNfdnkJq05c7b0+Wv0Kfz3NJ3N4cBjnbO4zjXIlxJr+f8lk+5ZmwFvqdAbUy2q6B5rCY//g0QAAaXDWA==} + /micromark-factory-mdx-expression/2.0.2: + resolution: {integrity: sha512-5E5I2pFzJyg2CtemqAbcyCktpHXuJbABnsb32wX2U8IQKhhVFBqkcZR5LRm1WVoFqa4kTueZK4abep7wdo9nrw==} dependencies: '@types/estree': 1.0.6 - micromark-util-character: 1.2.0 - micromark-util-events-to-acorn: 1.2.3 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - unist-util-position-from-estree: 1.1.2 - uvu: 0.5.6 - vfile-message: 3.1.4 - dev: false - - /micromark-factory-space/1.1.0: - resolution: {integrity: sha512-cRzEj7c0OL4Mw2v6nwzttyOZe8XY/Z8G0rzmWQZTBi/jjwyw/U4uqKtUORXQrR5bAZZnbTI/feRV/R7hc4jQYQ==} - dependencies: - micromark-util-character: 1.2.0 - micromark-util-types: 1.1.0 + devlop: 1.1.0 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-events-to-acorn: 2.0.2 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 + unist-util-position-from-estree: 2.0.0 + vfile-message: 4.0.2 dev: false - /micromark-factory-title/1.1.0: - resolution: {integrity: sha512-J7n9R3vMmgjDOCY8NPw55jiyaQnH5kBdV2/UXCtZIpnHH3P6nHUKaH7XXEYuWwx/xUJcawa8plLBEjMPU24HzQ==} + /micromark-factory-space/2.0.1: + resolution: {integrity: sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==} dependencies: - micromark-factory-space: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 + micromark-util-character: 2.1.1 + micromark-util-types: 2.0.1 dev: false - /micromark-factory-whitespace/1.1.0: - resolution: {integrity: sha512-v2WlmiymVSp5oMg+1Q0N1Lxmt6pMhIHD457whWM7/GUlEks1hI9xj5w3zbc4uuMKXGisksZk8DzP2UyGbGqNsQ==} + /micromark-factory-title/2.0.1: + resolution: {integrity: sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==} dependencies: - micromark-factory-space: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-util-character/1.2.0: - resolution: {integrity: sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg==} + /micromark-factory-whitespace/2.0.1: + resolution: {integrity: sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==} dependencies: - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false /micromark-util-character/2.1.1: @@ -3671,85 +4293,73 @@ packages: micromark-util-types: 2.0.1 dev: false - /micromark-util-chunked/1.1.0: - resolution: {integrity: sha512-Ye01HXpkZPNcV6FiyoW2fGZDUw4Yc7vT0E9Sad83+bEDiCJ1uXu0S3mr8WLpsz3HaG3x2q0HM6CTuPdcZcluFQ==} + /micromark-util-chunked/2.0.1: + resolution: {integrity: sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==} dependencies: - micromark-util-symbol: 1.1.0 + micromark-util-symbol: 2.0.1 dev: false - /micromark-util-classify-character/1.1.0: - resolution: {integrity: sha512-SL0wLxtKSnklKSUplok1WQFoGhUdWYKggKUiqhX+Swala+BtptGCu5iPRc+xvzJ4PXE/hwM3FNXsfEVgoZsWbw==} + /micromark-util-classify-character/2.0.1: + resolution: {integrity: sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==} dependencies: - micromark-util-character: 1.2.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 + micromark-util-character: 2.1.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-util-combine-extensions/1.1.0: - resolution: {integrity: sha512-Q20sp4mfNf9yEqDL50WwuWZHUrCO4fEyeDCnMGmG5Pr0Cz15Uo7KBs6jq+dq0EgX4DPwwrh9m0X+zPV1ypFvUA==} + /micromark-util-combine-extensions/2.0.1: + resolution: {integrity: sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==} dependencies: - micromark-util-chunked: 1.1.0 - micromark-util-types: 1.1.0 + micromark-util-chunked: 2.0.1 + micromark-util-types: 2.0.1 dev: false - /micromark-util-decode-numeric-character-reference/1.1.0: - resolution: {integrity: sha512-m9V0ExGv0jB1OT21mrWcuf4QhP46pH1KkfWy9ZEezqHKAxkj4mPCy3nIH1rkbdMlChLHX531eOrymlwyZIf2iw==} + /micromark-util-decode-numeric-character-reference/2.0.2: + resolution: {integrity: sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==} dependencies: - micromark-util-symbol: 1.1.0 + micromark-util-symbol: 2.0.1 dev: false - /micromark-util-decode-string/1.1.0: - resolution: {integrity: sha512-YphLGCK8gM1tG1bd54azwyrQRjCFcmgj2S2GoJDNnh4vYtnL38JS8M4gpxzOPNyHdNEpheyWXCTnnTDY3N+NVQ==} + /micromark-util-decode-string/2.0.1: + resolution: {integrity: sha512-nDV/77Fj6eH1ynwscYTOsbK7rR//Uj0bZXBwJZRfaLEJ1iGBR6kIfNmlNqaqJf649EP0F3NWNdeJi03elllNUQ==} dependencies: decode-named-character-reference: 1.0.2 - micromark-util-character: 1.2.0 - micromark-util-decode-numeric-character-reference: 1.1.0 - micromark-util-symbol: 1.1.0 - dev: false - - /micromark-util-encode/1.1.0: - resolution: {integrity: sha512-EuEzTWSTAj9PA5GOAs992GzNh2dGQO52UvAbtSOMvXTxv3Criqb6IOzJUBCmEqrrXSblJIJBbFFv6zPxpreiJw==} + micromark-util-character: 2.1.1 + micromark-util-decode-numeric-character-reference: 2.0.2 + micromark-util-symbol: 2.0.1 dev: false /micromark-util-encode/2.0.1: resolution: {integrity: sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==} dev: false - /micromark-util-events-to-acorn/1.2.3: - resolution: {integrity: sha512-ij4X7Wuc4fED6UoLWkmo0xJQhsktfNh1J0m8g4PbIMPlx+ek/4YdW5mvbye8z/aZvAPUoxgXHrwVlXAPKMRp1w==} + /micromark-util-events-to-acorn/2.0.2: + resolution: {integrity: sha512-Fk+xmBrOv9QZnEDguL9OI9/NQQp6Hz4FuQ4YmCb/5V7+9eAh1s6AYSvL20kHkD67YIg7EpE54TiSlcsf3vyZgA==} dependencies: '@types/acorn': 4.0.6 '@types/estree': 1.0.6 - '@types/unist': 2.0.11 - estree-util-visit: 1.2.1 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 - vfile-message: 3.1.4 - dev: false - - /micromark-util-html-tag-name/1.2.0: - resolution: {integrity: sha512-VTQzcuQgFUD7yYztuQFKXT49KghjtETQ+Wv/zUjGSGBioZnkA4P1XXZPT1FHeJA6RwRXSF47yvJ1tsJdoxwO+Q==} + '@types/unist': 3.0.3 + devlop: 1.1.0 + estree-util-visit: 2.0.0 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 + vfile-message: 4.0.2 dev: false - /micromark-util-normalize-identifier/1.1.0: - resolution: {integrity: sha512-N+w5vhqrBihhjdpM8+5Xsxy71QWqGn7HYNUvch71iV2PM7+E3uWGox1Qp90loa1ephtCxG2ftRV/Conitc6P2Q==} - dependencies: - micromark-util-symbol: 1.1.0 + /micromark-util-html-tag-name/2.0.1: + resolution: {integrity: sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==} dev: false - /micromark-util-resolve-all/1.1.0: - resolution: {integrity: sha512-b/G6BTMSg+bX+xVCshPTPyAu2tmA0E4X98NSR7eIbeC6ycCqCeE7wjfDIgzEbkzdEVJXRtOG4FbEm/uGbCRouA==} + /micromark-util-normalize-identifier/2.0.1: + resolution: {integrity: sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==} dependencies: - micromark-util-types: 1.1.0 + micromark-util-symbol: 2.0.1 dev: false - /micromark-util-sanitize-uri/1.2.0: - resolution: {integrity: sha512-QO4GXv0XZfWey4pYFndLUKEAktKkG5kZTdUNaTAkzbuJxn2tNBOr+QtxR2XpWaMhbImT2dPzyLrPXLlPhph34A==} + /micromark-util-resolve-all/2.0.1: + resolution: {integrity: sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==} dependencies: - micromark-util-character: 1.2.0 - micromark-util-encode: 1.1.0 - micromark-util-symbol: 1.1.0 + micromark-util-types: 2.0.1 dev: false /micromark-util-sanitize-uri/2.0.1: @@ -3760,51 +4370,43 @@ packages: micromark-util-symbol: 2.0.1 dev: false - /micromark-util-subtokenize/1.1.0: - resolution: {integrity: sha512-kUQHyzRoxvZO2PuLzMt2P/dwVsTiivCK8icYTeR+3WgbuPqfHgPPy7nFKbeqRivBvn/3N3GBiNC+JRTMSxEC7A==} + /micromark-util-subtokenize/2.0.4: + resolution: {integrity: sha512-N6hXjrin2GTJDe3MVjf5FuXpm12PGm80BrUAeub9XFXca8JZbP+oIwY4LJSVwFUCL1IPm/WwSVUN7goFHmSGGQ==} dependencies: - micromark-util-chunked: 1.1.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 - dev: false - - /micromark-util-symbol/1.1.0: - resolution: {integrity: sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag==} + devlop: 1.1.0 + micromark-util-chunked: 2.0.1 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 dev: false /micromark-util-symbol/2.0.1: resolution: {integrity: sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==} dev: false - /micromark-util-types/1.1.0: - resolution: {integrity: sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==} - dev: false - /micromark-util-types/2.0.1: resolution: {integrity: sha512-534m2WhVTddrcKVepwmVEVnUAmtrx9bfIjNoQHRqfnvdaHQiFytEhJoTgpWJvDEXCO5gLTQh3wYC1PgOJA4NSQ==} dev: false - /micromark/3.2.0: - resolution: {integrity: sha512-uD66tJj54JLYq0De10AhWycZWGQNUvDI55xPgk2sQM5kn1JYlhbCMTtEeT27+vAhW2FBQxLlOmS3pmA7/2z4aA==} + /micromark/4.0.1: + resolution: {integrity: sha512-eBPdkcoCNvYcxQOAKAlceo5SNdzZWfF+FcSupREAzdAh9rRmE239CEQAiTwIgblwnoM8zzj35sZ5ZwvSEOF6Kw==} dependencies: '@types/debug': 4.1.12 debug: 4.4.0 decode-named-character-reference: 1.0.2 - micromark-core-commonmark: 1.1.0 - micromark-factory-space: 1.1.0 - micromark-util-character: 1.2.0 - micromark-util-chunked: 1.1.0 - micromark-util-combine-extensions: 1.1.0 - micromark-util-decode-numeric-character-reference: 1.1.0 - micromark-util-encode: 1.1.0 - micromark-util-normalize-identifier: 1.1.0 - micromark-util-resolve-all: 1.1.0 - micromark-util-sanitize-uri: 1.2.0 - micromark-util-subtokenize: 1.1.0 - micromark-util-symbol: 1.1.0 - micromark-util-types: 1.1.0 - uvu: 0.5.6 + devlop: 1.1.0 + micromark-core-commonmark: 2.0.2 + micromark-factory-space: 2.0.1 + micromark-util-character: 2.1.1 + micromark-util-chunked: 2.0.1 + micromark-util-combine-extensions: 2.0.1 + micromark-util-decode-numeric-character-reference: 2.0.2 + micromark-util-encode: 2.0.1 + micromark-util-normalize-identifier: 2.0.1 + micromark-util-resolve-all: 2.0.1 + micromark-util-sanitize-uri: 2.0.1 + micromark-util-subtokenize: 2.0.4 + micromark-util-symbol: 2.0.1 + micromark-util-types: 2.0.1 transitivePeerDependencies: - supports-color dev: false @@ -3817,21 +4419,33 @@ packages: picomatch: 2.3.1 dev: true + /mimic-fn/4.0.0: + resolution: {integrity: sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==} + engines: {node: '>=12'} + dev: false + /minimatch/9.0.5: resolution: {integrity: sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==} engines: {node: '>=16 || 14 >=14.17'} dependencies: brace-expansion: 2.0.1 - dev: true /minipass/7.1.2: resolution: {integrity: sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==} engines: {node: '>=16 || 14 >=14.17'} dev: true - /mri/1.2.0: - resolution: {integrity: sha512-tzzskb3bG8LvYGFF/mDTpq3jpI6Q9wc3LEmBaghu+DdCssd1FakN7Bc0hVNmEyGq1bq3RgfkCb3cmQLpNPOroA==} - engines: {node: '>=4'} + /mj-context-menu/0.6.1: + resolution: {integrity: sha512-7NO5s6n10TIV96d4g2uDpG7ZDpIhMh0QNfGdJw/W47JswFcosz457wqz/b5sAKvl12sxINGFCn80NZHKwxQEXA==} + dev: false + + /mlly/1.7.4: + resolution: {integrity: sha512-qmdSIPC4bDJXgZTCR7XosJiNKySV7O215tsPtDN9iEO/7q/76b/ijtgRu/+epFXSJhijtTCCGp3DWS549P3xKw==} + dependencies: + acorn: 8.14.0 + pathe: 2.0.2 + pkg-types: 1.3.1 + ufo: 1.5.4 dev: false /ms/2.0.0: @@ -3855,43 +4469,29 @@ packages: engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1} hasBin: true - /next-mdx-remote/4.4.1_react-dom@18.3.1+react@18.3.1: - resolution: {integrity: sha512-1BvyXaIou6xy3XoNF4yaMZUCb6vD2GTAa5ciOa6WoO+gAUTYsb1K4rI/HSC2ogAWLrb/7VSV52skz07vOzmqIQ==} - engines: {node: '>=14', npm: '>=7'} - peerDependencies: - react: '>=16.x <=18.x' - react-dom: '>=16.x <=18.x' - dependencies: - '@mdx-js/mdx': 2.3.0 - '@mdx-js/react': 2.3.0_react@18.3.1 - react: 18.3.1 - react-dom: 18.3.1_react@18.3.1 - vfile: 5.3.7 - vfile-matter: 3.0.1 - transitivePeerDependencies: - - supports-color + /negotiator/1.0.0: + resolution: {integrity: sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg==} + engines: {node: '>= 0.6'} dev: false - /next-seo/6.6.0_0a643aba9b2308b459046f7d266814af: - resolution: {integrity: sha512-0VSted/W6XNtgAtH3D+BZrMLLudqfm0D5DYNJRXHcDgan/1ZF1tDFIsWrmvQlYngALyphPfZ3ZdOqlKpKdvG6w==} + /next-themes/0.2.1_0a643aba9b2308b459046f7d266814af: + resolution: {integrity: sha512-B+AKNfYNIzh0vqQQKqQItTS8evEouKD7H5Hj3kmuPERwddR2TxvDSFZuTj6T7Jfn1oyeUyJMydPl1Bkxkh0W7A==} peerDependencies: - next: ^8.1.1-canary.54 || >=9.0.0 - react: '>=16.0.0' - react-dom: '>=16.0.0' + next: '*' + react: '*' + react-dom: '*' dependencies: next: 13.5.8_react-dom@18.3.1+react@18.3.1 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false - /next-themes/0.2.1_0a643aba9b2308b459046f7d266814af: - resolution: {integrity: sha512-B+AKNfYNIzh0vqQQKqQItTS8evEouKD7H5Hj3kmuPERwddR2TxvDSFZuTj6T7Jfn1oyeUyJMydPl1Bkxkh0W7A==} + /next-themes/0.4.4_react-dom@18.3.1+react@18.3.1: + resolution: {integrity: sha512-LDQ2qIOJF0VnuVrrMSMLrWGjRMkq+0mpgl6e0juCLqdJ+oo8Q84JRWT6Wh11VDQKkMMe+dVzDKLWs5n87T+PkQ==} peerDependencies: - next: '*' - react: '*' - react-dom: '*' + react: ^16.8 || ^17 || ^18 || ^19 || ^19.0.0-rc + react-dom: ^16.8 || ^17 || ^18 || ^19 || ^19.0.0-rc dependencies: - next: 13.5.8_react-dom@18.3.1+react@18.3.1 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 dev: false @@ -3935,72 +4535,88 @@ packages: - babel-plugin-macros dev: false - /nextra-theme-docs/2.13.4_914a2928ba2b1fb9d31bb89368d1a0d6: - resolution: {integrity: sha512-2XOoMfwBCTYBt8ds4ZHftt9Wyf2XsykiNo02eir/XEYB+sGeUoE77kzqfidjEOKCSzOHYbK9BDMcg2+B/2vYRw==} + /nextra-theme-docs/3.3.1_25198e6f688a28eb74a49cc2bbfeaa41: + resolution: {integrity: sha512-P305m2UcW2IDyQhjrcAu0qpdPArikofinABslUCAyixYShsmcdDRUhIMd4QBHYru4gQuVjGWX9PhWZZCbNvzDQ==} peerDependencies: - next: '>=9.5.3' - nextra: 2.13.4 - react: '>=16.13.1' - react-dom: '>=16.13.1' + next: '>=13' + nextra: 3.3.1 + react: '>=18' + react-dom: '>=18' dependencies: - '@headlessui/react': 1.7.19_react-dom@18.3.1+react@18.3.1 - '@popperjs/core': 2.11.8 + '@headlessui/react': 2.2.0_react-dom@18.3.1+react@18.3.1 clsx: 2.1.1 escape-string-regexp: 5.0.0 flexsearch: 0.7.43 - focus-visible: 5.2.1 - git-url-parse: 13.1.1 - intersection-observer: 0.12.2 - match-sorter: 6.3.4 next: 13.5.8_react-dom@18.3.1+react@18.3.1 - next-seo: 6.6.0_0a643aba9b2308b459046f7d266814af - next-themes: 0.2.1_0a643aba9b2308b459046f7d266814af - nextra: 2.13.4_0a643aba9b2308b459046f7d266814af + next-themes: 0.4.4_react-dom@18.3.1+react@18.3.1 + nextra: 3.3.1_1cdd235be866fa3cfe463003c7d3272a react: 18.3.1 react-dom: 18.3.1_react@18.3.1 scroll-into-view-if-needed: 3.1.0 zod: 3.24.1 dev: false - /nextra/2.13.4_0a643aba9b2308b459046f7d266814af: - resolution: {integrity: sha512-7of2rSBxuUa3+lbMmZwG9cqgftcoNOVQLTT6Rxf3EhBR9t1EI7b43dted8YoqSNaigdE3j1CoyNkX8N/ZzlEpw==} - engines: {node: '>=16'} + /nextra/3.3.1_1cdd235be866fa3cfe463003c7d3272a: + resolution: {integrity: sha512-jiwj+LfUPHHeAxJAEqFuglxnbjFgzAOnDWFsjv7iv3BWiX8OksDwd3I2Sv3j2zba00iIBDEPdNeylfzTtTLZVg==} + engines: {node: '>=18'} peerDependencies: - next: '>=9.5.3' - react: '>=16.13.1' - react-dom: '>=16.13.1' - dependencies: - '@headlessui/react': 1.7.19_react-dom@18.3.1+react@18.3.1 - '@mdx-js/mdx': 2.3.0 - '@mdx-js/react': 2.3.0_react@18.3.1 + next: '>=13' + react: '>=18' + react-dom: '>=18' + dependencies: + '@formatjs/intl-localematcher': 0.5.10 + '@headlessui/react': 2.2.0_react-dom@18.3.1+react@18.3.1 + '@mdx-js/mdx': 3.1.0 + '@mdx-js/react': 3.1.0_@types+react@19.0.8+react@18.3.1 '@napi-rs/simple-git': 0.1.19 - '@theguild/remark-mermaid': 0.0.5_react@18.3.1 - '@theguild/remark-npm2yarn': 0.2.1 + '@shikijs/twoslash': 1.29.1_typescript@5.7.3 + '@theguild/remark-mermaid': 0.1.3_react@18.3.1 + '@theguild/remark-npm2yarn': 0.3.3 + better-react-mathjax: 2.0.3_react@18.3.1 clsx: 2.1.1 + estree-util-to-js: 2.0.0 + estree-util-value-to-estree: 3.2.1 github-slugger: 2.0.0 graceful-fs: 4.2.11 gray-matter: 4.0.3 + hast-util-to-estree: 3.1.1 katex: 0.16.21 - lodash.get: 4.4.2 + mdast-util-from-markdown: 2.0.2 + mdast-util-gfm: 3.0.0 + mdast-util-to-hast: 13.2.0 + negotiator: 1.0.0 next: 13.5.8_react-dom@18.3.1+react@18.3.1 - next-mdx-remote: 4.4.1_react-dom@18.3.1+react@18.3.1 - p-limit: 3.1.0 + p-limit: 6.2.0 react: 18.3.1 react-dom: 18.3.1_react@18.3.1 + react-medium-image-zoom: 5.2.13_react-dom@18.3.1+react@18.3.1 rehype-katex: 7.0.1 - rehype-pretty-code: 0.9.11_shiki@0.14.7 + rehype-pretty-code: 0.14.0_shiki@1.29.1 rehype-raw: 7.0.0 - remark-gfm: 3.0.1 - remark-math: 5.1.1 + remark-frontmatter: 5.0.0 + remark-gfm: 4.0.0 + remark-math: 6.0.0 remark-reading-time: 2.0.1 - shiki: 0.14.7 - slash: 3.0.0 - title: 3.5.3 + remark-smartypants: 3.0.2 + shiki: 1.29.1 + slash: 5.1.0 + title: 4.0.1 unist-util-remove: 4.0.0 unist-util-visit: 5.0.0 + yaml: 2.7.0 zod: 3.24.1 + zod-validation-error: 3.4.0_zod@3.24.1 transitivePeerDependencies: + - '@types/react' + - acorn - supports-color + - typescript + dev: false + + /nlcst-to-string/4.0.0: + resolution: {integrity: sha512-YKLBCcUYKAg0FNlOBT6aI91qFmSiFKiluk655WzPF+DDMA02qIyy8uiRqI8QXtcFpEvll12LpL5MXqEmAZ+dcA==} + dependencies: + '@types/nlcst': 2.0.3 dev: false /node-fetch/2.6.1: @@ -4012,10 +4628,6 @@ packages: resolution: {integrity: sha512-xxOWJsBKtzAq7DY0J+DTzuz58K8e7sJbdgwkbMWQe8UYB6ekmsQ45q0M/tJDsGaZmbC+l7n57UV8Hl5tHxO9uw==} dev: true - /non-layered-tidy-tree-layout/2.0.2: - resolution: {integrity: sha512-gkXMxRzUH+PB0ax9dUN0yYF0S25BqeAYqhgMaLUFmpXLEk7Fcu8f4emJuOAY0V8kjDICxROIKsTAKsV/v355xw==} - dev: false - /normalize-path/3.0.0: resolution: {integrity: sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==} engines: {node: '>=0.10.0'} @@ -4026,15 +4638,15 @@ packages: engines: {node: '>=0.10.0'} dev: true - /npm-run-path/2.0.2: - resolution: {integrity: sha512-lJxZYlT4DW/bRUtFh1MQIWqmLwQfAxnqWG4HhEdjMlkrJYnJn0Jrr2u3mgxqaWsdiBc76TYkTG/mhrnYTuzfHw==} - engines: {node: '>=4'} + /npm-run-path/5.3.0: + resolution: {integrity: sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} dependencies: - path-key: 2.0.1 + path-key: 4.0.0 dev: false - /npm-to-yarn/2.2.1: - resolution: {integrity: sha512-O/j/ROyX0KGLG7O6Ieut/seQ0oiTpHF2tXAcFbpdTLQFiaNtkyTXXocM1fwpaa60dg1qpWj0nHlbNhx6qwuENQ==} + /npm-to-yarn/3.0.1: + resolution: {integrity: sha512-tt6PvKu4WyzPwWUzy/hvPFqn+uwXO0K1ZHka8az3NnrhWJDmSqI8ncWq0fkL0k/lmmi5tAC11FXwXuh0rFbt1A==} engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} dev: false @@ -4047,22 +4659,36 @@ packages: engines: {node: '>= 6'} dev: true - /p-finally/1.0.0: - resolution: {integrity: sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow==} - engines: {node: '>=4'} + /onetime/6.0.0: + resolution: {integrity: sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==} + engines: {node: '>=12'} + dependencies: + mimic-fn: 4.0.0 dev: false - /p-limit/3.1.0: - resolution: {integrity: sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==} - engines: {node: '>=10'} + /oniguruma-to-es/2.3.0: + resolution: {integrity: sha512-bwALDxriqfKGfUufKGGepCzu9x7nJQuoRoAFp4AnwehhC2crqrDIAP/uN2qdlsAvSMpeRC3+Yzhqc7hLmle5+g==} + dependencies: + emoji-regex-xs: 1.0.0 + regex: 5.1.1 + regex-recursion: 5.1.1 + dev: false + + /p-limit/6.2.0: + resolution: {integrity: sha512-kuUqqHNUqoIWp/c467RI4X6mmyuojY5jGutNU0wVTmEOOfcuwLqyMVoAi9MKi2Ak+5i9+nhmrK4ufZE8069kHA==} + engines: {node: '>=18'} dependencies: - yocto-queue: 0.1.0 + yocto-queue: 1.1.1 dev: false /package-json-from-dist/1.0.1: resolution: {integrity: sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==} dev: true + /package-manager-detector/0.2.8: + resolution: {integrity: sha512-ts9KSdroZisdvKMWVAVCXiKqnqNfXz4+IbrBG8/BWx/TR5le+jfenvoBuIZ6UWM9nz47W7AbD9qYfAwfWMIwzA==} + dev: false + /parse-entities/4.0.2: resolution: {integrity: sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw==} dependencies: @@ -4075,20 +4701,19 @@ packages: is-hexadecimal: 2.0.1 dev: false - /parse-numeric-range/1.3.0: - resolution: {integrity: sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ==} - dev: false - - /parse-path/7.0.0: - resolution: {integrity: sha512-Euf9GG8WT9CdqwuWJGdf3RkUcTBArppHABkO7Lm8IzRQp0e2r/kkFnmhu4TSK30Wcu5rVAZLmfPKSBBi9tWFog==} + /parse-latin/7.0.0: + resolution: {integrity: sha512-mhHgobPPua5kZ98EF4HWiH167JWBfl4pvAIXXdbaVohtK7a6YBOy56kvhCqduqyo/f3yrHFWmqmiMg/BkBkYYQ==} dependencies: - protocols: 2.0.1 + '@types/nlcst': 2.0.3 + '@types/unist': 3.0.3 + nlcst-to-string: 4.0.0 + unist-util-modify-children: 4.0.0 + unist-util-visit-children: 3.0.0 + vfile: 6.0.3 dev: false - /parse-url/8.1.0: - resolution: {integrity: sha512-xDvOoLU5XRrcOZvnI6b8zA6n9O9ejNk/GExuz1yBuWUGn9KA97GI6HTs6u02wKara1CeVmZhH+0TZFdWScR89w==} - dependencies: - parse-path: 7.0.0 + /parse-numeric-range/1.3.0: + resolution: {integrity: sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ==} dev: false /parse5/7.2.1: @@ -4097,15 +4722,18 @@ packages: entities: 4.5.0 dev: false - /path-key/2.0.1: - resolution: {integrity: sha512-fEHGKCSmUSDPv4uoj8AlD+joPlq3peND+HRYyxFz4KPw4z926S/b8rIuFs2FYJg3BwsxJf6A9/3eIdLaYC+9Dw==} - engines: {node: '>=4'} + /path-data-parser/0.1.0: + resolution: {integrity: sha512-NOnmBpt5Y2RWbuv0LMzsayp3lVylAHLPUTut412ZA3l+C4uw4ZVkQbjShYCQ8TCpUMdPapr4YjUqLYD6v68j+w==} dev: false /path-key/3.1.1: resolution: {integrity: sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==} engines: {node: '>=8'} - dev: true + + /path-key/4.0.0: + resolution: {integrity: sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==} + engines: {node: '>=12'} + dev: false /path-parse/1.0.7: resolution: {integrity: sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==} @@ -4119,12 +4747,8 @@ packages: minipass: 7.1.2 dev: true - /periscopic/3.1.0: - resolution: {integrity: sha512-vKiQ8RRtkl9P+r/+oefh25C3fhybptkHKCZSPlcXiJux2tJF55GnEj3BVn4A5gKfq9NWWXXrxkHBwVPUfH0opw==} - dependencies: - '@types/estree': 1.0.6 - estree-walker: 3.0.3 - is-reference: 3.0.3 + /pathe/2.0.2: + resolution: {integrity: sha512-15Ztpk+nov8DR524R4BF7uEuzESgzUEAV4Ah7CUMNGXdE5ELuvxElxGXndBl32vMSsWa1jpNf22Z+Er3sKwq+w==} dev: false /picocolors/1.1.1: @@ -4145,6 +4769,25 @@ packages: engines: {node: '>= 6'} dev: true + /pkg-types/1.3.1: + resolution: {integrity: sha512-/Jm5M4RvtBFVkKWRu2BLUTNP8/M2a+UwuAX+ae4770q1qVGtfjG+WTCupoZixokjmHiry8uI+dlY8KXYV5HVVQ==} + dependencies: + confbox: 0.1.8 + mlly: 1.7.4 + pathe: 2.0.2 + dev: false + + /points-on-curve/0.2.0: + resolution: {integrity: sha512-0mYKnYYe9ZcqMCWhUjItv/oHjvgEsfKvnUTg8sAtnHr3GVy7rGkXCb6d5cSyqrWqL4k81b9CPg3urd+T7aop3A==} + dev: false + + /points-on-path/0.2.1: + resolution: {integrity: sha512-25ClnWWuw7JbWZcgqY/gJ4FQWadKxGWk+3kR/7kD0tCaDtPPMj7oHu2ToLaVhfpnHrZzYby2w6tUA0eOIuUg8g==} + dependencies: + path-data-parser: 0.1.0 + points-on-curve: 0.2.0 + dev: false + /postcss-import/15.1.0_postcss@8.5.1: resolution: {integrity: sha512-hpr+J05B2FVYUAXHeK1YyI267J/dDDhMU6B6civm8hSY1jYJnBXxzKDKDswzJmtLHryrjhnDjqqp/49t8FALew==} engines: {node: '>=14.0.0'} @@ -4236,12 +4879,9 @@ packages: resolution: {integrity: sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig==} dev: false - /protocols/2.0.1: - resolution: {integrity: sha512-/XJ368cyBJ7fzLMwLKv1e4vLxOju2MNAIokcr7meSaNcVbWz/CPcW22cP04mwxOErdA5mwjA8Q6w/cdAQxVn7Q==} - dev: false - - /pseudomap/1.0.2: - resolution: {integrity: sha512-b/YwNhb8lk1Zz2+bXXpS/LK9OisiZZ1SNsSLxN1x2OXVEhW2Ckr/7mWE5vrC1ZTiJlD9g19jWszTmJsB+oEpFQ==} + /punycode.js/2.3.1: + resolution: {integrity: sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==} + engines: {node: '>=6'} dev: false /queue-microtask/1.2.3: @@ -4281,7 +4921,17 @@ packages: resolution: {integrity: sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==} dev: false - /react-remove-scroll-bar/2.3.8_react@18.3.1: + /react-medium-image-zoom/5.2.13_react-dom@18.3.1+react@18.3.1: + resolution: {integrity: sha512-KcBL4OsoUQJgIFh6vQgt/6sRGqDy6bQBcsbhGD2tsy4B5Pw3dWrboocVOyIm76RRALEZ6Qwp3EDvIvfEv0m5sg==} + peerDependencies: + react: ^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 + react-dom: ^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 + dependencies: + react: 18.3.1 + react-dom: 18.3.1_react@18.3.1 + dev: false + + /react-remove-scroll-bar/2.3.8_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-9r+yi9+mgU33AKcj6IbT9oRCO78WriSj6t/cF8DWBZJ9aOGPOTEDvdUDz1FwKim7QXWwmHqtdHnRJfhAxEG46Q==} engines: {node: '>=10'} peerDependencies: @@ -4291,12 +4941,13 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 - react-style-singleton: 2.2.3_react@18.3.1 + react-style-singleton: 2.2.3_@types+react@19.0.8+react@18.3.1 tslib: 2.8.1 dev: false - /react-remove-scroll/2.5.4_react@18.3.1: + /react-remove-scroll/2.5.4_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-xGVKJJr0SJGQVirVFAUZ2k1QLyO6m+2fy0l8Qawbp5Jgrv3DeLalrfMNBFSlmz5kriGGzsVBtGVnf4pTKIhhWA==} engines: {node: '>=10'} peerDependencies: @@ -4306,15 +4957,16 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 - react-remove-scroll-bar: 2.3.8_react@18.3.1 - react-style-singleton: 2.2.3_react@18.3.1 + react-remove-scroll-bar: 2.3.8_@types+react@19.0.8+react@18.3.1 + react-style-singleton: 2.2.3_@types+react@19.0.8+react@18.3.1 tslib: 2.8.1 - use-callback-ref: 1.3.3_react@18.3.1 - use-sidecar: 1.1.3_react@18.3.1 + use-callback-ref: 1.3.3_@types+react@19.0.8+react@18.3.1 + use-sidecar: 1.1.3_@types+react@19.0.8+react@18.3.1 dev: false - /react-remove-scroll/2.6.3_react@18.3.1: + /react-remove-scroll/2.6.3_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-pnAi91oOk8g8ABQKGF5/M9qxmmOPxaAnopyTHYfqYEwJhyFrbbBtHuSgtKEoH0jpcxx5o3hXqH1mNd9/Oi+8iQ==} engines: {node: '>=10'} peerDependencies: @@ -4324,15 +4976,16 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 - react-remove-scroll-bar: 2.3.8_react@18.3.1 - react-style-singleton: 2.2.3_react@18.3.1 + react-remove-scroll-bar: 2.3.8_@types+react@19.0.8+react@18.3.1 + react-style-singleton: 2.2.3_@types+react@19.0.8+react@18.3.1 tslib: 2.8.1 - use-callback-ref: 1.3.3_react@18.3.1 - use-sidecar: 1.1.3_react@18.3.1 + use-callback-ref: 1.3.3_@types+react@19.0.8+react@18.3.1 + use-sidecar: 1.1.3_@types+react@19.0.8+react@18.3.1 dev: false - /react-style-singleton/2.2.3_react@18.3.1: + /react-style-singleton/2.2.3_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-b6jSvxvVnyptAiLjbkWLE/lOnR4lfTtDAl+eUC7RZy+QQWc6wRzIV2CE6xBuMmDxc2qIihtDCZD5NPOFl7fRBQ==} engines: {node: '>=10'} peerDependencies: @@ -4342,6 +4995,7 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 get-nonce: 1.0.1 react: 18.3.1 tslib: 2.8.1 @@ -4383,10 +5037,65 @@ packages: resolution: {integrity: sha512-onYyVhBNr4CmAxFsKS7bz+uTLRakypIe4R+5A824vBSkQy/hB3fZepoVEf8OVAxzLvK+H/jm9TzpI3ETSm64Kg==} dev: false + /recma-build-jsx/1.0.0: + resolution: {integrity: sha512-8GtdyqaBcDfva+GUKDr3nev3VpKAhup1+RvkMvUxURHpW7QyIvk9F5wz7Vzo06CEMSilw6uArgRqhpiUcWp8ew==} + dependencies: + '@types/estree': 1.0.6 + estree-util-build-jsx: 3.0.1 + vfile: 6.0.3 + dev: false + + /recma-jsx/1.0.0: + resolution: {integrity: sha512-5vwkv65qWwYxg+Atz95acp8DMu1JDSqdGkA2Of1j6rCreyFUE/gp15fC8MnGEuG1W68UKjM6x6+YTWIh7hZM/Q==} + dependencies: + acorn-jsx: 5.3.2 + estree-util-to-js: 2.0.0 + recma-parse: 1.0.0 + recma-stringify: 1.0.0 + unified: 11.0.5 + transitivePeerDependencies: + - acorn + dev: false + + /recma-parse/1.0.0: + resolution: {integrity: sha512-OYLsIGBB5Y5wjnSnQW6t3Xg7q3fQ7FWbw/vcXtORTnyaSFscOtABg+7Pnz6YZ6c27fG1/aN8CjfwoUEUIdwqWQ==} + dependencies: + '@types/estree': 1.0.6 + esast-util-from-js: 2.0.1 + unified: 11.0.5 + vfile: 6.0.3 + dev: false + + /recma-stringify/1.0.0: + resolution: {integrity: sha512-cjwII1MdIIVloKvC9ErQ+OgAtwHBmcZ0Bg4ciz78FtbT8In39aAYbaA7zvxQ61xVMSPE8WxhLwLbhif4Js2C+g==} + dependencies: + '@types/estree': 1.0.6 + estree-util-to-js: 2.0.0 + unified: 11.0.5 + vfile: 6.0.3 + dev: false + /regenerator-runtime/0.14.1: resolution: {integrity: sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==} dev: false + /regex-recursion/5.1.1: + resolution: {integrity: sha512-ae7SBCbzVNrIjgSbh7wMznPcQel1DNlDtzensnFxpiNpXt1U2ju/bHugH422r+4LAVS1FpW1YCwilmnNsjum9w==} + dependencies: + regex: 5.1.1 + regex-utilities: 2.3.0 + dev: false + + /regex-utilities/2.3.0: + resolution: {integrity: sha512-8VhliFJAWRaUiVvREIiW2NXXTmHs4vMNnSzuJVhscgmGav3g9VDxLrQndI3dZZVVdp0ZO/5v0xmX516/7M9cng==} + dev: false + + /regex/5.1.1: + resolution: {integrity: sha512-dN5I359AVGPnwzJm2jN1k0W9LPZ+ePvoOeVMMfqIMFz53sSwXkxaJoxr50ptnsC771lK95BnTrVSZxq0b9yCGw==} + dependencies: + regex-utilities: 2.3.0 + dev: false + /rehype-katex/7.0.1: resolution: {integrity: sha512-OiM2wrZ/wuhKkigASodFoo8wimG3H12LWQaH8qSPVJn9apWKFSH3YOCtbKpBorTVw/eI7cuT21XBbvwEswbIOA==} dependencies: @@ -4399,16 +5108,27 @@ packages: vfile: 6.0.3 dev: false - /rehype-pretty-code/0.9.11_shiki@0.14.7: - resolution: {integrity: sha512-Eq90eCYXQJISktfRZ8PPtwc5SUyH6fJcxS8XOMnHPUQZBtC6RYo67gGlley9X2nR8vlniPj0/7oCDEYHKQa/oA==} - engines: {node: '>=16'} + /rehype-parse/9.0.1: + resolution: {integrity: sha512-ksCzCD0Fgfh7trPDxr2rSylbwq9iYDkSn8TCDmEJ49ljEUBxDVCzCHv7QNzZOfODanX4+bWQ4WZqLCRWYLfhag==} + dependencies: + '@types/hast': 3.0.4 + hast-util-from-html: 2.0.3 + unified: 11.0.5 + dev: false + + /rehype-pretty-code/0.14.0_shiki@1.29.1: + resolution: {integrity: sha512-hBeKF/Wkkf3zyUS8lal9RCUuhypDWLQc+h9UrP9Pav25FUm/AQAVh4m5gdvJxh4Oz+U+xKvdsV01p1LdvsZTiQ==} + engines: {node: '>=18'} peerDependencies: - shiki: '*' + shiki: ^1.3.0 dependencies: - '@types/hast': 2.3.10 - hash-obj: 4.0.0 + '@types/hast': 3.0.4 + hast-util-to-string: 3.0.1 parse-numeric-range: 1.3.0 - shiki: 0.14.7 + rehype-parse: 9.0.1 + shiki: 1.29.1 + unified: 11.0.5 + unist-util-visit: 5.0.0 dev: false /rehype-raw/7.0.0: @@ -4419,41 +5139,67 @@ packages: vfile: 6.0.3 dev: false - /remark-gfm/3.0.1: - resolution: {integrity: sha512-lEFDoi2PICJyNrACFOfDD3JlLkuSbOa5Wd8EPt06HUdptv8Gn0bxYTdbU/XXQ3swAPkEaGxxPN9cbnMHvVu1Ig==} + /rehype-recma/1.0.0: + resolution: {integrity: sha512-lqA4rGUf1JmacCNWWZx0Wv1dHqMwxzsDWYMTowuplHF3xH0N/MmrZ/G3BDZnzAkRmxDadujCjaKM2hqYdCBOGw==} + dependencies: + '@types/estree': 1.0.6 + '@types/hast': 3.0.4 + hast-util-to-estree: 3.1.1 + transitivePeerDependencies: + - supports-color + dev: false + + /remark-frontmatter/5.0.0: + resolution: {integrity: sha512-XTFYvNASMe5iPN0719nPrdItC9aU0ssC4v14mH1BCi1u0n1gAocqcujWUrByftZTbLhRtiKRyjYTSIOcr69UVQ==} + dependencies: + '@types/mdast': 4.0.4 + mdast-util-frontmatter: 2.0.1 + micromark-extension-frontmatter: 2.0.0 + unified: 11.0.5 + transitivePeerDependencies: + - supports-color + dev: false + + /remark-gfm/4.0.0: + resolution: {integrity: sha512-U92vJgBPkbw4Zfu/IiW2oTZLSL3Zpv+uI7My2eq8JxKgqraFdU8YUGicEJCEgSbeaG+QDFqIcwwfMTOEelPxuA==} dependencies: - '@types/mdast': 3.0.15 - mdast-util-gfm: 2.0.2 - micromark-extension-gfm: 2.0.3 - unified: 10.1.2 + '@types/mdast': 4.0.4 + mdast-util-gfm: 3.0.0 + micromark-extension-gfm: 3.0.0 + remark-parse: 11.0.0 + remark-stringify: 11.0.0 + unified: 11.0.5 transitivePeerDependencies: - supports-color dev: false - /remark-math/5.1.1: - resolution: {integrity: sha512-cE5T2R/xLVtfFI4cCePtiRn+e6jKMtFDR3P8V3qpv8wpKjwvHoBA4eJzvX+nVrnlNy0911bdGmuspCSwetfYHw==} + /remark-math/6.0.0: + resolution: {integrity: sha512-MMqgnP74Igy+S3WwnhQ7kqGlEerTETXMvJhrUzDikVZ2/uogJCb+WHUg97hK9/jcfc0dkD73s3LN8zU49cTEtA==} dependencies: - '@types/mdast': 3.0.15 - mdast-util-math: 2.0.2 - micromark-extension-math: 2.1.2 - unified: 10.1.2 + '@types/mdast': 4.0.4 + mdast-util-math: 3.0.0 + micromark-extension-math: 3.1.0 + unified: 11.0.5 + transitivePeerDependencies: + - supports-color dev: false - /remark-mdx/2.3.0: - resolution: {integrity: sha512-g53hMkpM0I98MU266IzDFMrTD980gNF3BJnkyFcmN+dD873mQeD5rdMO3Y2X+x8umQfbSE0PcoEDl7ledSA+2g==} + /remark-mdx/3.1.0: + resolution: {integrity: sha512-Ngl/H3YXyBV9RcRNdlYsZujAmhsxwzxpDzpDEhFBVAGthS4GDgnctpDjgFl/ULx5UEDzqtW1cyBSNKqYYrqLBA==} dependencies: - mdast-util-mdx: 2.0.1 - micromark-extension-mdxjs: 1.0.1 + mdast-util-mdx: 3.0.0 + micromark-extension-mdxjs: 3.0.0 transitivePeerDependencies: - supports-color dev: false - /remark-parse/10.0.2: - resolution: {integrity: sha512-3ydxgHa/ZQzG8LvC7jTXccARYDcRld3VfcgIIFs7bI6vbRSxJJmzgLEIIoYKyrfhaY+ujuWaf/PJiMZXoiCXgw==} + /remark-parse/11.0.0: + resolution: {integrity: sha512-FCxlKLNGknS5ba/1lmpYijMUzX2esxW5xQqjWxw2eHFfS2MSdaHVINFmhjo+qN1WhZhNimq0dZATN9pH0IDrpA==} dependencies: - '@types/mdast': 3.0.15 - mdast-util-from-markdown: 1.3.1 - unified: 10.1.2 + '@types/mdast': 4.0.4 + mdast-util-from-markdown: 2.0.2 + micromark-util-types: 2.0.1 + unified: 11.0.5 transitivePeerDependencies: - supports-color dev: false @@ -4467,17 +5213,32 @@ packages: unist-util-visit: 3.1.0 dev: false - /remark-rehype/10.1.0: - resolution: {integrity: sha512-EFmR5zppdBp0WQeDVZ/b66CWJipB2q2VLNFMabzDSGR66Z2fQii83G5gTBbgGEnEEA0QRussvrFHxk1HWGJskw==} + /remark-rehype/11.1.1: + resolution: {integrity: sha512-g/osARvjkBXb6Wo0XvAeXQohVta8i84ACbenPpoSsxTOQH/Ae0/RGP4WZgnMH5pMLpsj4FG7OHmcIcXxpza8eQ==} dependencies: - '@types/hast': 2.3.10 - '@types/mdast': 3.0.15 - mdast-util-to-hast: 12.3.0 - unified: 10.1.2 + '@types/hast': 3.0.4 + '@types/mdast': 4.0.4 + mdast-util-to-hast: 13.2.0 + unified: 11.0.5 + vfile: 6.0.3 dev: false - /remove-accents/0.5.0: - resolution: {integrity: sha512-8g3/Otx1eJaVD12e31UbJj1YzdtVvzH85HV7t+9MJYk/u3XmkOUJ5Ys9wQrf9PCPK8+xn4ymzqYCiZl6QWKn+A==} + /remark-smartypants/3.0.2: + resolution: {integrity: sha512-ILTWeOriIluwEvPjv67v7Blgrcx+LZOkAUVtKI3putuhlZm84FnqDORNXPPm+HY3NdZOMhyDwZ1E+eZB/Df5dA==} + engines: {node: '>=16.0.0'} + dependencies: + retext: 9.0.0 + retext-smartypants: 6.2.0 + unified: 11.0.5 + unist-util-visit: 5.0.0 + dev: false + + /remark-stringify/11.0.0: + resolution: {integrity: sha512-1OSmLd3awB/t8qdoEOMazZkNsfVTeY4fTsgzcQFdXNq8ToTN4ZGwrMnlda4K6smTFKD+GRV6O48i6Z4iKgPPpw==} + dependencies: + '@types/mdast': 4.0.4 + mdast-util-to-markdown: 2.1.2 + unified: 11.0.5 dev: false /resolve/1.22.10: @@ -4490,6 +5251,39 @@ packages: supports-preserve-symlinks-flag: 1.0.0 dev: true + /retext-latin/4.0.0: + resolution: {integrity: sha512-hv9woG7Fy0M9IlRQloq/N6atV82NxLGveq+3H2WOi79dtIYWN8OaxogDm77f8YnVXJL2VD3bbqowu5E3EMhBYA==} + dependencies: + '@types/nlcst': 2.0.3 + parse-latin: 7.0.0 + unified: 11.0.5 + dev: false + + /retext-smartypants/6.2.0: + resolution: {integrity: sha512-kk0jOU7+zGv//kfjXEBjdIryL1Acl4i9XNkHxtM7Tm5lFiCog576fjNC9hjoR7LTKQ0DsPWy09JummSsH1uqfQ==} + dependencies: + '@types/nlcst': 2.0.3 + nlcst-to-string: 4.0.0 + unist-util-visit: 5.0.0 + dev: false + + /retext-stringify/4.0.0: + resolution: {integrity: sha512-rtfN/0o8kL1e+78+uxPTqu1Klt0yPzKuQ2BfWwwfgIUSayyzxpM1PJzkKt4V8803uB9qSy32MvI7Xep9khTpiA==} + dependencies: + '@types/nlcst': 2.0.3 + nlcst-to-string: 4.0.0 + unified: 11.0.5 + dev: false + + /retext/9.0.0: + resolution: {integrity: sha512-sbMDcpHCNjvlheSgMfEcVrZko3cDzdbe1x/e7G66dFp0Ff7Mldvi2uv6JkJQzdRcvLYE8CA8Oe8siQx8ZOgTcA==} + dependencies: + '@types/nlcst': 2.0.3 + retext-latin: 4.0.0 + retext-stringify: 4.0.0 + unified: 11.0.5 + dev: false + /reusify/1.0.4: resolution: {integrity: sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==} engines: {iojs: '>=1.0.0', node: '>=0.10.0'} @@ -4499,6 +5293,15 @@ packages: resolution: {integrity: sha512-IXgzBWvWQwE6PrDI05OvmXUIruQTcoMDzRsOd5CDvHCVLcLHMTSYvOK5Cm46kWqlV3yAbuSpBZdJ5oP5OUoStg==} dev: false + /roughjs/4.6.6: + resolution: {integrity: sha512-ZUz/69+SYpFN/g/lUlo2FXcIjRkSu3nDarreVdGGndHEBJ6cXPdKguS8JGxwj5HA5xIbVKSmLgr5b3AWxtRfvQ==} + dependencies: + hachure-fill: 0.5.2 + path-data-parser: 0.1.0 + points-on-curve: 0.2.0 + points-on-path: 0.2.1 + dev: false + /run-parallel/1.2.0: resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==} dependencies: @@ -4509,13 +5312,6 @@ packages: resolution: {integrity: sha512-PdhdWy89SiZogBLaw42zdeqtRJ//zFd2PgQavcICDUgJT5oW10QCRKbJ6bg4r0/UY2M6BWd5tkxuGFRvCkgfHQ==} dev: false - /sade/1.8.1: - resolution: {integrity: sha512-xal3CZX1Xlo/k4ApwCFrHVACi9fBqJ7V+mwhBsuf/1IOKbBy098Fex+Wa/5QMubw09pSZ/u8EY8PWgevJsXp1A==} - engines: {node: '>=6'} - dependencies: - mri: 1.2.0 - dev: false - /safer-buffer/2.1.2: resolution: {integrity: sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==} dev: false @@ -4540,62 +5336,40 @@ packages: kind-of: 6.0.3 dev: false - /shebang-command/1.2.0: - resolution: {integrity: sha512-EV3L1+UQWGor21OmnvojK36mhg+TyIKDh3iFBKBohr5xeXIhNBcx8oWdgkTEEQ+BEFFYdLRuqMfd5L84N1V5Vg==} - engines: {node: '>=0.10.0'} - dependencies: - shebang-regex: 1.0.0 - dev: false - /shebang-command/2.0.0: resolution: {integrity: sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==} engines: {node: '>=8'} dependencies: shebang-regex: 3.0.0 - dev: true - - /shebang-regex/1.0.0: - resolution: {integrity: sha512-wpoSFAxys6b2a2wHZ1XpDSgD7N9iVjg29Ph9uV/uaP9Ex/KXlkTZTeddxDPSYQpgvzKLGJke2UU0AzoGCjNIvQ==} - engines: {node: '>=0.10.0'} - dev: false /shebang-regex/3.0.0: resolution: {integrity: sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==} engines: {node: '>=8'} - dev: true - /shiki/0.14.7: - resolution: {integrity: sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==} + /shiki/1.29.1: + resolution: {integrity: sha512-TghWKV9pJTd/N+IgAIVJtr0qZkB7FfFCUrrEJc0aRmZupo3D1OCVRknQWVRVA7AX/M0Ld7QfoAruPzr3CnUJuw==} dependencies: - ansi-sequence-parser: 1.1.1 - jsonc-parser: 3.3.1 - vscode-oniguruma: 1.7.0 - vscode-textmate: 8.0.0 - dev: false - - /signal-exit/3.0.7: - resolution: {integrity: sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==} + '@shikijs/core': 1.29.1 + '@shikijs/engine-javascript': 1.29.1 + '@shikijs/engine-oniguruma': 1.29.1 + '@shikijs/langs': 1.29.1 + '@shikijs/themes': 1.29.1 + '@shikijs/types': 1.29.1 + '@shikijs/vscode-textmate': 10.0.1 + '@types/hast': 3.0.4 dev: false /signal-exit/4.1.0: resolution: {integrity: sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==} engines: {node: '>=14'} - dev: true /sister/3.0.2: resolution: {integrity: sha512-p19rtTs+NksBRKW9qn0UhZ8/TUI9BPw9lmtHny+Y3TinWlOa9jWh9xB0AtPSdmOy49NJJJSSe0Ey4C7h0TrcYA==} dev: false - /slash/3.0.0: - resolution: {integrity: sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==} - engines: {node: '>=8'} - dev: false - - /sort-keys/5.1.0: - resolution: {integrity: sha512-aSbHV0DaBcr7u0PVHXzM6NbZNAtrr9sF6+Qfs9UUVG7Ll3jQ6hHi8F/xqIIcn2rvIVbr0v/2zyjSdwSV47AgLQ==} - engines: {node: '>=12'} - dependencies: - is-plain-obj: 4.1.0 + /slash/5.1.0: + resolution: {integrity: sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg==} + engines: {node: '>=14.16'} dev: false /source-map-js/1.2.1: @@ -4611,6 +5385,15 @@ packages: resolution: {integrity: sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==} dev: false + /speech-rule-engine/4.0.7: + resolution: {integrity: sha512-sJrL3/wHzNwJRLBdf6CjJWIlxC04iYKkyXvYSVsWVOiC2DSkHmxsqOhEeMsBA9XK+CHuNcsdkbFDnoUfAsmp9g==} + hasBin: true + dependencies: + commander: 9.2.0 + wicked-good-xpath: 1.3.0 + xmldom-sre: 0.1.31 + dev: false + /sprintf-js/1.0.3: resolution: {integrity: sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==} dev: false @@ -4664,15 +5447,15 @@ packages: engines: {node: '>=0.10.0'} dev: false - /strip-eof/1.0.0: - resolution: {integrity: sha512-7FCwGGmx8mD5xQd3RPUvnSpUXHM3BWuzjtpD4TXsfcZ9EL4azvVVUscFYwD9nx8Kh+uCBC00XBtAykoMHwTh8Q==} - engines: {node: '>=0.10.0'} + /strip-final-newline/3.0.0: + resolution: {integrity: sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==} + engines: {node: '>=12'} dev: false - /style-to-object/0.4.4: - resolution: {integrity: sha512-HYNoHZa2GorYNyqiCaBgsxvcJIn7OHq6inEga+E6Ke3m5JkoqpQbnFssk4jwe+K7AhGa2fcha4wSOf1Kn01dMg==} + /style-to-object/1.0.8: + resolution: {integrity: sha512-xT47I/Eo0rwJmaXC4oilDGDWLohVhR6o/xAQcPQN8q6QBuZVL8qMYL85kLmST5cPjAorwvqIA4qXTRQoYHaL6g==} dependencies: - inline-style-parser: 0.1.1 + inline-style-parser: 0.2.4 dev: false /styled-jsx/5.1.1_react@18.3.1: @@ -4710,18 +5493,20 @@ packages: ts-interface-checker: 0.1.13 dev: true - /supports-color/4.5.0: - resolution: {integrity: sha512-ycQR/UbvI9xIlEdQT1TQqwoXtEldExbCEAJgRo5YXlmSKjv6ThHnP9/vwGa1gr19Gfw+LkFd7KqYMhzrRC5JYw==} - engines: {node: '>=4'} - dependencies: - has-flag: 2.0.0 - dev: false - /supports-preserve-symlinks-flag/1.0.0: resolution: {integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==} engines: {node: '>= 0.4'} dev: true + /system-architecture/0.1.0: + resolution: {integrity: sha512-ulAk51I9UVUyJgxlv9M6lFot2WP3e7t8Kz9+IS6D4rVba1tR9kON+Ey69f+1R4Q8cd45Lod6a4IcJIxnzGc/zA==} + engines: {node: '>=18'} + dev: false + + /tabbable/6.2.0: + resolution: {integrity: sha512-Cat63mxsVJlzYvN51JmVXIgNoUokrIaT2zLclCXjRd8boZ0004U4KCs/sToJ75C6sdlByWxpYnb5Boif1VSFew==} + dev: false + /tailwind-merge/1.14.0: resolution: {integrity: sha512-3mFKyCo/MBcgyOTlrY8T7odzZFx+w+qKSMAmdFzRvqBfLlSigU6TZnlFHK0lkMwj9Bj8OYU+9yW9lmGuS0QEnQ==} dev: false @@ -4778,19 +5563,17 @@ packages: any-promise: 1.3.0 dev: true - /title/3.5.3: - resolution: {integrity: sha512-20JyowYglSEeCvZv3EZ0nZ046vLarO37prvV0mbtQV7C8DJPGgN967r8SJkqd3XK3K3lD3/Iyfp3avjfil8Q2Q==} - hasBin: true - dependencies: - arg: 1.0.0 - chalk: 2.3.0 - clipboardy: 1.2.2 - titleize: 1.0.0 + /tinyexec/0.3.2: + resolution: {integrity: sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==} dev: false - /titleize/1.0.0: - resolution: {integrity: sha512-TARUb7z1pGvlLxgPk++7wJ6aycXF3GJ0sNSBTAsTuJrQG5QuZlkUQP+zl+nbjAh4gMX9yDw9ZYklMd7vAfJKEw==} - engines: {node: '>=0.10.0'} + /title/4.0.1: + resolution: {integrity: sha512-xRnPkJx9nvE5MF6LkB5e8QJjE2FW8269wTu/LQdf7zZqBgPly0QJPf/CWAo7srj5so4yXfoLEdCFgurlpi47zg==} + hasBin: true + dependencies: + arg: 5.0.2 + chalk: 5.4.1 + clipboardy: 4.0.0 dev: false /to-regex-range/5.0.1: @@ -4821,9 +5604,35 @@ packages: resolution: {integrity: sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==} dev: false - /type-fest/1.4.0: - resolution: {integrity: sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==} - engines: {node: '>=10'} + /twoslash-protocol/0.2.12: + resolution: {integrity: sha512-5qZLXVYfZ9ABdjqbvPc4RWMr7PrpPaaDSeaYY55vl/w1j6H6kzsWK/urAEIXlzYlyrFmyz1UbwIt+AA0ck+wbg==} + dev: false + + /twoslash/0.2.12_typescript@5.7.3: + resolution: {integrity: sha512-tEHPASMqi7kqwfJbkk7hc/4EhlrKCSLcur+TcvYki3vhIfaRMXnXjaYFgXpoZRbT6GdprD4tGuVBEmTpUgLBsw==} + peerDependencies: + typescript: '*' + dependencies: + '@typescript/vfs': 1.6.0_typescript@5.7.3 + twoslash-protocol: 0.2.12 + typescript: 5.7.3 + transitivePeerDependencies: + - supports-color + dev: false + + /typedoc/0.27.6_typescript@5.7.3: + resolution: {integrity: sha512-oBFRoh2Px6jFx366db0lLlihcalq/JzyCVp7Vaq1yphL/tbgx2e+bkpkCgJPunaPvPwoTOXSwasfklWHm7GfAw==} + engines: {node: '>= 18'} + hasBin: true + peerDependencies: + typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x + dependencies: + '@gerrit0/mini-shiki': 1.27.2 + lunr: 2.3.9 + markdown-it: 14.1.0 + minimatch: 9.0.5 + typescript: 5.7.3 + yaml: 2.7.0 dev: false /typescript/5.7.3: @@ -4832,16 +5641,24 @@ packages: hasBin: true dev: true - /unified/10.1.2: - resolution: {integrity: sha512-pUSWAi/RAnVy1Pif2kAoeWNBa3JVrx0MId2LASj8G+7AiHWoKZNTomq6LG326T68U7/e263X6fTdcXIy7XnF7Q==} + /uc.micro/2.1.0: + resolution: {integrity: sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==} + dev: false + + /ufo/1.5.4: + resolution: {integrity: sha512-UsUk3byDzKd04EyoZ7U4DOlxQaD14JUKQl6/P7wiX4FNvUfm3XL246n9W5AmqwW5RSFJ27NAuM0iLscAOYUiGQ==} + dev: false + + /unified/11.0.5: + resolution: {integrity: sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==} dependencies: - '@types/unist': 2.0.11 + '@types/unist': 3.0.3 bail: 2.0.2 + devlop: 1.1.0 extend: 3.0.2 - is-buffer: 2.0.5 is-plain-obj: 4.1.0 trough: 2.2.0 - vfile: 5.3.7 + vfile: 6.0.3 dev: false /unist-util-find-after/5.0.0: @@ -4851,10 +5668,6 @@ packages: unist-util-is: 6.0.0 dev: false - /unist-util-generated/2.0.1: - resolution: {integrity: sha512-qF72kLmPxAw0oN2fwpWIqbXAVyEqUzDHMsbtPvOudIlUzXYFIeQIuxXQCRCFh22B7cixvU0MG7m3MW8FTq/S+A==} - dev: false - /unist-util-is/5.2.1: resolution: {integrity: sha512-u9njyyfEh43npf1M+yGKDGVPbY/JWEemg5nH05ncKPfi+kBbKBJoTdsogMu33uhytuLlv9y0O7GH7fEdwLdLQw==} dependencies: @@ -4867,16 +5680,17 @@ packages: '@types/unist': 3.0.3 dev: false - /unist-util-position-from-estree/1.1.2: - resolution: {integrity: sha512-poZa0eXpS+/XpoQwGwl79UUdea4ol2ZuCYguVaJS4qzIOMDzbqz8a3erUCOmubSZkaOuGamb3tX790iwOIROww==} + /unist-util-modify-children/4.0.0: + resolution: {integrity: sha512-+tdN5fGNddvsQdIzUF3Xx82CU9sMM+fA0dLgR9vOmT0oPT2jH+P1nd5lSqfCfXAw+93NhcXNY2qqvTUtE4cQkw==} dependencies: - '@types/unist': 2.0.11 + '@types/unist': 3.0.3 + array-iterate: 2.0.1 dev: false - /unist-util-position/4.0.4: - resolution: {integrity: sha512-kUBE91efOWfIVBo8xzh/uZQ7p9ffYRtUbMRZBNFYwf0RK8koUMx6dGUfwylLOKmaT2cs4wSW96QoYUSXAyEtpg==} + /unist-util-position-from-estree/2.0.0: + resolution: {integrity: sha512-KaFVRjoqLyF6YXCbVLNad/eS4+OfPQQn2yOd7zF/h5T/CSL2v8NpN6a5TPvtbXthAGw5nG+PuTtq+DdIZr+cRQ==} dependencies: - '@types/unist': 2.0.11 + '@types/unist': 3.0.3 dev: false /unist-util-position/5.0.0: @@ -4885,13 +5699,6 @@ packages: '@types/unist': 3.0.3 dev: false - /unist-util-remove-position/4.0.2: - resolution: {integrity: sha512-TkBb0HABNmxzAcfLf4qsIbFbaPDvMO6wa3b3j4VcEzFVaw1LBKwnW4/sRJ/atSLSzoIg41JWEdnE7N6DIhGDGQ==} - dependencies: - '@types/unist': 2.0.11 - unist-util-visit: 4.1.2 - dev: false - /unist-util-remove-position/5.0.0: resolution: {integrity: sha512-Hp5Kh3wLxv0PHj9m2yZhhLt58KzPtEYKQQ4yxfYFEO7EvHwzyDYnduhHnY1mDxoqr7VUwVuHXk9RXKIiYS1N8Q==} dependencies: @@ -4907,27 +5714,20 @@ packages: unist-util-visit-parents: 6.0.1 dev: false - /unist-util-stringify-position/3.0.3: - resolution: {integrity: sha512-k5GzIBZ/QatR8N5X2y+drfpWG8IDBzdnVj6OInRNWm1oXrzydiaAT2OQiA8DPRRZyAKb9b6I2a6PxYklZD0gKg==} - dependencies: - '@types/unist': 2.0.11 - dev: false - /unist-util-stringify-position/4.0.0: resolution: {integrity: sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==} dependencies: '@types/unist': 3.0.3 dev: false - /unist-util-visit-parents/4.1.1: - resolution: {integrity: sha512-1xAFJXAKpnnJl8G7K5KgU7FY55y3GcLIXqkzUj5QF/QVP7biUm0K0O2oqVkYsdjzJKifYeWn9+o6piAK2hGSHw==} + /unist-util-visit-children/3.0.0: + resolution: {integrity: sha512-RgmdTfSBOg04sdPcpTSD1jzoNBjt9a80/ZCzp5cI9n1qPzLZWF9YdvWGN2zmTumP1HWhXKdUWexjy/Wy/lJ7tA==} dependencies: - '@types/unist': 2.0.11 - unist-util-is: 5.2.1 + '@types/unist': 3.0.3 dev: false - /unist-util-visit-parents/5.1.3: - resolution: {integrity: sha512-x6+y8g7wWMyQhL1iZfhIPhDAs7Xwbn9nRosDXl7qoPTSCy0yNxnKc+hWokFifWQIDGi154rdUqKvbCa4+1kLhg==} + /unist-util-visit-parents/4.1.1: + resolution: {integrity: sha512-1xAFJXAKpnnJl8G7K5KgU7FY55y3GcLIXqkzUj5QF/QVP7biUm0K0O2oqVkYsdjzJKifYeWn9+o6piAK2hGSHw==} dependencies: '@types/unist': 2.0.11 unist-util-is: 5.2.1 @@ -4948,14 +5748,6 @@ packages: unist-util-visit-parents: 4.1.1 dev: false - /unist-util-visit/4.1.2: - resolution: {integrity: sha512-MSd8OUGISqHdVvfY9TPhyK2VdUrPgxkUtWSuMHF6XAAFuL4LokseigBnZtPnJMu+FbynTkFNnFlyjxpVKujMRg==} - dependencies: - '@types/unist': 2.0.11 - unist-util-is: 5.2.1 - unist-util-visit-parents: 5.1.3 - dev: false - /unist-util-visit/5.0.0: resolution: {integrity: sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==} dependencies: @@ -4975,7 +5767,7 @@ packages: picocolors: 1.1.1 dev: true - /use-callback-ref/1.3.3_react@18.3.1: + /use-callback-ref/1.3.3_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-jQL3lRnocaFtu3V00JToYz/4QkNWswxijDaCVNZRiRTO3HQDLsdu1ZtmIUvV4yPp+rvWm5j0y0TG/S61cuijTg==} engines: {node: '>=10'} peerDependencies: @@ -4985,11 +5777,12 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 react: 18.3.1 tslib: 2.8.1 dev: false - /use-sidecar/1.1.3_react@18.3.1: + /use-sidecar/1.1.3_@types+react@19.0.8+react@18.3.1: resolution: {integrity: sha512-Fedw0aZvkhynoPYlA5WXrMCAMm+nSWdZt6lzJQ7Ok8S6Q+VsHmHpRWndVRJ8Be0ZbkfPc5LRYH+5XrzXcEeLRQ==} engines: {node: '>=10'} peerDependencies: @@ -4999,6 +5792,7 @@ packages: '@types/react': optional: true dependencies: + '@types/react': 19.0.8 detect-node-es: 1.1.0 react: 18.3.1 tslib: 2.8.1 @@ -5013,17 +5807,6 @@ packages: hasBin: true dev: false - /uvu/0.5.6: - resolution: {integrity: sha512-+g8ENReyr8YsOc6fv/NVJs2vFdHBnBNdfE49rshrTzDWOlUx4Gq7KOS2GD8eqhy2j+Ejq29+SbKH8yjkAqXqoA==} - engines: {node: '>=8'} - hasBin: true - dependencies: - dequal: 2.0.3 - diff: 5.2.0 - kleur: 4.1.5 - sade: 1.8.1 - dev: false - /vfile-location/5.0.3: resolution: {integrity: sha512-5yXvWDEgqeiYiBe1lbxYF7UMAIm/IcopxMHrMQDq3nvKcjPKIhZklUKL+AE7J7uApI4kwe2snsK+eI6UTj9EHg==} dependencies: @@ -5031,21 +5814,6 @@ packages: vfile: 6.0.3 dev: false - /vfile-matter/3.0.1: - resolution: {integrity: sha512-CAAIDwnh6ZdtrqAuxdElUqQRQDQgbbIrYtDYI8gCjXS1qQ+1XdLoK8FIZWxJwn0/I+BkSSZpar3SOgjemQz4fg==} - dependencies: - '@types/js-yaml': 4.0.9 - is-buffer: 2.0.5 - js-yaml: 4.1.0 - dev: false - - /vfile-message/3.1.4: - resolution: {integrity: sha512-fa0Z6P8HUrQN4BZaX05SIVXic+7kE3b05PWAtPuYP9QLHsLKYR7/AlLW3NtOrpXRLeawpDLMsVkmk5DG0NXgWw==} - dependencies: - '@types/unist': 2.0.11 - unist-util-stringify-position: 3.0.3 - dev: false - /vfile-message/4.0.2: resolution: {integrity: sha512-jRDZ1IMLttGj41KcZvlrYAaI3CfqpLpfpf+Mfig13viT6NKvRzWZ+lXz0Y5D60w6uJIBAOGq9mSHf0gktF0duw==} dependencies: @@ -5053,15 +5821,6 @@ packages: unist-util-stringify-position: 4.0.0 dev: false - /vfile/5.3.7: - resolution: {integrity: sha512-r7qlzkgErKjobAmyNIkkSpizsFPYiUPuJb5pNW1RB4JcYVZhs4lIbVqk8XPk033CV/1z8ss5pkax8SuhGpcG8g==} - dependencies: - '@types/unist': 2.0.11 - is-buffer: 2.0.5 - unist-util-stringify-position: 3.0.3 - vfile-message: 3.1.4 - dev: false - /vfile/6.0.3: resolution: {integrity: sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==} dependencies: @@ -5069,12 +5828,35 @@ packages: vfile-message: 4.0.2 dev: false - /vscode-oniguruma/1.7.0: - resolution: {integrity: sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==} + /vscode-jsonrpc/8.2.0: + resolution: {integrity: sha512-C+r0eKJUIfiDIfwJhria30+TYWPtuHJXHtI7J0YlOmKAo7ogxP20T0zxB7HZQIFhIyvoBPwWskjxrvAtfjyZfA==} + engines: {node: '>=14.0.0'} + dev: false + + /vscode-languageserver-protocol/3.17.5: + resolution: {integrity: sha512-mb1bvRJN8SVznADSGWM9u/b07H7Ecg0I3OgXDuLdn307rl/J3A9YD6/eYOssqhecL27hK1IPZAsaqh00i/Jljg==} + dependencies: + vscode-jsonrpc: 8.2.0 + vscode-languageserver-types: 3.17.5 + dev: false + + /vscode-languageserver-textdocument/1.0.12: + resolution: {integrity: sha512-cxWNPesCnQCcMPeenjKKsOCKQZ/L6Tv19DTRIGuLWe32lyzWhihGVJ/rcckZXJxfdKCFvRLS3fpBIsV/ZGX4zA==} + dev: false + + /vscode-languageserver-types/3.17.5: + resolution: {integrity: sha512-Ld1VelNuX9pdF39h2Hgaeb5hEZM2Z3jUrrMgWQAu82jMtZp7p3vJT3BzToKtZI7NgQssZje5o0zryOrhQvzQAg==} + dev: false + + /vscode-languageserver/9.0.1: + resolution: {integrity: sha512-woByF3PDpkHFUreUa7Hos7+pUWdeWMXRd26+ZX2A8cFx6v/JPTtd4/uN0/jB6XQHYaOlHbio03NTHCqrgG5n7g==} + hasBin: true + dependencies: + vscode-languageserver-protocol: 3.17.5 dev: false - /vscode-textmate/8.0.0: - resolution: {integrity: sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==} + /vscode-uri/3.0.8: + resolution: {integrity: sha512-AyFQ0EVmsOZOlAnxoFOGOq1SQDWAB7C6aqMGS23svWAllfOaxbuFvcT8D1i8z3Gyn8fraVeZNNmN6e9bxxXkKw==} dev: false /watchpack/2.4.0: @@ -5089,24 +5871,16 @@ packages: resolution: {integrity: sha512-bKr1DkiNa2krS7qxNtdrtHAmzuYGFQLiQ13TsorsdT6ULTkPLKuu5+GsFpDlg6JFjUTwX2DyhMPG2be8uPrqsQ==} dev: false - /web-worker/1.3.0: - resolution: {integrity: sha512-BSR9wyRsy/KOValMgd5kMyr3JzpdeoR9KVId8u5GVlTTAtNChlsE4yTxeY7zMdNSyOmoKBv8NH2qeRY9Tg+IaA==} - dev: false - - /which/1.3.1: - resolution: {integrity: sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==} - hasBin: true - dependencies: - isexe: 2.0.0 - dev: false - /which/2.0.2: resolution: {integrity: sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==} engines: {node: '>= 8'} hasBin: true dependencies: isexe: 2.0.0 - dev: true + + /wicked-good-xpath/1.3.0: + resolution: {integrity: sha512-Gd9+TUn5nXdwj/hFsPVx5cuHHiF5Bwuc30jZ4+ronF1qHK5O7HD0sgmXWSEgwKquT3ClLoKPVbO6qGwVwLzvAw==} + dev: false /wrap-ansi/7.0.0: resolution: {integrity: sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==} @@ -5126,19 +5900,19 @@ packages: strip-ansi: 7.1.0 dev: true - /yallist/2.1.2: - resolution: {integrity: sha512-ncTzHV7NvsQZkYe1DW7cbDLm0YpzHmZF5r/iyP3ZnQtMiJ+pjzisCiMNI+Sj+xQF5pXhSHxSB3uDbsBTzY/c2A==} + /xmldom-sre/0.1.31: + resolution: {integrity: sha512-f9s+fUkX04BxQf+7mMWAp5zk61pciie+fFLC9hX9UVvCeJQfNHRHXpeo5MPcR0EUf57PYLdt+ZO4f3Ipk2oZUw==} + engines: {node: '>=0.1'} dev: false /yaml/2.7.0: resolution: {integrity: sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA==} engines: {node: '>= 14'} hasBin: true - dev: true - /yocto-queue/0.1.0: - resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==} - engines: {node: '>=10'} + /yocto-queue/1.1.1: + resolution: {integrity: sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g==} + engines: {node: '>=12.20'} dev: false /youtube-player/5.5.2: @@ -5149,6 +5923,15 @@ packages: sister: 3.0.2 dev: false + /zod-validation-error/3.4.0_zod@3.24.1: + resolution: {integrity: sha512-ZOPR9SVY6Pb2qqO5XHt+MkkTRxGXb4EVtnjc9JpXUOtUB1T9Ru7mZOT361AN3MsetVe7R0a1KZshJDZdgp9miQ==} + engines: {node: '>=18.0.0'} + peerDependencies: + zod: ^3.18.0 + dependencies: + zod: 3.24.1 + dev: false + /zod/3.24.1: resolution: {integrity: sha512-muH7gBL9sI1nciMZV67X5fTKKBLtwpZ5VBp1vsOQzj1MhrBZ4wlVCm3gedKZWLp0Oyel8sIGfeiz54Su+OVT+A==} dev: false diff --git a/src/pages/_app.mdx b/src/pages/_app.mdx deleted file mode 100644 index 3144c67..0000000 --- a/src/pages/_app.mdx +++ /dev/null @@ -1,11 +0,0 @@ -import { AppProps } from 'next/app' -import { ThemeProvider } from 'next-themes' -import { Toaster } from "@/components/ui/toaster" -import '@/assets/globals.css' - -export default function MyApp({ Component, pageProps }) { - return - - - -} diff --git a/src/pages/_app.tsx b/src/pages/_app.tsx new file mode 100644 index 0000000..7be289b --- /dev/null +++ b/src/pages/_app.tsx @@ -0,0 +1,13 @@ +import { AppProps } from "next/app"; +import { ThemeProvider } from "next-themes"; +import { Toaster } from "@/components/ui/toaster"; +import "@/assets/globals.css"; + +export default function MyApp({ Component, pageProps }) { + return ( + + + + + ); +} diff --git a/src/pages/_meta.json b/src/pages/_meta.json deleted file mode 100644 index a4dce1b..0000000 --- a/src/pages/_meta.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "index": { - "title": "Home", - "display": "hidden", - "type": "page", - "theme": { - "layout": "raw" - } - }, - "docs": { - "title": "Docs", - "type": "page", - "href": "/docs/what-is-protokit" - }, - "blog": { - "display": "hidden" - }, - "contact": { - "title": "Discord ↗", - "type": "page", - "href": "https://discord.gg/AMGnGAxsKp", - "newWindow": true - } -} diff --git a/src/pages/_meta.tsx b/src/pages/_meta.tsx new file mode 100644 index 0000000..7dcbb0f --- /dev/null +++ b/src/pages/_meta.tsx @@ -0,0 +1,24 @@ +export default { + index: { + title: "Home", + display: "hidden", + type: "page", + theme: { + layout: "raw", + }, + }, + docs: { + title: "Docs", + type: "page", + href: "/docs/what-is-protokit", + }, + // blog: { + // display: "hidden", + // }, + contact: { + title: "Discord ↗", + type: "page", + href: "https://discord.gg/AMGnGAxsKp", + newWindow: true, + }, +}; diff --git a/src/pages/docs/_meta.json b/src/pages/docs/_meta.json deleted file mode 100644 index a35d023..0000000 --- a/src/pages/docs/_meta.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "-- Introduction": { - "type": "separator", - "title": "Introduction" - }, - "what-is-protokit": "What is Protokit?", - "architecture": "Architecture", - "faq": "FAQ", - "-- Developer Documentation": { - "type": "separator", - "title": "Developer Documentation" - }, - "provable-code": "Provable code", - "quickstart": "Quickstart", - "runtime": "Runtime", - "library": "Library", - "advanced": "Advanced", - "tutorials": "Tutorials", - "-- Contributor Documentation": { - "type": "separator", - "title": "Contributor Documentation" - }, - "common": "Common", - "workers": "Worker Architecture", - "provable-events": "Provable Events" -} diff --git a/src/pages/docs/_meta.tsx b/src/pages/docs/_meta.tsx new file mode 100644 index 0000000..7442f79 --- /dev/null +++ b/src/pages/docs/_meta.tsx @@ -0,0 +1,27 @@ +export default { + "-- Introduction": { + type: "separator", + title: "Introduction", + }, + "what-is-protokit": "What is Protokit?", + architecture: "Architecture", + faq: "FAQ", + "-- Developer Documentation": { + type: "separator", + title: "Developer Documentation", + }, + "provable-code": "Provable code", + quickstart: "Quickstart", + runtime: "Runtime", + library: "Library", + advanced: "Advanced", + tutorials: "Tutorials", + "-- Contributor Documentation": { + type: "separator", + title: "Contributor Documentation", + }, + common: "Common", + workers: "Worker Architecture", + "provable-events": "Provable Events", + reference: "Reference", +}; diff --git a/src/pages/docs/advanced/_meta.json b/src/pages/docs/advanced/_meta.json deleted file mode 100644 index bad387e..0000000 --- a/src/pages/docs/advanced/_meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "state-proofs": "State proofs", - "protocol": "Customizing the protocol" -} \ No newline at end of file diff --git a/src/pages/docs/advanced/_meta.tsx b/src/pages/docs/advanced/_meta.tsx new file mode 100644 index 0000000..6db9860 --- /dev/null +++ b/src/pages/docs/advanced/_meta.tsx @@ -0,0 +1,4 @@ +export default { + "state-proofs": "State proofs", + protocol: "Customizing the protocol", +}; diff --git a/src/pages/docs/architecture.mdx b/src/pages/docs/architecture.mdx index 4371df4..4f5516e 100644 --- a/src/pages/docs/architecture.mdx +++ b/src/pages/docs/architecture.mdx @@ -1,4 +1,4 @@ -import { Callout, Cards, Card } from 'nextra/components' +import { Callout, Cards } from 'nextra/components' import { ExternalLink } from 'lucide-react' # Architecture @@ -53,7 +53,7 @@ Both of these share a portion of the app-chain definition, such as the runtime. As mentioned previously, the app-chain is composed of 3 additional layers 👇 - } title="Runtime" href="/docs/architecture/runtime"/> - } title="Protocol" href="/docs/architecture/protocol"/> - } title="Sequencer" href="/docs/architecture/sequencer"/> + } title="Runtime" href="/docs/architecture/runtime"/> + } title="Protocol" href="/docs/architecture/protocol"/> + } title="Sequencer" href="/docs/architecture/sequencer"/> diff --git a/src/pages/docs/architecture/_meta.json b/src/pages/docs/architecture/_meta.json deleted file mode 100644 index 07b8db2..0000000 --- a/src/pages/docs/architecture/_meta.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "runtime": "Runtime", - "protocol": "Protocol", - "sequencer": "Sequencer" -} diff --git a/src/pages/docs/architecture/_meta.tsx b/src/pages/docs/architecture/_meta.tsx new file mode 100644 index 0000000..e480ad7 --- /dev/null +++ b/src/pages/docs/architecture/_meta.tsx @@ -0,0 +1,5 @@ +export default { + runtime: "Runtime", + protocol: "Protocol", + sequencer: "Sequencer", +}; diff --git a/src/pages/docs/common/_meta.json b/src/pages/docs/common/_meta.json deleted file mode 100644 index 5c0bc88..0000000 --- a/src/pages/docs/common/_meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "modularity-configuration": "Modularity & Configuration" -} diff --git a/src/pages/docs/common/_meta.tsx b/src/pages/docs/common/_meta.tsx new file mode 100644 index 0000000..7c25b7c --- /dev/null +++ b/src/pages/docs/common/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "modularity-configuration": "Modularity & Configuration", +}; diff --git a/src/pages/docs/library/_meta.json b/src/pages/docs/library/_meta.json deleted file mode 100644 index ba7ebac..0000000 --- a/src/pages/docs/library/_meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "math": "Math" -} diff --git a/src/pages/docs/library/_meta.tsx b/src/pages/docs/library/_meta.tsx new file mode 100644 index 0000000..d2c88a4 --- /dev/null +++ b/src/pages/docs/library/_meta.tsx @@ -0,0 +1,3 @@ +export default { + math: "Math", +}; diff --git a/src/pages/docs/quickstart/_meta.json b/src/pages/docs/quickstart/_meta.tsx similarity index 60% rename from src/pages/docs/quickstart/_meta.json rename to src/pages/docs/quickstart/_meta.tsx index f5994f4..e7d3446 100644 --- a/src/pages/docs/quickstart/_meta.json +++ b/src/pages/docs/quickstart/_meta.tsx @@ -1,7 +1,7 @@ -{ +export default { "app-chain": "App-chain's runtime", - "configuration": "Configuration", + configuration: "Configuration", "first-runtime-module": "Implementing runtime modules", "client-interaction": "Client interaction", - "user-interface": "User interface" -} + "user-interface": "User interface", +}; diff --git a/src/pages/docs/reference/_meta.tsx b/src/pages/docs/reference/_meta.tsx new file mode 100644 index 0000000..c34b10d --- /dev/null +++ b/src/pages/docs/reference/_meta.tsx @@ -0,0 +1,14 @@ +export default { + api: "API", + common: "Common", + deployment: "Deployment", + indexer: "Indexer", + library: "Library", + module: "Module", + persistance: "Persistance", + processor: "Processor", + protocol: "Protocol", + sdk: "SDK", + sequencer: "Sequencer", + stack: "Stack", +}; diff --git a/src/pages/docs/reference/api/README.md b/src/pages/docs/reference/api/README.md new file mode 100644 index 0000000..5415109 --- /dev/null +++ b/src/pages/docs/reference/api/README.md @@ -0,0 +1,51 @@ +--- +title: "@proto-kit/api" +--- + +**@proto-kit/api** + +*** + +[Documentation](../../README.md) / @proto-kit/api + +# @proto-kit/api + +## Classes + +- [AdvancedNodeStatusResolver](classes/AdvancedNodeStatusResolver.md) +- [BatchStorageResolver](classes/BatchStorageResolver.md) +- [BlockModel](classes/BlockModel.md) +- [BlockResolver](classes/BlockResolver.md) +- [ComputedBlockModel](classes/ComputedBlockModel.md) +- [GraphqlModule](classes/GraphqlModule.md) +- [GraphqlSequencerModule](classes/GraphqlSequencerModule.md) +- [GraphqlServer](classes/GraphqlServer.md) +- [MempoolResolver](classes/MempoolResolver.md) +- [MerkleWitnessDTO](classes/MerkleWitnessDTO.md) +- [MerkleWitnessResolver](classes/MerkleWitnessResolver.md) +- [NodeInformationObject](classes/NodeInformationObject.md) +- [NodeStatusObject](classes/NodeStatusObject.md) +- [NodeStatusResolver](classes/NodeStatusResolver.md) +- [NodeStatusService](classes/NodeStatusService.md) +- [ProcessInformationObject](classes/ProcessInformationObject.md) +- [QueryGraphqlModule](classes/QueryGraphqlModule.md) +- [ResolverFactoryGraphqlModule](classes/ResolverFactoryGraphqlModule.md) +- [SchemaGeneratingGraphqlModule](classes/SchemaGeneratingGraphqlModule.md) +- [Signature](classes/Signature.md) +- [TransactionObject](classes/TransactionObject.md) +- [VanillaGraphqlModules](classes/VanillaGraphqlModules.md) + +## Interfaces + +- [GraphqlModulesDefintion](interfaces/GraphqlModulesDefintion.md) +- [NodeInformation](interfaces/NodeInformation.md) +- [ProcessInformation](interfaces/ProcessInformation.md) + +## Type Aliases + +- [GraphqlModulesRecord](type-aliases/GraphqlModulesRecord.md) +- [VanillaGraphqlModulesRecord](type-aliases/VanillaGraphqlModulesRecord.md) + +## Functions + +- [graphqlModule](functions/graphqlModule.md) diff --git a/src/pages/docs/reference/api/_meta.tsx b/src/pages/docs/reference/api/_meta.tsx new file mode 100644 index 0000000..a31554d --- /dev/null +++ b/src/pages/docs/reference/api/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md b/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md new file mode 100644 index 0000000..a09ce63 --- /dev/null +++ b/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md @@ -0,0 +1,124 @@ +--- +title: AdvancedNodeStatusResolver +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / AdvancedNodeStatusResolver + +# Class: AdvancedNodeStatusResolver + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L74) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`GraphqlModule`](GraphqlModule.md) + +## Constructors + +### new AdvancedNodeStatusResolver() + +> **new AdvancedNodeStatusResolver**(`nodeStatusService`): [`AdvancedNodeStatusResolver`](AdvancedNodeStatusResolver.md) + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L75) + +#### Parameters + +##### nodeStatusService + +[`NodeStatusService`](NodeStatusService.md) + +#### Returns + +[`AdvancedNodeStatusResolver`](AdvancedNodeStatusResolver.md) + +#### Overrides + +[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) + +*** + +### node() + +> **node**(): `Promise`\<[`NodeStatusObject`](NodeStatusObject.md)\> + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L83) + +#### Returns + +`Promise`\<[`NodeStatusObject`](NodeStatusObject.md)\> diff --git a/src/pages/docs/reference/api/classes/BatchStorageResolver.md b/src/pages/docs/reference/api/classes/BatchStorageResolver.md new file mode 100644 index 0000000..7c9492e --- /dev/null +++ b/src/pages/docs/reference/api/classes/BatchStorageResolver.md @@ -0,0 +1,134 @@ +--- +title: BatchStorageResolver +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / BatchStorageResolver + +# Class: BatchStorageResolver + +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L41) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`GraphqlModule`](GraphqlModule.md) + +## Constructors + +### new BatchStorageResolver() + +> **new BatchStorageResolver**(`batchStorage`, `blockResolver`): [`BatchStorageResolver`](BatchStorageResolver.md) + +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L43) + +#### Parameters + +##### batchStorage + +[`BatchStorage`](../../sequencer/interfaces/BatchStorage.md) & [`HistoricalBatchStorage`](../../sequencer/interfaces/HistoricalBatchStorage.md) + +##### blockResolver + +[`BlockResolver`](BlockResolver.md) + +#### Returns + +[`BatchStorageResolver`](BatchStorageResolver.md) + +#### Overrides + +[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) + +## Methods + +### batches() + +> **batches**(`height`): `Promise`\<`undefined` \| [`ComputedBlockModel`](ComputedBlockModel.md)\> + +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L56) + +#### Parameters + +##### height + +`undefined` | `number` + +#### Returns + +`Promise`\<`undefined` \| [`ComputedBlockModel`](ComputedBlockModel.md)\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) diff --git a/src/pages/docs/reference/api/classes/BlockModel.md b/src/pages/docs/reference/api/classes/BlockModel.md new file mode 100644 index 0000000..c6c66d7 --- /dev/null +++ b/src/pages/docs/reference/api/classes/BlockModel.md @@ -0,0 +1,71 @@ +--- +title: BlockModel +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / BlockModel + +# Class: BlockModel + +Defined in: [api/src/graphql/modules/BlockResolver.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L14) + +## Properties + +### hash + +> **hash**: `string` + +Defined in: [api/src/graphql/modules/BlockResolver.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L32) + +*** + +### height + +> **height**: `number` + +Defined in: [api/src/graphql/modules/BlockResolver.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L38) + +*** + +### previousBlockHash + +> **previousBlockHash**: `undefined` \| `string` + +Defined in: [api/src/graphql/modules/BlockResolver.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L35) + +*** + +### transactionsHash + +> **transactionsHash**: `string` + +Defined in: [api/src/graphql/modules/BlockResolver.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L44) + +*** + +### txs + +> **txs**: `BatchTransactionModel`[] + +Defined in: [api/src/graphql/modules/BlockResolver.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L41) + +## Methods + +### fromServiceLayerModel() + +> `static` **fromServiceLayerModel**(`block`): [`BlockModel`](BlockModel.md) + +Defined in: [api/src/graphql/modules/BlockResolver.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L15) + +#### Parameters + +##### block + +[`Block`](../../sequencer/interfaces/Block.md) + +#### Returns + +[`BlockModel`](BlockModel.md) diff --git a/src/pages/docs/reference/api/classes/BlockResolver.md b/src/pages/docs/reference/api/classes/BlockResolver.md new file mode 100644 index 0000000..8ada325 --- /dev/null +++ b/src/pages/docs/reference/api/classes/BlockResolver.md @@ -0,0 +1,134 @@ +--- +title: BlockResolver +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / BlockResolver + +# Class: BlockResolver + +Defined in: [api/src/graphql/modules/BlockResolver.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L62) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`GraphqlModule`](GraphqlModule.md)\<`object`\> + +## Constructors + +### new BlockResolver() + +> **new BlockResolver**(`blockStorage`): [`BlockResolver`](BlockResolver.md) + +Defined in: [api/src/graphql/modules/BlockResolver.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L63) + +#### Parameters + +##### blockStorage + +[`HistoricalBlockStorage`](../../sequencer/interfaces/HistoricalBlockStorage.md) & [`BlockStorage`](../../sequencer/interfaces/BlockStorage.md) + +#### Returns + +[`BlockResolver`](BlockResolver.md) + +#### Overrides + +[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `object` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) + +## Methods + +### block() + +> **block**(`height`, `hash`): `Promise`\<`undefined` \| [`BlockModel`](BlockModel.md)\> + +Defined in: [api/src/graphql/modules/BlockResolver.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L75) + +#### Parameters + +##### height + +`undefined` | `number` + +##### hash + +`undefined` | `string` + +#### Returns + +`Promise`\<`undefined` \| [`BlockModel`](BlockModel.md)\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) diff --git a/src/pages/docs/reference/api/classes/ComputedBlockModel.md b/src/pages/docs/reference/api/classes/ComputedBlockModel.md new file mode 100644 index 0000000..7d74711 --- /dev/null +++ b/src/pages/docs/reference/api/classes/ComputedBlockModel.md @@ -0,0 +1,73 @@ +--- +title: ComputedBlockModel +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / ComputedBlockModel + +# Class: ComputedBlockModel + +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L15) + +## Constructors + +### new ComputedBlockModel() + +> **new ComputedBlockModel**(`blocks`, `proof`): [`ComputedBlockModel`](ComputedBlockModel.md) + +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L34) + +#### Parameters + +##### blocks + +[`BlockModel`](BlockModel.md)[] + +##### proof + +`string` + +#### Returns + +[`ComputedBlockModel`](ComputedBlockModel.md) + +## Properties + +### blocks + +> **blocks**: [`BlockModel`](BlockModel.md)[] + +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L29) + +*** + +### proof + +> **proof**: `string` + +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L32) + +## Methods + +### fromServiceLayerModel() + +> `static` **fromServiceLayerModel**(`__namedParameters`, `blocks`): [`ComputedBlockModel`](ComputedBlockModel.md) + +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L16) + +#### Parameters + +##### \_\_namedParameters + +[`Batch`](../../sequencer/interfaces/Batch.md) + +##### blocks + +(`undefined` \| [`BlockModel`](BlockModel.md))[] + +#### Returns + +[`ComputedBlockModel`](ComputedBlockModel.md) diff --git a/src/pages/docs/reference/api/classes/GraphqlModule.md b/src/pages/docs/reference/api/classes/GraphqlModule.md new file mode 100644 index 0000000..9e296fa --- /dev/null +++ b/src/pages/docs/reference/api/classes/GraphqlModule.md @@ -0,0 +1,121 @@ +--- +title: GraphqlModule +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / GraphqlModule + +# Class: `abstract` GraphqlModule\ + +Defined in: [api/src/graphql/GraphqlModule.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L8) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> + +## Extended by + +- [`MempoolResolver`](MempoolResolver.md) +- [`BatchStorageResolver`](BatchStorageResolver.md) +- [`BlockResolver`](BlockResolver.md) +- [`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md) +- [`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md) +- [`NodeStatusResolver`](NodeStatusResolver.md) +- [`AdvancedNodeStatusResolver`](AdvancedNodeStatusResolver.md) +- [`MerkleWitnessResolver`](MerkleWitnessResolver.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +## Constructors + +### new GraphqlModule() + +> **new GraphqlModule**\<`Config`\>(): [`GraphqlModule`](GraphqlModule.md)\<`Config`\> + +Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L11) + +#### Returns + +[`GraphqlModule`](GraphqlModule.md)\<`Config`\> + +#### Overrides + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) diff --git a/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md b/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md new file mode 100644 index 0000000..319db14 --- /dev/null +++ b/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md @@ -0,0 +1,662 @@ +--- +title: GraphqlSequencerModule +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / GraphqlSequencerModule + +# Class: GraphqlSequencerModule\ + +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L33) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`GraphQLModules`\> + +## Type Parameters + +• **GraphQLModules** *extends* [`GraphqlModulesRecord`](../type-aliases/GraphqlModulesRecord.md) + +## Implements + +- [`Configurable`](../../common/interfaces/Configurable.md)\<`unknown`\> +- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`unknown`\> +- [`Closeable`](../../sequencer/interfaces/Closeable.md) + +## Constructors + +### new GraphqlSequencerModule() + +> **new GraphqlSequencerModule**\<`GraphQLModules`\>(`definition`): [`GraphqlSequencerModule`](GraphqlSequencerModule.md)\<`GraphQLModules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:68 + +#### Parameters + +##### definition + +[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`GraphQLModules`\> + +#### Returns + +[`GraphqlSequencerModule`](GraphqlSequencerModule.md)\<`GraphQLModules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`GraphQLModules`\> + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Implementation of + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) + +*** + +### definition + +> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`GraphQLModules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:60 + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Implementation of + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` + +Defined in: common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L98) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Closeable`](../../sequencer/interfaces/Closeable.md).[`close`](../../sequencer/interfaces/Closeable.md#close) + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`GraphQLModules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`GraphQLModules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L49) + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Implementation of + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) + +*** + +### decorateModule() + +> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:134 + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`GraphQLModules`\> + +##### containedModule + +`InstanceType`\<`GraphQLModules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`GraphQLModules`\>\]\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`GraphQLModules`\>[] + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` + +Defined in: common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +`GraphQLModules` + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`GraphQLModules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +`GraphQLModules` + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`GraphQLModules`\>\[`KeyType`\]\> + +Defined in: common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`GraphQLModules`\>\[`KeyType`\]\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L55) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`GraphQLModules`\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`GraphQLModules`\>(`definition`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](GraphqlSequencerModule.md)\<`GraphQLModules`\>\> + +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L37) + +#### Type Parameters + +• **GraphQLModules** *extends* [`GraphqlModulesRecord`](../type-aliases/GraphqlModulesRecord.md) + +#### Parameters + +##### definition + +[`GraphqlModulesDefintion`](../interfaces/GraphqlModulesDefintion.md)\<`GraphQLModules`\> + +#### Returns + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](GraphqlSequencerModule.md)\<`GraphQLModules`\>\> diff --git a/src/pages/docs/reference/api/classes/GraphqlServer.md b/src/pages/docs/reference/api/classes/GraphqlServer.md new file mode 100644 index 0000000..5f72b57 --- /dev/null +++ b/src/pages/docs/reference/api/classes/GraphqlServer.md @@ -0,0 +1,251 @@ +--- +title: GraphqlServer +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / GraphqlServer + +# Class: GraphqlServer + +Defined in: [api/src/graphql/GraphqlServer.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L30) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`GraphqlServerOptions`\> + +## Constructors + +### new GraphqlServer() + +> **new GraphqlServer**(): [`GraphqlServer`](GraphqlServer.md) + +#### Returns + +[`GraphqlServer`](GraphqlServer.md) + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`constructor`](../../sequencer/classes/SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `GraphqlServerOptions` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> + +Defined in: sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`presets`](../../sequencer/classes/SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [api/src/graphql/GraphqlServer.ts:148](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L148) + +#### Returns + +`Promise`\<`void`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) + +*** + +### registerModule() + +> **registerModule**(`module`): `void` + +Defined in: [api/src/graphql/GraphqlServer.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L55) + +#### Parameters + +##### module + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlModule`](GraphqlModule.md)\<`unknown`\>\> + +#### Returns + +`void` + +*** + +### registerResolvers() + +> **registerResolvers**(`resolvers`): `void` + +Defined in: [api/src/graphql/GraphqlServer.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L63) + +#### Parameters + +##### resolvers + +`NonEmptyArray`\<`Function`\> + +#### Returns + +`void` + +*** + +### registerSchema() + +> **registerSchema**(`schema`): `void` + +Defined in: [api/src/graphql/GraphqlServer.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L59) + +#### Parameters + +##### schema + +`GraphQLSchema` + +#### Returns + +`void` + +*** + +### setContainer() + +> **setContainer**(`container`): `void` + +Defined in: [api/src/graphql/GraphqlServer.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L43) + +#### Parameters + +##### container + +`DependencyContainer` + +#### Returns + +`void` + +*** + +### setContext() + +> **setContext**(`context`): `void` + +Defined in: [api/src/graphql/GraphqlServer.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L71) + +#### Parameters + +##### context + +#### Returns + +`void` + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [api/src/graphql/GraphqlServer.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L75) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) + +*** + +### startServer() + +> **startServer**(): `Promise`\<`void`\> + +Defined in: [api/src/graphql/GraphqlServer.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L79) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/api/classes/MempoolResolver.md b/src/pages/docs/reference/api/classes/MempoolResolver.md new file mode 100644 index 0000000..cfa7469 --- /dev/null +++ b/src/pages/docs/reference/api/classes/MempoolResolver.md @@ -0,0 +1,164 @@ +--- +title: MempoolResolver +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / MempoolResolver + +# Class: MempoolResolver + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:121](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L121) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`GraphqlModule`](GraphqlModule.md) + +## Constructors + +### new MempoolResolver() + +> **new MempoolResolver**(`mempool`, `transactionStorage`): [`MempoolResolver`](MempoolResolver.md) + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L122) + +#### Parameters + +##### mempool + +[`Mempool`](../../sequencer/interfaces/Mempool.md) + +##### transactionStorage + +[`TransactionStorage`](../../sequencer/interfaces/TransactionStorage.md) + +#### Returns + +[`MempoolResolver`](MempoolResolver.md) + +#### Overrides + +[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) + +*** + +### submitTx() + +> **submitTx**(`tx`): `Promise`\<`string`\> + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:133](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L133) + +#### Parameters + +##### tx + +[`TransactionObject`](TransactionObject.md) + +#### Returns + +`Promise`\<`string`\> + +*** + +### transactions() + +> **transactions**(): `Promise`\<`string`[]\> + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:169](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L169) + +#### Returns + +`Promise`\<`string`[]\> + +*** + +### transactionState() + +> **transactionState**(`hash`): `Promise`\<`InclusionStatus`\> + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L144) + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<`InclusionStatus`\> diff --git a/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md b/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md new file mode 100644 index 0000000..895c56b --- /dev/null +++ b/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md @@ -0,0 +1,69 @@ +--- +title: MerkleWitnessDTO +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / MerkleWitnessDTO + +# Class: MerkleWitnessDTO + +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L13) + +## Constructors + +### new MerkleWitnessDTO() + +> **new MerkleWitnessDTO**(`siblings`, `isLefts`): [`MerkleWitnessDTO`](MerkleWitnessDTO.md) + +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L20) + +#### Parameters + +##### siblings + +`string`[] + +##### isLefts + +`boolean`[] + +#### Returns + +[`MerkleWitnessDTO`](MerkleWitnessDTO.md) + +## Properties + +### isLefts + +> **isLefts**: `boolean`[] + +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L31) + +*** + +### siblings + +> **siblings**: `string`[] + +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L27) + +## Methods + +### fromServiceLayerObject() + +> `static` **fromServiceLayerObject**(`witness`): [`MerkleWitnessDTO`](MerkleWitnessDTO.md) + +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L14) + +#### Parameters + +##### witness + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) + +#### Returns + +[`MerkleWitnessDTO`](MerkleWitnessDTO.md) diff --git a/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md b/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md new file mode 100644 index 0000000..352369c --- /dev/null +++ b/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md @@ -0,0 +1,130 @@ +--- +title: MerkleWitnessResolver +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / MerkleWitnessResolver + +# Class: MerkleWitnessResolver + +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L35) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`GraphqlModule`](GraphqlModule.md)\<`object`\> + +## Constructors + +### new MerkleWitnessResolver() + +> **new MerkleWitnessResolver**(`treeStore`): [`MerkleWitnessResolver`](MerkleWitnessResolver.md) + +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L36) + +#### Parameters + +##### treeStore + +[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md) + +#### Returns + +[`MerkleWitnessResolver`](MerkleWitnessResolver.md) + +#### Overrides + +[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `object` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) + +*** + +### witness() + +> **witness**(`path`): `Promise`\<[`MerkleWitnessDTO`](MerkleWitnessDTO.md)\> + +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L46) + +#### Parameters + +##### path + +`string` + +#### Returns + +`Promise`\<[`MerkleWitnessDTO`](MerkleWitnessDTO.md)\> diff --git a/src/pages/docs/reference/api/classes/NodeInformationObject.md b/src/pages/docs/reference/api/classes/NodeInformationObject.md new file mode 100644 index 0000000..5cafff1 --- /dev/null +++ b/src/pages/docs/reference/api/classes/NodeInformationObject.md @@ -0,0 +1,69 @@ +--- +title: NodeInformationObject +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / NodeInformationObject + +# Class: NodeInformationObject + +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L10) + +## Constructors + +### new NodeInformationObject() + +> **new NodeInformationObject**(`blockHeight`, `batchHeight`): [`NodeInformationObject`](NodeInformationObject.md) + +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L21) + +#### Parameters + +##### blockHeight + +`number` + +##### batchHeight + +`number` + +#### Returns + +[`NodeInformationObject`](NodeInformationObject.md) + +## Properties + +### batchHeight + +> **batchHeight**: `number` + +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L19) + +*** + +### blockHeight + +> **blockHeight**: `number` + +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L16) + +## Methods + +### fromServiceLayerModel() + +> `static` **fromServiceLayerModel**(`status`): [`NodeInformationObject`](NodeInformationObject.md) + +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L11) + +#### Parameters + +##### status + +[`NodeInformation`](../interfaces/NodeInformation.md) + +#### Returns + +[`NodeInformationObject`](NodeInformationObject.md) diff --git a/src/pages/docs/reference/api/classes/NodeStatusObject.md b/src/pages/docs/reference/api/classes/NodeStatusObject.md new file mode 100644 index 0000000..fe2a04b --- /dev/null +++ b/src/pages/docs/reference/api/classes/NodeStatusObject.md @@ -0,0 +1,73 @@ +--- +title: NodeStatusObject +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / NodeStatusObject + +# Class: NodeStatusObject + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L53) + +## Constructors + +### new NodeStatusObject() + +> **new NodeStatusObject**(`node`, `process`): [`NodeStatusObject`](NodeStatusObject.md) + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L67) + +#### Parameters + +##### node + +[`NodeInformation`](../interfaces/NodeInformation.md) + +##### process + +[`ProcessInformation`](../interfaces/ProcessInformation.md) + +#### Returns + +[`NodeStatusObject`](NodeStatusObject.md) + +## Properties + +### node + +> **node**: [`NodeInformationObject`](NodeInformationObject.md) + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L65) + +*** + +### process + +> **process**: [`ProcessInformationObject`](ProcessInformationObject.md) + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L62) + +## Methods + +### fromServiceLayerModel() + +> `static` **fromServiceLayerModel**(`node`, `process`): [`NodeStatusObject`](NodeStatusObject.md) + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L54) + +#### Parameters + +##### node + +[`NodeInformation`](../interfaces/NodeInformation.md) + +##### process + +[`ProcessInformation`](../interfaces/ProcessInformation.md) + +#### Returns + +[`NodeStatusObject`](NodeStatusObject.md) diff --git a/src/pages/docs/reference/api/classes/NodeStatusResolver.md b/src/pages/docs/reference/api/classes/NodeStatusResolver.md new file mode 100644 index 0000000..905784a --- /dev/null +++ b/src/pages/docs/reference/api/classes/NodeStatusResolver.md @@ -0,0 +1,124 @@ +--- +title: NodeStatusResolver +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / NodeStatusResolver + +# Class: NodeStatusResolver + +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L28) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`GraphqlModule`](GraphqlModule.md) + +## Constructors + +### new NodeStatusResolver() + +> **new NodeStatusResolver**(`nodeStatusService`): [`NodeStatusResolver`](NodeStatusResolver.md) + +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L29) + +#### Parameters + +##### nodeStatusService + +[`NodeStatusService`](NodeStatusService.md) + +#### Returns + +[`NodeStatusResolver`](NodeStatusResolver.md) + +#### Overrides + +[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) + +*** + +### node() + +> **node**(): `Promise`\<[`NodeInformationObject`](NodeInformationObject.md)\> + +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L36) + +#### Returns + +`Promise`\<[`NodeInformationObject`](NodeInformationObject.md)\> diff --git a/src/pages/docs/reference/api/classes/NodeStatusService.md b/src/pages/docs/reference/api/classes/NodeStatusService.md new file mode 100644 index 0000000..c0c80c7 --- /dev/null +++ b/src/pages/docs/reference/api/classes/NodeStatusService.md @@ -0,0 +1,63 @@ +--- +title: NodeStatusService +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / NodeStatusService + +# Class: NodeStatusService + +Defined in: [api/src/graphql/services/NodeStatusService.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L27) + +## Constructors + +### new NodeStatusService() + +> **new NodeStatusService**(`blockStorage`, `batchStorage`, `settlementStorage`): [`NodeStatusService`](NodeStatusService.md) + +Defined in: [api/src/graphql/services/NodeStatusService.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L28) + +#### Parameters + +##### blockStorage + +[`BlockStorage`](../../sequencer/interfaces/BlockStorage.md) + +##### batchStorage + +[`BatchStorage`](../../sequencer/interfaces/BatchStorage.md) + +##### settlementStorage + +[`SettlementStorage`](../../sequencer/interfaces/SettlementStorage.md) + +#### Returns + +[`NodeStatusService`](NodeStatusService.md) + +## Methods + +### getNodeInformation() + +> **getNodeInformation**(): `Promise`\<[`NodeInformation`](../interfaces/NodeInformation.md)\> + +Defined in: [api/src/graphql/services/NodeStatusService.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L56) + +#### Returns + +`Promise`\<[`NodeInformation`](../interfaces/NodeInformation.md)\> + +*** + +### getProcessInfo() + +> **getProcessInfo**(): [`ProcessInformation`](../interfaces/ProcessInformation.md) + +Defined in: [api/src/graphql/services/NodeStatusService.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L36) + +#### Returns + +[`ProcessInformation`](../interfaces/ProcessInformation.md) diff --git a/src/pages/docs/reference/api/classes/ProcessInformationObject.md b/src/pages/docs/reference/api/classes/ProcessInformationObject.md new file mode 100644 index 0000000..d32154d --- /dev/null +++ b/src/pages/docs/reference/api/classes/ProcessInformationObject.md @@ -0,0 +1,105 @@ +--- +title: ProcessInformationObject +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / ProcessInformationObject + +# Class: ProcessInformationObject + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L13) + +## Constructors + +### new ProcessInformationObject() + +> **new ProcessInformationObject**(`process`): [`ProcessInformationObject`](ProcessInformationObject.md) + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L39) + +#### Parameters + +##### process + +[`ProcessInformation`](../interfaces/ProcessInformation.md) + +#### Returns + +[`ProcessInformationObject`](ProcessInformationObject.md) + +## Properties + +### arch + +> **arch**: `string` + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L34) + +*** + +### headTotal + +> **headTotal**: `number` + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L28) + +*** + +### headUsed + +> **headUsed**: `number` + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L25) + +*** + +### nodeVersion + +> **nodeVersion**: `string` + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L31) + +*** + +### platform + +> **platform**: `string` + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L37) + +*** + +### uptime + +> **uptime**: `number` + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L19) + +*** + +### uptimeHumanReadable + +> **uptimeHumanReadable**: `string` + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L22) + +## Methods + +### fromServiceLayerModel() + +> `static` **fromServiceLayerModel**(`process`): [`ProcessInformationObject`](ProcessInformationObject.md) + +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L14) + +#### Parameters + +##### process + +[`ProcessInformation`](../interfaces/ProcessInformation.md) + +#### Returns + +[`ProcessInformationObject`](ProcessInformationObject.md) diff --git a/src/pages/docs/reference/api/classes/QueryGraphqlModule.md b/src/pages/docs/reference/api/classes/QueryGraphqlModule.md new file mode 100644 index 0000000..ff1c75f --- /dev/null +++ b/src/pages/docs/reference/api/classes/QueryGraphqlModule.md @@ -0,0 +1,276 @@ +--- +title: QueryGraphqlModule +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / QueryGraphqlModule + +# Class: QueryGraphqlModule\ + +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L69) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md) + +## Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +## Constructors + +### new QueryGraphqlModule() + +> **new QueryGraphqlModule**\<`RuntimeModules`\>(`queryTransportModule`, `networkStateTransportModule`, `runtime`, `protocol`, `blockStorage`): [`QueryGraphqlModule`](QueryGraphqlModule.md)\<`RuntimeModules`\> + +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L72) + +#### Parameters + +##### queryTransportModule + +[`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md) + +##### networkStateTransportModule + +[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md) + +##### runtime + +[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> + +##### blockStorage + +[`BlockStorage`](../../sequencer/interfaces/BlockStorage.md) & [`HistoricalBlockStorage`](../../sequencer/interfaces/HistoricalBlockStorage.md) + +#### Returns + +[`QueryGraphqlModule`](QueryGraphqlModule.md)\<`RuntimeModules`\> + +#### Overrides + +[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md).[`constructor`](SchemaGeneratingGraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md).[`currentConfig`](SchemaGeneratingGraphqlModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md).[`config`](SchemaGeneratingGraphqlModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md).[`create`](SchemaGeneratingGraphqlModule.md#create) + +*** + +### generateSchema() + +> **generateSchema**(): `GraphQLSchema` + +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:361](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L361) + +#### Returns + +`GraphQLSchema` + +#### Overrides + +[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md).[`generateSchema`](SchemaGeneratingGraphqlModule.md#generateschema) + +*** + +### generateSchemaForQuery() + +> **generateSchemaForQuery**\<`ModuleType`, `ContainerModulesRecord`\>(`container`, `containerQuery`, `namePrefix`): `ObjMap`\<`GraphQLFieldConfig`\<`unknown`, `unknown`\>\> + +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:310](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L310) + +#### Type Parameters + +• **ModuleType** *extends* [`BaseModuleType`](../../common/type-aliases/BaseModuleType.md) + +• **ContainerModulesRecord** *extends* [`ModulesRecord`](../../common/interfaces/ModulesRecord.md) + +#### Parameters + +##### container + +[`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`ContainerModulesRecord`\> + +##### containerQuery + +[`Query`](../../sequencer/type-aliases/Query.md)\<`ModuleType`, `any`\> + +##### namePrefix + +`string` + +#### Returns + +`ObjMap`\<`GraphQLFieldConfig`\<`unknown`, `unknown`\>\> + +*** + +### generateStateMapResolver() + +> **generateStateMapResolver**\<`Key`, `Value`\>(`fieldKey`, `query`, `stateMap`): `GraphQLFieldConfig`\<`unknown`, `unknown`\> + +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:222](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L222) + +#### Type Parameters + +• **Key** + +• **Value** + +#### Parameters + +##### fieldKey + +`string` + +##### query + +[`QueryGetterStateMap`](../../sequencer/interfaces/QueryGetterStateMap.md)\<`Key`, `Value`\> + +##### stateMap + +[`StateMap`](../../protocol/classes/StateMap.md)\<`Key`, `Value`\> + +#### Returns + +`GraphQLFieldConfig`\<`unknown`, `unknown`\> + +*** + +### generateStateResolver() + +> **generateStateResolver**\<`Value`\>(`fieldKey`, `query`, `state`): `object` + +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:276](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L276) + +#### Type Parameters + +• **Value** + +#### Parameters + +##### fieldKey + +`string` + +##### query + +[`QueryGetterState`](../../sequencer/interfaces/QueryGetterState.md)\<`Value`\> + +##### state + +[`State`](../../protocol/classes/State.md)\<`Value`\> + +#### Returns + +`object` + +##### args + +> **args**: `object` = `{}` + +##### resolve() + +> **resolve**: () => `Promise`\<`any`\> + +###### Returns + +`Promise`\<`any`\> + +##### type + +> **type**: `GraphQLScalarType` \| `GraphQLObjectType` = `valueType` + +*** + +### state() + +> **state**(`path`): `Promise`\<`undefined` \| `string`[]\> + +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:93](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L93) + +#### Parameters + +##### path + +`string` + +#### Returns + +`Promise`\<`undefined` \| `string`[]\> diff --git a/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md b/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md new file mode 100644 index 0000000..c0af246 --- /dev/null +++ b/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md @@ -0,0 +1,127 @@ +--- +title: ResolverFactoryGraphqlModule +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / ResolverFactoryGraphqlModule + +# Class: `abstract` ResolverFactoryGraphqlModule\ + +Defined in: [api/src/graphql/GraphqlModule.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L30) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`GraphqlModule`](GraphqlModule.md)\<`Config`\> + +## Extended by + +- [`GeneratedResolverFactoryGraphqlModule`](../../indexer/classes/GeneratedResolverFactoryGraphqlModule.md) +- [`ResolverFactoryGraphqlModule`](../../processor/classes/ResolverFactoryGraphqlModule.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +## Constructors + +### new ResolverFactoryGraphqlModule() + +> **new ResolverFactoryGraphqlModule**\<`Config`\>(): [`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`Config`\> + +Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L11) + +#### Returns + +[`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`Config`\> + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) + +*** + +### resolvers() + +> `abstract` **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> + +Defined in: [api/src/graphql/GraphqlModule.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L33) + +#### Returns + +`Promise`\<`NonEmptyArray`\<`Function`\>\> diff --git a/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md b/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md new file mode 100644 index 0000000..352b484 --- /dev/null +++ b/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md @@ -0,0 +1,126 @@ +--- +title: SchemaGeneratingGraphqlModule +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / SchemaGeneratingGraphqlModule + +# Class: `abstract` SchemaGeneratingGraphqlModule\ + +Defined in: [api/src/graphql/GraphqlModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L24) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`GraphqlModule`](GraphqlModule.md)\<`Config`\> + +## Extended by + +- [`QueryGraphqlModule`](QueryGraphqlModule.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +## Constructors + +### new SchemaGeneratingGraphqlModule() + +> **new SchemaGeneratingGraphqlModule**\<`Config`\>(): [`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md)\<`Config`\> + +Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L11) + +#### Returns + +[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md)\<`Config`\> + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) + +*** + +### generateSchema() + +> `abstract` **generateSchema**(): `GraphQLSchema` + +Defined in: [api/src/graphql/GraphqlModule.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L27) + +#### Returns + +`GraphQLSchema` diff --git a/src/pages/docs/reference/api/classes/Signature.md b/src/pages/docs/reference/api/classes/Signature.md new file mode 100644 index 0000000..98fa2e5 --- /dev/null +++ b/src/pages/docs/reference/api/classes/Signature.md @@ -0,0 +1,51 @@ +--- +title: Signature +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / Signature + +# Class: Signature + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L22) + +## Constructors + +### new Signature() + +> **new Signature**(`r`, `s`): [`Signature`](Signature.md) + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L31) + +#### Parameters + +##### r + +`string` + +##### s + +`string` + +#### Returns + +[`Signature`](Signature.md) + +## Properties + +### r + +> **r**: `string` + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L25) + +*** + +### s + +> **s**: `string` + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L29) diff --git a/src/pages/docs/reference/api/classes/TransactionObject.md b/src/pages/docs/reference/api/classes/TransactionObject.md new file mode 100644 index 0000000..2af5405 --- /dev/null +++ b/src/pages/docs/reference/api/classes/TransactionObject.md @@ -0,0 +1,141 @@ +--- +title: TransactionObject +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / TransactionObject + +# Class: TransactionObject + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L39) + +## Constructors + +### new TransactionObject() + +> **new TransactionObject**(`hash`, `methodId`, `sender`, `nonce`, `signature`, `argsFields`, `auxiliaryData`, `isMessage`): [`TransactionObject`](TransactionObject.md) + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L88) + +#### Parameters + +##### hash + +`string` + +##### methodId + +`string` + +##### sender + +`string` + +##### nonce + +`string` + +##### signature + +[`Signature`](Signature.md) + +##### argsFields + +`string`[] + +##### auxiliaryData + +`string`[] + +##### isMessage + +`boolean` + +#### Returns + +[`TransactionObject`](TransactionObject.md) + +## Properties + +### argsFields + +> **argsFields**: `string`[] + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L80) + +*** + +### auxiliaryData + +> **auxiliaryData**: `string`[] + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L83) + +*** + +### hash + +> **hash**: `string` + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L63) + +*** + +### isMessage + +> **isMessage**: `boolean` + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L86) + +*** + +### methodId + +> **methodId**: `string` + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L67) + +*** + +### nonce + +> **nonce**: `string` + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L74) + +*** + +### sender + +> **sender**: `string` + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L70) + +*** + +### signature + +> **signature**: [`Signature`](Signature.md) + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L77) + +## Methods + +### fromServiceLayerModel() + +> `static` **fromServiceLayerModel**(`pt`): [`TransactionObject`](TransactionObject.md) + +Defined in: [api/src/graphql/modules/MempoolResolver.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L40) + +#### Parameters + +##### pt + +[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) + +#### Returns + +[`TransactionObject`](TransactionObject.md) diff --git a/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md b/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md new file mode 100644 index 0000000..f7a7061 --- /dev/null +++ b/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md @@ -0,0 +1,81 @@ +--- +title: VanillaGraphqlModules +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / VanillaGraphqlModules + +# Class: VanillaGraphqlModules + +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/VanillaGraphqlModules.ts#L20) + +## Constructors + +### new VanillaGraphqlModules() + +> **new VanillaGraphqlModules**(): [`VanillaGraphqlModules`](VanillaGraphqlModules.md) + +#### Returns + +[`VanillaGraphqlModules`](VanillaGraphqlModules.md) + +## Methods + +### defaultConfig() + +> `static` **defaultConfig**(): `object` + +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/VanillaGraphqlModules.ts#L35) + +#### Returns + +`object` + +##### BatchStorageResolver + +> **BatchStorageResolver**: `object` = `{}` + +##### BlockResolver + +> **BlockResolver**: `object` = `{}` + +##### MempoolResolver + +> **MempoolResolver**: `object` = `{}` + +##### MerkleWitnessResolver + +> **MerkleWitnessResolver**: `object` = `{}` + +##### NodeStatusResolver + +> **NodeStatusResolver**: `object` = `{}` + +##### QueryGraphqlModule + +> **QueryGraphqlModule**: `object` = `{}` + +*** + +### with() + +> `static` **with**\<`AdditionalModules`\>(`additionalModules`): `object` & `AdditionalModules` + +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/VanillaGraphqlModules.ts#L21) + +#### Type Parameters + +• **AdditionalModules** *extends* [`GraphqlModulesRecord`](../type-aliases/GraphqlModulesRecord.md) + +#### Parameters + +##### additionalModules + +`AdditionalModules` + +#### Returns + +`object` & `AdditionalModules` diff --git a/src/pages/docs/reference/api/functions/graphqlModule.md b/src/pages/docs/reference/api/functions/graphqlModule.md new file mode 100644 index 0000000..27bd012 --- /dev/null +++ b/src/pages/docs/reference/api/functions/graphqlModule.md @@ -0,0 +1,32 @@ +--- +title: graphqlModule +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / graphqlModule + +# Function: graphqlModule() + +> **graphqlModule**(): (`target`) => `void` + +Defined in: [api/src/graphql/GraphqlModule.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L36) + +## Returns + +`Function` + +### Parameters + +#### target + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlModule`](../classes/GraphqlModule.md)\<`unknown`\>\> + +Check if the target class extends GraphqlModule, while +also providing static config presets + +### Returns + +`void` diff --git a/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md b/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md new file mode 100644 index 0000000..26fa600 --- /dev/null +++ b/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md @@ -0,0 +1,33 @@ +--- +title: GraphqlModulesDefintion +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / GraphqlModulesDefintion + +# Interface: GraphqlModulesDefintion\ + +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L25) + +## Type Parameters + +• **GraphQLModules** *extends* [`GraphqlModulesRecord`](../type-aliases/GraphqlModulesRecord.md) + +## Properties + +### config? + +> `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`GraphQLModules`\> + +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L29) + +*** + +### modules + +> **modules**: `GraphQLModules` + +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L28) diff --git a/src/pages/docs/reference/api/interfaces/NodeInformation.md b/src/pages/docs/reference/api/interfaces/NodeInformation.md new file mode 100644 index 0000000..9903b60 --- /dev/null +++ b/src/pages/docs/reference/api/interfaces/NodeInformation.md @@ -0,0 +1,29 @@ +--- +title: NodeInformation +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / NodeInformation + +# Interface: NodeInformation + +Defined in: [api/src/graphql/services/NodeStatusService.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L21) + +## Properties + +### batchHeight + +> **batchHeight**: `number` + +Defined in: [api/src/graphql/services/NodeStatusService.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L23) + +*** + +### blockHeight + +> **blockHeight**: `number` + +Defined in: [api/src/graphql/services/NodeStatusService.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L22) diff --git a/src/pages/docs/reference/api/interfaces/ProcessInformation.md b/src/pages/docs/reference/api/interfaces/ProcessInformation.md new file mode 100644 index 0000000..d7d414b --- /dev/null +++ b/src/pages/docs/reference/api/interfaces/ProcessInformation.md @@ -0,0 +1,69 @@ +--- +title: ProcessInformation +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / ProcessInformation + +# Interface: ProcessInformation + +Defined in: [api/src/graphql/services/NodeStatusService.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L11) + +## Properties + +### arch + +> **arch**: `string` + +Defined in: [api/src/graphql/services/NodeStatusService.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L17) + +*** + +### headTotal + +> **headTotal**: `number` + +Defined in: [api/src/graphql/services/NodeStatusService.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L15) + +*** + +### headUsed + +> **headUsed**: `number` + +Defined in: [api/src/graphql/services/NodeStatusService.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L14) + +*** + +### nodeVersion + +> **nodeVersion**: `string` + +Defined in: [api/src/graphql/services/NodeStatusService.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L16) + +*** + +### platform + +> **platform**: `string` + +Defined in: [api/src/graphql/services/NodeStatusService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L18) + +*** + +### uptime + +> **uptime**: `number` + +Defined in: [api/src/graphql/services/NodeStatusService.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L12) + +*** + +### uptimeHumanReadable + +> **uptimeHumanReadable**: `string` + +Defined in: [api/src/graphql/services/NodeStatusService.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L13) diff --git a/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md b/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md new file mode 100644 index 0000000..10c10c1 --- /dev/null +++ b/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md @@ -0,0 +1,15 @@ +--- +title: GraphqlModulesRecord +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / GraphqlModulesRecord + +# Type Alias: GraphqlModulesRecord + +> **GraphqlModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlModule`](../classes/GraphqlModule.md)\<`unknown`\>\>\> + +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L21) diff --git a/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md b/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md new file mode 100644 index 0000000..0de84b5 --- /dev/null +++ b/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md @@ -0,0 +1,41 @@ +--- +title: VanillaGraphqlModulesRecord +--- + +[**@proto-kit/api**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / VanillaGraphqlModulesRecord + +# Type Alias: VanillaGraphqlModulesRecord + +> **VanillaGraphqlModulesRecord**: `object` + +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/VanillaGraphqlModules.ts#L11) + +## Type declaration + +### BatchStorageResolver + +> **BatchStorageResolver**: *typeof* [`BatchStorageResolver`](../classes/BatchStorageResolver.md) + +### BlockResolver + +> **BlockResolver**: *typeof* [`BlockResolver`](../classes/BlockResolver.md) + +### MempoolResolver + +> **MempoolResolver**: *typeof* [`MempoolResolver`](../classes/MempoolResolver.md) + +### MerkleWitnessResolver + +> **MerkleWitnessResolver**: *typeof* [`MerkleWitnessResolver`](../classes/MerkleWitnessResolver.md) + +### NodeStatusResolver + +> **NodeStatusResolver**: *typeof* [`NodeStatusResolver`](../classes/NodeStatusResolver.md) + +### QueryGraphqlModule + +> **QueryGraphqlModule**: *typeof* [`QueryGraphqlModule`](../classes/QueryGraphqlModule.md) diff --git a/src/pages/docs/reference/common/README.md b/src/pages/docs/reference/common/README.md new file mode 100644 index 0000000..08e48ed --- /dev/null +++ b/src/pages/docs/reference/common/README.md @@ -0,0 +1,136 @@ +--- +title: "@proto-kit/common" +--- + +**@proto-kit/common** + +*** + +[Documentation](../../README.md) / @proto-kit/common + +# @proto-kit/common + +## Classes + +- [AtomicCompileHelper](classes/AtomicCompileHelper.md) +- [ChildVerificationKeyService](classes/ChildVerificationKeyService.md) +- [CompileRegistry](classes/CompileRegistry.md) +- [ConfigurableModule](classes/ConfigurableModule.md) +- [EventEmitter](classes/EventEmitter.md) +- [EventEmitterProxy](classes/EventEmitterProxy.md) +- [InMemoryMerkleTreeStorage](classes/InMemoryMerkleTreeStorage.md) +- [MockAsyncMerkleTreeStore](classes/MockAsyncMerkleTreeStore.md) +- [ModuleContainer](classes/ModuleContainer.md) +- [ProvableMethodExecutionContext](classes/ProvableMethodExecutionContext.md) +- [ProvableMethodExecutionResult](classes/ProvableMethodExecutionResult.md) +- [ReplayingSingleUseEventEmitter](classes/ReplayingSingleUseEventEmitter.md) +- [RollupMerkleTree](classes/RollupMerkleTree.md) +- [RollupMerkleTreeWitness](classes/RollupMerkleTreeWitness.md) +- [ZkProgrammable](classes/ZkProgrammable.md) + +## Interfaces + +- [AbstractMerkleTree](interfaces/AbstractMerkleTree.md) +- [AbstractMerkleTreeClass](interfaces/AbstractMerkleTreeClass.md) +- [AbstractMerkleWitness](interfaces/AbstractMerkleWitness.md) +- [AreProofsEnabled](interfaces/AreProofsEnabled.md) +- [BaseModuleInstanceType](interfaces/BaseModuleInstanceType.md) +- [ChildContainerCreatable](interfaces/ChildContainerCreatable.md) +- [ChildContainerProvider](interfaces/ChildContainerProvider.md) +- [CompilableModule](interfaces/CompilableModule.md) +- [Compile](interfaces/Compile.md) +- [CompileArtifact](interfaces/CompileArtifact.md) +- [Configurable](interfaces/Configurable.md) +- [DependencyFactory](interfaces/DependencyFactory.md) +- [EventEmittingComponent](interfaces/EventEmittingComponent.md) +- [EventEmittingContainer](interfaces/EventEmittingContainer.md) +- [MerkleTreeStore](interfaces/MerkleTreeStore.md) +- [ModuleContainerDefinition](interfaces/ModuleContainerDefinition.md) +- [ModulesRecord](interfaces/ModulesRecord.md) +- [PlainZkProgram](interfaces/PlainZkProgram.md) +- [StaticConfigurableModule](interfaces/StaticConfigurableModule.md) +- [ToFieldable](interfaces/ToFieldable.md) +- [ToFieldableStatic](interfaces/ToFieldableStatic.md) +- [ToJSONableStatic](interfaces/ToJSONableStatic.md) +- [Verify](interfaces/Verify.md) +- [WithZkProgrammable](interfaces/WithZkProgrammable.md) + +## Type Aliases + +- [ArgumentTypes](type-aliases/ArgumentTypes.md) +- [ArrayElement](type-aliases/ArrayElement.md) +- [ArtifactRecord](type-aliases/ArtifactRecord.md) +- [BaseModuleType](type-aliases/BaseModuleType.md) +- [CapitalizeAny](type-aliases/CapitalizeAny.md) +- [CastToEventsRecord](type-aliases/CastToEventsRecord.md) +- [CompileTarget](type-aliases/CompileTarget.md) +- [ContainerEvents](type-aliases/ContainerEvents.md) +- [DecoratedMethod](type-aliases/DecoratedMethod.md) +- [DependenciesFromModules](type-aliases/DependenciesFromModules.md) +- [DependencyDeclaration](type-aliases/DependencyDeclaration.md) +- [DependencyRecord](type-aliases/DependencyRecord.md) +- [EventListenable](type-aliases/EventListenable.md) +- [EventsRecord](type-aliases/EventsRecord.md) +- [FilterNeverValues](type-aliases/FilterNeverValues.md) +- [FlattenedContainerEvents](type-aliases/FlattenedContainerEvents.md) +- [FlattenObject](type-aliases/FlattenObject.md) +- [InferDependencies](type-aliases/InferDependencies.md) +- [InferProofBase](type-aliases/InferProofBase.md) +- [MapDependencyRecordToTypes](type-aliases/MapDependencyRecordToTypes.md) +- [MergeObjects](type-aliases/MergeObjects.md) +- [ModuleEvents](type-aliases/ModuleEvents.md) +- [ModulesConfig](type-aliases/ModulesConfig.md) +- [NoConfig](type-aliases/NoConfig.md) +- [NonMethods](type-aliases/NonMethods.md) +- [O1JSPrimitive](type-aliases/O1JSPrimitive.md) +- [OmitKeys](type-aliases/OmitKeys.md) +- [OverwriteObjectType](type-aliases/OverwriteObjectType.md) +- [Preset](type-aliases/Preset.md) +- [Presets](type-aliases/Presets.md) +- [ProofTypes](type-aliases/ProofTypes.md) +- [RecursivePartial](type-aliases/RecursivePartial.md) +- [ResolvableModules](type-aliases/ResolvableModules.md) +- [StringKeyOf](type-aliases/StringKeyOf.md) +- [TypedClass](type-aliases/TypedClass.md) +- [TypeFromDependencyDeclaration](type-aliases/TypeFromDependencyDeclaration.md) +- [UnionToIntersection](type-aliases/UnionToIntersection.md) +- [UnTypedClass](type-aliases/UnTypedClass.md) + +## Variables + +- [EMPTY\_PUBLICKEY](variables/EMPTY_PUBLICKEY.md) +- [EMPTY\_PUBLICKEY\_X](variables/EMPTY_PUBLICKEY_X.md) +- [injectAliasMetadataKey](variables/injectAliasMetadataKey.md) +- [log](variables/log.md) +- [MAX\_FIELD](variables/MAX_FIELD.md) +- [MOCK\_PROOF](variables/MOCK_PROOF.md) +- [MOCK\_VERIFICATION\_KEY](variables/MOCK_VERIFICATION_KEY.md) +- [ModuleContainerErrors](variables/ModuleContainerErrors.md) + +## Functions + +- [assertValidTextLogLevel](functions/assertValidTextLogLevel.md) +- [compileToMockable](functions/compileToMockable.md) +- [createMerkleTree](functions/createMerkleTree.md) +- [dummyValue](functions/dummyValue.md) +- [expectDefined](functions/expectDefined.md) +- [filterNonNull](functions/filterNonNull.md) +- [filterNonUndefined](functions/filterNonUndefined.md) +- [getInjectAliases](functions/getInjectAliases.md) +- [hashWithPrefix](functions/hashWithPrefix.md) +- [implement](functions/implement.md) +- [injectAlias](functions/injectAlias.md) +- [injectOptional](functions/injectOptional.md) +- [isSubtypeOfName](functions/isSubtypeOfName.md) +- [mapSequential](functions/mapSequential.md) +- [noop](functions/noop.md) +- [prefixToField](functions/prefixToField.md) +- [provableMethod](functions/provableMethod.md) +- [range](functions/range.md) +- [reduceSequential](functions/reduceSequential.md) +- [requireTrue](functions/requireTrue.md) +- [safeParseJson](functions/safeParseJson.md) +- [sleep](functions/sleep.md) +- [splitArray](functions/splitArray.md) +- [toProver](functions/toProver.md) +- [verifyToMockable](functions/verifyToMockable.md) diff --git a/src/pages/docs/reference/common/_meta.tsx b/src/pages/docs/reference/common/_meta.tsx new file mode 100644 index 0000000..5602e3c --- /dev/null +++ b/src/pages/docs/reference/common/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/common/classes/AtomicCompileHelper.md b/src/pages/docs/reference/common/classes/AtomicCompileHelper.md new file mode 100644 index 0000000..5863fad --- /dev/null +++ b/src/pages/docs/reference/common/classes/AtomicCompileHelper.md @@ -0,0 +1,53 @@ +--- +title: AtomicCompileHelper +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / AtomicCompileHelper + +# Class: AtomicCompileHelper + +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/AtomicCompileHelper.ts#L17) + +## Constructors + +### new AtomicCompileHelper() + +> **new AtomicCompileHelper**(`areProofsEnabled`): [`AtomicCompileHelper`](AtomicCompileHelper.md) + +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/AtomicCompileHelper.ts#L18) + +#### Parameters + +##### areProofsEnabled + +[`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) + +#### Returns + +[`AtomicCompileHelper`](AtomicCompileHelper.md) + +## Methods + +### compileContract() + +> **compileContract**(`contract`, `overrideProofsEnabled`?): `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> + +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/AtomicCompileHelper.ts#L24) + +#### Parameters + +##### contract + +[`CompileTarget`](../type-aliases/CompileTarget.md) + +##### overrideProofsEnabled? + +`boolean` + +#### Returns + +`Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> diff --git a/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md b/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md new file mode 100644 index 0000000..719f0fe --- /dev/null +++ b/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md @@ -0,0 +1,67 @@ +--- +title: ChildVerificationKeyService +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ChildVerificationKeyService + +# Class: ChildVerificationKeyService + +Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L7) + +## Constructors + +### new ChildVerificationKeyService() + +> **new ChildVerificationKeyService**(): [`ChildVerificationKeyService`](ChildVerificationKeyService.md) + +#### Returns + +[`ChildVerificationKeyService`](ChildVerificationKeyService.md) + +## Methods + +### getVerificationKey() + +> **getVerificationKey**(`name`): `object` + +Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L14) + +#### Parameters + +##### name + +`string` + +#### Returns + +`object` + +##### data + +> **data**: `string` + +##### hash + +> **hash**: `Field` + +*** + +### setCompileRegistry() + +> **setCompileRegistry**(`registry`): `void` + +Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L10) + +#### Parameters + +##### registry + +[`CompileRegistry`](CompileRegistry.md) + +#### Returns + +`void` diff --git a/src/pages/docs/reference/common/classes/CompileRegistry.md b/src/pages/docs/reference/common/classes/CompileRegistry.md new file mode 100644 index 0000000..1ccb242 --- /dev/null +++ b/src/pages/docs/reference/common/classes/CompileRegistry.md @@ -0,0 +1,124 @@ +--- +title: CompileRegistry +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CompileRegistry + +# Class: CompileRegistry + +Defined in: [packages/common/src/compiling/CompileRegistry.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L21) + +The CompileRegistry compiles "compilable modules" +(i.e. zkprograms, contracts or contractmodules) +while making sure they don't get compiled twice in the same process in parallel. + +## Constructors + +### new CompileRegistry() + +> **new CompileRegistry**(`areProofsEnabled`): [`CompileRegistry`](CompileRegistry.md) + +Defined in: [packages/common/src/compiling/CompileRegistry.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L22) + +#### Parameters + +##### areProofsEnabled + +[`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) + +#### Returns + +[`CompileRegistry`](CompileRegistry.md) + +## Methods + +### addArtifactsRaw() + +> **addArtifactsRaw**(`artifacts`): `void` + +Defined in: [packages/common/src/compiling/CompileRegistry.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L68) + +#### Parameters + +##### artifacts + +[`ArtifactRecord`](../type-aliases/ArtifactRecord.md) + +#### Returns + +`void` + +*** + +### compile() + +> **compile**(`target`): `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> + +Defined in: [packages/common/src/compiling/CompileRegistry.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L49) + +#### Parameters + +##### target + +[`CompileTarget`](../type-aliases/CompileTarget.md) + +#### Returns + +`Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> + +*** + +### forceProverExists() + +> **forceProverExists**(`f`): `Promise`\<`void`\> + +Defined in: [packages/common/src/compiling/CompileRegistry.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L41) + +This function forces compilation even if the artifact itself is in the registry. +Basically the statement is: The artifact along is not enough, we need to +actually have the prover compiled. +This is true for non-sideloaded circuit dependencies. + +#### Parameters + +##### f + +(`registry`) => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### getAllArtifacts() + +> **getAllArtifacts**(): [`ArtifactRecord`](../type-aliases/ArtifactRecord.md) + +Defined in: [packages/common/src/compiling/CompileRegistry.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L75) + +#### Returns + +[`ArtifactRecord`](../type-aliases/ArtifactRecord.md) + +*** + +### getArtifact() + +> **getArtifact**(`name`): `undefined` \| [`CompileArtifact`](../interfaces/CompileArtifact.md) + +Defined in: [packages/common/src/compiling/CompileRegistry.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L58) + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| [`CompileArtifact`](../interfaces/CompileArtifact.md) diff --git a/src/pages/docs/reference/common/classes/ConfigurableModule.md b/src/pages/docs/reference/common/classes/ConfigurableModule.md new file mode 100644 index 0000000..d03d68d --- /dev/null +++ b/src/pages/docs/reference/common/classes/ConfigurableModule.md @@ -0,0 +1,114 @@ +--- +title: ConfigurableModule +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ConfigurableModule + +# Class: ConfigurableModule\ + +Defined in: [packages/common/src/config/ConfigurableModule.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L27) + +Used by various module sub-types that may need to be configured + +## Extended by + +- [`ModuleContainer`](ModuleContainer.md) +- [`GraphqlModule`](../../api/classes/GraphqlModule.md) +- [`IndexerModule`](../../indexer/classes/IndexerModule.md) +- [`RuntimeFeeAnalyzerService`](../../library/classes/RuntimeFeeAnalyzerService.md) +- [`RuntimeModule`](../../module/classes/RuntimeModule.md) +- [`ProcessorModule`](../../processor/classes/ProcessorModule.md) +- [`ContractModule`](../../protocol/classes/ContractModule.md) +- [`ProtocolModule`](../../protocol/classes/ProtocolModule.md) +- [`AppChainModule`](../../sdk/classes/AppChainModule.md) +- [`SequencerModule`](../../sequencer/classes/SequencerModule.md) +- [`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../type-aliases/NoConfig.md) + +## Implements + +- [`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md) + +## Constructors + +### new ConfigurableModule() + +> **new ConfigurableModule**\<`Config`\>(): [`ConfigurableModule`](ConfigurableModule.md)\<`Config`\> + +#### Returns + +[`ConfigurableModule`](ConfigurableModule.md)\<`Config`\> + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L34) + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: [packages/common/src/config/ConfigurableModule.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L37) + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: [packages/common/src/config/ConfigurableModule.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L45) + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Implementation of + +[`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md).[`config`](../interfaces/BaseModuleInstanceType.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/common/src/config/ConfigurableModule.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L49) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Implementation of + +[`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md).[`create`](../interfaces/BaseModuleInstanceType.md#create) diff --git a/src/pages/docs/reference/common/classes/EventEmitter.md b/src/pages/docs/reference/common/classes/EventEmitter.md new file mode 100644 index 0000000..f801472 --- /dev/null +++ b/src/pages/docs/reference/common/classes/EventEmitter.md @@ -0,0 +1,161 @@ +--- +title: EventEmitter +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventEmitter + +# Class: EventEmitter\ + +Defined in: [packages/common/src/events/EventEmitter.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L7) + +## Extended by + +- [`EventEmitterProxy`](EventEmitterProxy.md) +- [`ReplayingSingleUseEventEmitter`](ReplayingSingleUseEventEmitter.md) + +## Type Parameters + +• **Events** *extends* [`EventsRecord`](../type-aliases/EventsRecord.md) + +## Constructors + +### new EventEmitter() + +> **new EventEmitter**\<`Events`\>(): [`EventEmitter`](EventEmitter.md)\<`Events`\> + +#### Returns + +[`EventEmitter`](EventEmitter.md)\<`Events`\> + +## Properties + +### listeners + +> `protected` `readonly` **listeners**: `ListenersHolder`\<`Events`\> = `{}` + +Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L8) + +*** + +### wildcardListeners + +> `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` + +Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L10) + +#### Parameters + +##### event + +keyof `Events` + +##### args + +`Events`\[keyof `Events`\] + +#### Returns + +`void` + +## Methods + +### emit() + +> **emit**\<`Key`\>(`event`, ...`parameters`): `void` + +Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L15) + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### event + +`Key` + +##### parameters + +...`Events`\[`Key`\] + +#### Returns + +`void` + +*** + +### off() + +> **off**\<`Key`\>(`event`, `listener`): `void` + +Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L45) + +Primitive .off() with identity comparison for now. +Could be replaced by returning an id in .on() and using that. + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### event + +`Key` + +##### listener + +(...`args`) => `void` + +#### Returns + +`void` + +*** + +### on() + +> **on**\<`Key`\>(`event`, `listener`): `void` + +Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L34) + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### event + +`Key` + +##### listener + +(...`args`) => `void` + +#### Returns + +`void` + +*** + +### onAll() + +> **onAll**(`listener`): `void` + +Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L30) + +#### Parameters + +##### listener + +(`event`, `args`) => `void` + +#### Returns + +`void` diff --git a/src/pages/docs/reference/common/classes/EventEmitterProxy.md b/src/pages/docs/reference/common/classes/EventEmitterProxy.md new file mode 100644 index 0000000..d5f64de --- /dev/null +++ b/src/pages/docs/reference/common/classes/EventEmitterProxy.md @@ -0,0 +1,196 @@ +--- +title: EventEmitterProxy +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventEmitterProxy + +# Class: EventEmitterProxy\ + +Defined in: [packages/common/src/events/EventEmitterProxy.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L42) + +## Extends + +- [`EventEmitter`](EventEmitter.md)\<[`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`FlattenedContainerEvents`](../type-aliases/FlattenedContainerEvents.md)\<`Modules`\>\>\> + +## Type Parameters + +• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) + +## Constructors + +### new EventEmitterProxy() + +> **new EventEmitterProxy**\<`Modules`\>(`container`): [`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> + +Defined in: [packages/common/src/events/EventEmitterProxy.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L45) + +#### Parameters + +##### container + +[`ModuleContainer`](ModuleContainer.md)\<`Modules`\> + +#### Returns + +[`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> + +#### Overrides + +[`EventEmitter`](EventEmitter.md).[`constructor`](EventEmitter.md#constructors) + +## Properties + +### listeners + +> `protected` `readonly` **listeners**: `ListenersHolder`\<[`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\>\> = `{}` + +Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L8) + +#### Inherited from + +[`EventEmitter`](EventEmitter.md).[`listeners`](EventEmitter.md#listeners) + +*** + +### wildcardListeners + +> `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` + +Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L10) + +#### Parameters + +##### event + +keyof [`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\> + +##### args + +[`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\>\[keyof [`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\>\] + +#### Returns + +`void` + +#### Inherited from + +[`EventEmitter`](EventEmitter.md).[`wildcardListeners`](EventEmitter.md#wildcardlisteners) + +## Methods + +### emit() + +> **emit**\<`Key`\>(`event`, ...`parameters`): `void` + +Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L15) + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### event + +`Key` + +##### parameters + +...[`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\>\[`Key`\] + +#### Returns + +`void` + +#### Inherited from + +[`EventEmitter`](EventEmitter.md).[`emit`](EventEmitter.md#emit) + +*** + +### off() + +> **off**\<`Key`\>(`event`, `listener`): `void` + +Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L45) + +Primitive .off() with identity comparison for now. +Could be replaced by returning an id in .on() and using that. + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### event + +`Key` + +##### listener + +(...`args`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`EventEmitter`](EventEmitter.md).[`off`](EventEmitter.md#off) + +*** + +### on() + +> **on**\<`Key`\>(`event`, `listener`): `void` + +Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L34) + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### event + +`Key` + +##### listener + +(...`args`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`EventEmitter`](EventEmitter.md).[`on`](EventEmitter.md#on) + +*** + +### onAll() + +> **onAll**(`listener`): `void` + +Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L30) + +#### Parameters + +##### listener + +(`event`, `args`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`EventEmitter`](EventEmitter.md).[`onAll`](EventEmitter.md#onall) diff --git a/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md b/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md new file mode 100644 index 0000000..da72a7c --- /dev/null +++ b/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md @@ -0,0 +1,100 @@ +--- +title: InMemoryMerkleTreeStorage +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / InMemoryMerkleTreeStorage + +# Class: InMemoryMerkleTreeStorage + +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L3) + +## Extended by + +- [`CachedMerkleTreeStore`](../../sequencer/classes/CachedMerkleTreeStore.md) +- [`SyncCachedMerkleTreeStore`](../../sequencer/classes/SyncCachedMerkleTreeStore.md) + +## Implements + +- [`MerkleTreeStore`](../interfaces/MerkleTreeStore.md) + +## Constructors + +### new InMemoryMerkleTreeStorage() + +> **new InMemoryMerkleTreeStorage**(): [`InMemoryMerkleTreeStorage`](InMemoryMerkleTreeStorage.md) + +#### Returns + +[`InMemoryMerkleTreeStorage`](InMemoryMerkleTreeStorage.md) + +## Properties + +### nodes + +> `protected` **nodes**: `object` = `{}` + +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L4) + +#### Index Signature + +\[`key`: `number`\]: `object` + +## Methods + +### getNode() + +> **getNode**(`key`, `level`): `undefined` \| `bigint` + +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L10) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +#### Returns + +`undefined` \| `bigint` + +#### Implementation of + +[`MerkleTreeStore`](../interfaces/MerkleTreeStore.md).[`getNode`](../interfaces/MerkleTreeStore.md#getnode) + +*** + +### setNode() + +> **setNode**(`key`, `level`, `value`): `void` + +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L14) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +##### value + +`bigint` + +#### Returns + +`void` + +#### Implementation of + +[`MerkleTreeStore`](../interfaces/MerkleTreeStore.md).[`setNode`](../interfaces/MerkleTreeStore.md#setnode) diff --git a/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md b/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md new file mode 100644 index 0000000..599dc96 --- /dev/null +++ b/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md @@ -0,0 +1,103 @@ +--- +title: MockAsyncMerkleTreeStore +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MockAsyncMerkleTreeStore + +# Class: MockAsyncMerkleTreeStore + +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L5) + +## Constructors + +### new MockAsyncMerkleTreeStore() + +> **new MockAsyncMerkleTreeStore**(): [`MockAsyncMerkleTreeStore`](MockAsyncMerkleTreeStore.md) + +#### Returns + +[`MockAsyncMerkleTreeStore`](MockAsyncMerkleTreeStore.md) + +## Properties + +### store + +> `readonly` **store**: [`InMemoryMerkleTreeStorage`](InMemoryMerkleTreeStorage.md) + +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L6) + +## Methods + +### commit() + +> **commit**(): `void` + +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L8) + +#### Returns + +`void` + +*** + +### getNodeAsync() + +> **getNodeAsync**(`key`, `level`): `Promise`\<`undefined` \| `bigint`\> + +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L16) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +#### Returns + +`Promise`\<`undefined` \| `bigint`\> + +*** + +### openTransaction() + +> **openTransaction**(): `void` + +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L12) + +#### Returns + +`void` + +*** + +### setNodeAsync() + +> **setNodeAsync**(`key`, `level`, `value`): `Promise`\<`void`\> + +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L23) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +##### value + +`bigint` + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/common/classes/ModuleContainer.md b/src/pages/docs/reference/common/classes/ModuleContainer.md new file mode 100644 index 0000000..5bf7a36 --- /dev/null +++ b/src/pages/docs/reference/common/classes/ModuleContainer.md @@ -0,0 +1,520 @@ +--- +title: ModuleContainer +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModuleContainer + +# Class: ModuleContainer\ + +Defined in: [packages/common/src/config/ModuleContainer.ts:145](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L145) + +Reusable module container facilitating registration, resolution +configuration, decoration and validation of modules + +## Extends + +- [`ConfigurableModule`](ConfigurableModule.md)\<[`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\>\> + +## Extended by + +- [`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md) +- [`Indexer`](../../indexer/classes/Indexer.md) +- [`Runtime`](../../module/classes/Runtime.md) +- [`Processor`](../../processor/classes/Processor.md) +- [`Protocol`](../../protocol/classes/Protocol.md) +- [`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md) +- [`AppChain`](../../sdk/classes/AppChain.md) +- [`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md) +- [`Sequencer`](../../sequencer/classes/Sequencer.md) + +## Type Parameters + +• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) + +## Constructors + +### new ModuleContainer() + +> **new ModuleContainer**\<`Modules`\>(`definition`): [`ModuleContainer`](ModuleContainer.md)\<`Modules`\> + +Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L159) + +#### Parameters + +##### definition + +[`ModuleContainerDefinition`](../interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +#### Returns + +[`ModuleContainer`](ModuleContainer.md)\<`Modules`\> + +#### Overrides + +[`ConfigurableModule`](ConfigurableModule.md).[`constructor`](ConfigurableModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L34) + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](ConfigurableModule.md).[`currentConfig`](ConfigurableModule.md#currentconfig) + +*** + +### definition + +> **definition**: [`ModuleContainerDefinition`](../interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L159) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: [packages/common/src/config/ModuleContainer.ts:317](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L317) + +##### Returns + +[`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:321](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L321) + +##### Parameters + +###### config + +[`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Overrides + +[`ConfigurableModule`](ConfigurableModule.md).[`config`](ConfigurableModule.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: [packages/common/src/config/ModuleContainer.ts:199](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L199) + +##### Returns + +`DependencyContainer` + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> + +Defined in: [packages/common/src/config/ModuleContainer.ts:270](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L270) + +##### Returns + +[`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: [packages/common/src/config/ModuleContainer.ts:166](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L166) + +##### Returns + +`string`[] + +list of module names + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: [packages/common/src/config/ModuleContainer.ts:224](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L224) + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` + +Defined in: [packages/common/src/config/ModuleContainer.ts:209](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L209) + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf` + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:306](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L306) + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Returns + +`void` + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:310](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L310) + +#### Parameters + +##### config + +[`RecursivePartial`](../type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\>\> + +#### Returns + +`void` + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:479](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L479) + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Overrides + +[`ConfigurableModule`](ConfigurableModule.md).[`create`](ConfigurableModule.md#create) + +*** + +### decorateModule() + +> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L364) + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +`InstanceType`\<`Modules`\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\> + +#### Returns + +`void` + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:389](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L389) + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>[] + +#### Returns + +`void` + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` + +Defined in: [packages/common/src/config/ModuleContainer.ts:217](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L217) + +#### Parameters + +##### modules + +`Modules` + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf` + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:451](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L451) + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\> + +#### Returns + +`void` + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:232](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L232) + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:288](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L288) + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:249](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L249) + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +`Modules` + +#### Returns + +`void` + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L282) + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +Defined in: [packages/common/src/config/ModuleContainer.ts:338](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L338) + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: [packages/common/src/config/ModuleContainer.ts:346](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L346) + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: [packages/common/src/config/ModuleContainer.ts:177](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L177) + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +[`ConfigurableModule`](ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` diff --git a/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md b/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md new file mode 100644 index 0000000..5104b8e --- /dev/null +++ b/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md @@ -0,0 +1,187 @@ +--- +title: ProvableMethodExecutionContext +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ProvableMethodExecutionContext + +# Class: ProvableMethodExecutionContext + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L48) + +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 + +- [`RuntimeMethodExecutionContext`](../../protocol/classes/RuntimeMethodExecutionContext.md) + +## Constructors + +### new ProvableMethodExecutionContext() + +> **new ProvableMethodExecutionContext**(): [`ProvableMethodExecutionContext`](ProvableMethodExecutionContext.md) + +#### Returns + +[`ProvableMethodExecutionContext`](ProvableMethodExecutionContext.md) + +## Properties + +### id + +> **id**: `string` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L49) + +*** + +### methods + +> **methods**: `string`[] = `[]` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L51) + +*** + +### result + +> **result**: [`ProvableMethodExecutionResult`](ProvableMethodExecutionResult.md) + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L53) + +## Accessors + +### isFinished + +#### Get Signature + +> **get** **isFinished**(): `boolean` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L102) + +##### Returns + +`boolean` + +*** + +### isTopLevel + +#### Get Signature + +> **get** **isTopLevel**(): `boolean` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L98) + +##### Returns + +`boolean` + +## Methods + +### afterMethod() + +> **afterMethod**(): `void` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L94) + +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` + +*** + +### beforeMethod() + +> **beforeMethod**(`moduleName`, `methodName`, `args`): `void` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L74) + +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`](../type-aliases/ArgumentTypes.md) + +#### Returns + +`void` + +*** + +### clear() + +> **clear**(): `void` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:119](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L119) + +Manually clears/resets the execution context + +#### Returns + +`void` + +*** + +### current() + +> **current**(): `object` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L109) + +#### Returns + +`object` + +- Current execution context state + +##### isFinished + +> **isFinished**: `boolean` + +##### result + +> **result**: [`ProvableMethodExecutionResult`](ProvableMethodExecutionResult.md) + +*** + +### setProver() + +> **setProver**(`prover`): `void` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L64) + +Adds a method prover to the current execution context, +which can be collected and ran asynchronously at a later point in time. + +#### Parameters + +##### prover + +() => `Promise`\<`Proof`\<`unknown`, `unknown`\>\> + +#### Returns + +`void` diff --git a/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md b/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md new file mode 100644 index 0000000..7e3f32f --- /dev/null +++ b/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md @@ -0,0 +1,79 @@ +--- +title: ProvableMethodExecutionResult +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ProvableMethodExecutionResult + +# Class: ProvableMethodExecutionResult + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L16) + +## Extended by + +- [`RuntimeProvableMethodExecutionResult`](../../protocol/classes/RuntimeProvableMethodExecutionResult.md) + +## Constructors + +### new ProvableMethodExecutionResult() + +> **new ProvableMethodExecutionResult**(): [`ProvableMethodExecutionResult`](ProvableMethodExecutionResult.md) + +#### Returns + +[`ProvableMethodExecutionResult`](ProvableMethodExecutionResult.md) + +## Properties + +### args? + +> `optional` **args**: [`ArgumentTypes`](../type-aliases/ArgumentTypes.md) + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L21) + +*** + +### methodName? + +> `optional` **methodName**: `string` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L19) + +*** + +### moduleName? + +> `optional` **moduleName**: `string` + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L17) + +*** + +### prover()? + +> `optional` **prover**: () => `Promise`\<`Proof`\<`unknown`, `unknown`\>\> + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L23) + +#### Returns + +`Promise`\<`Proof`\<`unknown`, `unknown`\>\> + +## Methods + +### prove() + +> **prove**\<`ProofType`\>(): `Promise`\<`ProofType`\> + +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L25) + +#### Type Parameters + +• **ProofType** *extends* `Proof`\<`unknown`, `unknown`\> + +#### Returns + +`Promise`\<`ProofType`\> diff --git a/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md b/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md new file mode 100644 index 0000000..9379d9a --- /dev/null +++ b/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md @@ -0,0 +1,203 @@ +--- +title: ReplayingSingleUseEventEmitter +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ReplayingSingleUseEventEmitter + +# Class: ReplayingSingleUseEventEmitter\ + +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L12) + +Event Emitter variant that emits a certain event only once to a registered listener. +Additionally, if a listener registers to a event that has already been emitted, it +re-emits it to said listener. +This pattern is especially useful for listening for inclusions of transactions. +Those events will only occur once, and listeners could come too late to the party, +so we need to make sure they get notified as well in those cases. + +## Extends + +- [`EventEmitter`](EventEmitter.md)\<`Events`\> + +## Type Parameters + +• **Events** *extends* [`EventsRecord`](../type-aliases/EventsRecord.md) + +## Constructors + +### new ReplayingSingleUseEventEmitter() + +> **new ReplayingSingleUseEventEmitter**\<`Events`\>(): [`ReplayingSingleUseEventEmitter`](ReplayingSingleUseEventEmitter.md)\<`Events`\> + +#### Returns + +[`ReplayingSingleUseEventEmitter`](ReplayingSingleUseEventEmitter.md)\<`Events`\> + +#### Inherited from + +[`EventEmitter`](EventEmitter.md).[`constructor`](EventEmitter.md#constructors) + +## Properties + +### emitted + +> **emitted**: `Partial`\<`Events`\> = `{}` + +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L15) + +*** + +### listeners + +> `protected` `readonly` **listeners**: `ListenersHolder`\<`Events`\> = `{}` + +Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L8) + +#### Inherited from + +[`EventEmitter`](EventEmitter.md).[`listeners`](EventEmitter.md#listeners) + +*** + +### wildcardListeners + +> `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` + +Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L10) + +#### Parameters + +##### event + +keyof `Events` + +##### args + +`Events`\[keyof `Events`\] + +#### Returns + +`void` + +#### Inherited from + +[`EventEmitter`](EventEmitter.md).[`wildcardListeners`](EventEmitter.md#wildcardlisteners) + +## Methods + +### emit() + +> **emit**\<`Key`\>(`event`, ...`parameters`): `void` + +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L17) + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### event + +`Key` + +##### parameters + +...`Events`\[`Key`\] + +#### Returns + +`void` + +#### Overrides + +[`EventEmitter`](EventEmitter.md).[`emit`](EventEmitter.md#emit) + +*** + +### off() + +> **off**\<`Key`\>(`event`, `listener`): `void` + +Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L45) + +Primitive .off() with identity comparison for now. +Could be replaced by returning an id in .on() and using that. + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### event + +`Key` + +##### listener + +(...`args`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`EventEmitter`](EventEmitter.md).[`off`](EventEmitter.md#off) + +*** + +### on() + +> **on**\<`Key`\>(`event`, `listener`): `void` + +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L33) + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### event + +`Key` + +##### listener + +(...`args`) => `void` + +#### Returns + +`void` + +#### Overrides + +[`EventEmitter`](EventEmitter.md).[`on`](EventEmitter.md#on) + +*** + +### onAll() + +> **onAll**(`listener`): `void` + +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L26) + +#### Parameters + +##### listener + +(`event`, `args`) => `void` + +#### Returns + +`void` + +#### Overrides + +[`EventEmitter`](EventEmitter.md).[`onAll`](EventEmitter.md#onall) diff --git a/src/pages/docs/reference/common/classes/RollupMerkleTree.md b/src/pages/docs/reference/common/classes/RollupMerkleTree.md new file mode 100644 index 0000000..4a89f13 --- /dev/null +++ b/src/pages/docs/reference/common/classes/RollupMerkleTree.md @@ -0,0 +1,291 @@ +--- +title: RollupMerkleTree +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / RollupMerkleTree + +# Class: RollupMerkleTree + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:344](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L344) + +## Extends + +- [`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md) + +## Constructors + +### new RollupMerkleTree() + +> **new RollupMerkleTree**(`store`): [`RollupMerkleTree`](RollupMerkleTree.md) + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L85) + +#### Parameters + +##### store + +[`MerkleTreeStore`](../interfaces/MerkleTreeStore.md) + +#### Returns + +[`RollupMerkleTree`](RollupMerkleTree.md) + +#### Inherited from + +`createMerkleTree(256).constructor` + +## Properties + +### leafCount + +> `readonly` **leafCount**: `bigint` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L43) + +#### Inherited from + +[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`leafCount`](../interfaces/AbstractMerkleTree.md#leafcount) + +*** + +### store + +> **store**: [`MerkleTreeStore`](../interfaces/MerkleTreeStore.md) + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L42) + +#### Inherited from + +[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`store`](../interfaces/AbstractMerkleTree.md#store) + +*** + +### EMPTY\_ROOT + +> `static` **EMPTY\_ROOT**: `bigint` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L92) + +#### Inherited from + +`createMerkleTree(256).EMPTY_ROOT` + +*** + +### HEIGHT + +> `static` **HEIGHT**: `number` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L90) + +#### Inherited from + +`createMerkleTree(256).HEIGHT` + +*** + +### WITNESS + +> `static` **WITNESS**: [`TypedClass`](../type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L87) + +#### Type declaration + +##### dummy() + +> **dummy**: () => [`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) + +###### Returns + +[`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) + +#### Inherited from + +`createMerkleTree(256).WITNESS` + +## Accessors + +### leafCount + +#### Get Signature + +> **get** `static` **leafCount**(): `bigint` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L94) + +##### Returns + +`bigint` + +#### Inherited from + +`createMerkleTree(256).leafCount` + +## Methods + +### assertIndexRange() + +> **assertIndexRange**(`index`): `void` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L45) + +#### Parameters + +##### index + +`bigint` + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`assertIndexRange`](../interfaces/AbstractMerkleTree.md#assertindexrange) + +*** + +### fill() + +> **fill**(`leaves`): `void` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L81) + +Fills all leaves of the tree. + +#### Parameters + +##### leaves + +`Field`[] + +Values to fill the leaves with. + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`fill`](../interfaces/AbstractMerkleTree.md#fill) + +*** + +### getNode() + +> **getNode**(`level`, `index`): `Field` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L53) + +Returns a node which lives at a given index and level. + +#### Parameters + +##### level + +`number` + +Level of the node. + +##### index + +`bigint` + +Index of the node. + +#### Returns + +`Field` + +The data of the node. + +#### Inherited from + +[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`getNode`](../interfaces/AbstractMerkleTree.md#getnode) + +*** + +### getRoot() + +> **getRoot**(): `Field` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L59) + +Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). + +#### Returns + +`Field` + +The root of the Merkle Tree. + +#### Inherited from + +[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`getRoot`](../interfaces/AbstractMerkleTree.md#getroot) + +*** + +### getWitness() + +> **getWitness**(`index`): [`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L75) + +Returns the witness (also known as +[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) +for the leaf at the given index. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +#### Returns + +[`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) + +The witness that belongs to the leaf. + +#### Inherited from + +[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`getWitness`](../interfaces/AbstractMerkleTree.md#getwitness) + +*** + +### setLeaf() + +> **setLeaf**(`index`, `leaf`): `void` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L66) + +Sets the value of a leaf node at a given index to a given value. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +##### leaf + +`Field` + +New value. + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`setLeaf`](../interfaces/AbstractMerkleTree.md#setleaf) diff --git a/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md b/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md new file mode 100644 index 0000000..0937a8d --- /dev/null +++ b/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md @@ -0,0 +1,575 @@ +--- +title: RollupMerkleTreeWitness +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / RollupMerkleTreeWitness + +# Class: RollupMerkleTreeWitness + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:345](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L345) + +## Extends + +- [`WITNESS`](../interfaces/AbstractMerkleTreeClass.md#witness) + +## Constructors + +### new RollupMerkleTreeWitness() + +> **new RollupMerkleTreeWitness**(`value`): [`RollupMerkleTreeWitness`](RollupMerkleTreeWitness.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### isLeft + +`Bool`[] = `...` + +###### path + +`Field`[] = `...` + +#### Returns + +[`RollupMerkleTreeWitness`](RollupMerkleTreeWitness.md) + +#### Inherited from + +`RollupMerkleTree.WITNESS.constructor` + +## Properties + +### isLeft + +> **isLeft**: `Bool`[] + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L11) + +#### Inherited from + +`RollupMerkleTree.WITNESS.isLeft` + +*** + +### path + +> **path**: `Field`[] + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L10) + +#### Inherited from + +`RollupMerkleTree.WITNESS.path` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`RollupMerkleTree.WITNESS._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### isLeft + +`Bool`[] = `...` + +###### path + +`Field`[] = `...` + +#### Returns + +`void` + +#### Inherited from + +`RollupMerkleTree.WITNESS.check` + +*** + +### dummy() + +> `static` **dummy**: () => [`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L88) + +#### Returns + +[`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) + +#### Inherited from + +`RollupMerkleTree.WITNESS.dummy` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`RollupMerkleTree.WITNESS.empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`RollupMerkleTree.WITNESS.fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### isLeft + +`boolean`[] = `...` + +###### path + +`string`[] = `...` + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`RollupMerkleTree.WITNESS.fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`RollupMerkleTree.WITNESS.fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### isLeft + +`Bool`[] = `...` + +###### path + +`Field`[] = `...` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`RollupMerkleTree.WITNESS.toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### isLeft + +`Bool`[] = `...` + +###### path + +`Field`[] = `...` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`RollupMerkleTree.WITNESS.toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] = `...` + +###### path + +`Field`[] = `...` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`RollupMerkleTree.WITNESS.toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] = `...` + +###### path + +`Field`[] = `...` + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `boolean`[] + +##### path + +> **path**: `string`[] + +#### Inherited from + +`RollupMerkleTree.WITNESS.toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] = `...` + +###### path + +`Field`[] = `...` + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `boolean`[] + +##### path + +> **path**: `bigint`[] + +#### Inherited from + +`RollupMerkleTree.WITNESS.toValue` + +## Methods + +### calculateIndex() + +> **calculateIndex**(): `Field` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L28) + +Calculates the index of the leaf node that belongs to this Witness. + +#### Returns + +`Field` + +Index of the leaf. + +#### Inherited from + +`RollupMerkleTree.WITNESS.calculateIndex` + +*** + +### calculateRoot() + +> **calculateRoot**(`hash`): `Field` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L22) + +Calculates a root depending on the leaf value. + +#### Parameters + +##### hash + +`Field` + +#### Returns + +`Field` + +The calculated root. + +#### Inherited from + +`RollupMerkleTree.WITNESS.calculateRoot` + +*** + +### checkMembership() + +> **checkMembership**(`root`, `key`, `value`): `Bool` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L30) + +#### Parameters + +##### root + +`Field` + +##### key + +`Field` + +##### value + +`Field` + +#### Returns + +`Bool` + +#### Inherited from + +`RollupMerkleTree.WITNESS.checkMembership` + +*** + +### checkMembershipGetRoots() + +> **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L32) + +#### Parameters + +##### root + +`Field` + +##### key + +`Field` + +##### value + +`Field` + +#### Returns + +\[`Bool`, `Field`, `Field`\] + +#### Inherited from + +`RollupMerkleTree.WITNESS.checkMembershipGetRoots` + +*** + +### height() + +> **height**(): `number` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L15) + +#### Returns + +`number` + +#### Inherited from + +`RollupMerkleTree.WITNESS.height` + +*** + +### toShortenedEntries() + +> **toShortenedEntries**(): `string`[] + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L38) + +#### Returns + +`string`[] + +#### Inherited from + +`RollupMerkleTree.WITNESS.toShortenedEntries` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`RollupMerkleTree.WITNESS.sizeInFields` diff --git a/src/pages/docs/reference/common/classes/ZkProgrammable.md b/src/pages/docs/reference/common/classes/ZkProgrammable.md new file mode 100644 index 0000000..87e4d0e --- /dev/null +++ b/src/pages/docs/reference/common/classes/ZkProgrammable.md @@ -0,0 +1,93 @@ +--- +title: ZkProgrammable +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ZkProgrammable + +# Class: `abstract` ZkProgrammable\ + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:99](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L99) + +## Extended by + +- [`RuntimeZkProgrammable`](../../module/classes/RuntimeZkProgrammable.md) +- [`BlockProverProgrammable`](../../protocol/classes/BlockProverProgrammable.md) +- [`StateTransitionProverProgrammable`](../../protocol/classes/StateTransitionProverProgrammable.md) + +## Type Parameters + +• **PublicInput** = `undefined` + +• **PublicOutput** = `void` + +## Constructors + +### new ZkProgrammable() + +> **new ZkProgrammable**\<`PublicInput`, `PublicOutput`\>(): [`ZkProgrammable`](ZkProgrammable.md)\<`PublicInput`, `PublicOutput`\> + +#### Returns + +[`ZkProgrammable`](ZkProgrammable.md)\<`PublicInput`, `PublicOutput`\> + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** `abstract` **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:103](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L103) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) + +*** + +### zkProgram + +#### Get Signature + +> **get** **zkProgram**(): [`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L113) + +##### Returns + +[`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../interfaces/CompileArtifact.md)\>\> + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L130) + +#### Parameters + +##### registry + +[`CompileRegistry`](CompileRegistry.md) + +#### Returns + +`Promise`\<`Record`\<`string`, [`CompileArtifact`](../interfaces/CompileArtifact.md)\>\> + +*** + +### zkProgramFactory() + +> `abstract` **zkProgramFactory**(): [`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L105) + +#### Returns + +[`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] diff --git a/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md b/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md new file mode 100644 index 0000000..906d7a5 --- /dev/null +++ b/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md @@ -0,0 +1,25 @@ +--- +title: assertValidTextLogLevel +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / assertValidTextLogLevel + +# Function: assertValidTextLogLevel() + +> **assertValidTextLogLevel**(`level`): `asserts level is LogLevelNames` + +Defined in: [packages/common/src/log.ts:134](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/log.ts#L134) + +## Parameters + +### level + +`string` | `number` + +## Returns + +`asserts level is LogLevelNames` diff --git a/src/pages/docs/reference/common/functions/compileToMockable.md b/src/pages/docs/reference/common/functions/compileToMockable.md new file mode 100644 index 0000000..fe24bb1 --- /dev/null +++ b/src/pages/docs/reference/common/functions/compileToMockable.md @@ -0,0 +1,33 @@ +--- +title: compileToMockable +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / compileToMockable + +# Function: compileToMockable() + +> **compileToMockable**(`compile`, `__namedParameters`): () => `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L84) + +## Parameters + +### compile + +[`Compile`](../interfaces/Compile.md) + +### \_\_namedParameters + +[`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) + +## Returns + +`Function` + +### Returns + +`Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> diff --git a/src/pages/docs/reference/common/functions/createMerkleTree.md b/src/pages/docs/reference/common/functions/createMerkleTree.md new file mode 100644 index 0000000..f0d98ee --- /dev/null +++ b/src/pages/docs/reference/common/functions/createMerkleTree.md @@ -0,0 +1,43 @@ +--- +title: createMerkleTree +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / createMerkleTree + +# Function: createMerkleTree() + +> **createMerkleTree**(`height`): [`AbstractMerkleTreeClass`](../interfaces/AbstractMerkleTreeClass.md) + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:116](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L116) + +A [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree) is a binary tree in +which every leaf is the cryptography hash of a piece of data, +and every node is the hash of the concatenation of its two child nodes. + +A Merkle Tree allows developers to easily and securely verify +the integrity of large amounts of data. + +Take a look at our [documentation](https://docs.minaprotocol.com/en/zkapps) +on how to use Merkle Trees in combination with zkApps and +zero knowledge programming! + +Levels are indexed from leaves (level 0) to root (level N - 1). + +This function takes a height as argument and returns a class +that implements a merkletree with that specified height. + +It also holds the Witness class under tree.WITNESS + +## Parameters + +### height + +`number` + +## Returns + +[`AbstractMerkleTreeClass`](../interfaces/AbstractMerkleTreeClass.md) diff --git a/src/pages/docs/reference/common/functions/dummyValue.md b/src/pages/docs/reference/common/functions/dummyValue.md new file mode 100644 index 0000000..c5976c1 --- /dev/null +++ b/src/pages/docs/reference/common/functions/dummyValue.md @@ -0,0 +1,35 @@ +--- +title: dummyValue +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / dummyValue + +# Function: dummyValue() + +> **dummyValue**\<`Value`\>(`valueType`): `Value` + +Defined in: [packages/common/src/utils.ts:93](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L93) + +Computes a dummy value for the given value type. + +## Type Parameters + +• **Value** + +## Parameters + +### valueType + +`FlexibleProvablePure`\<`Value`\> + +Value type to generate the dummy value for + +## Returns + +`Value` + +Dummy value for the given value type diff --git a/src/pages/docs/reference/common/functions/expectDefined.md b/src/pages/docs/reference/common/functions/expectDefined.md new file mode 100644 index 0000000..edc59ef --- /dev/null +++ b/src/pages/docs/reference/common/functions/expectDefined.md @@ -0,0 +1,29 @@ +--- +title: expectDefined +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / expectDefined + +# Function: expectDefined() + +> **expectDefined**\<`T`\>(`value`): `asserts value is T` + +Defined in: [packages/common/src/utils.ts:165](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L165) + +## Type Parameters + +• **T** + +## Parameters + +### value + +`undefined` | `T` + +## Returns + +`asserts value is T` diff --git a/src/pages/docs/reference/common/functions/filterNonNull.md b/src/pages/docs/reference/common/functions/filterNonNull.md new file mode 100644 index 0000000..67d6498 --- /dev/null +++ b/src/pages/docs/reference/common/functions/filterNonNull.md @@ -0,0 +1,29 @@ +--- +title: filterNonNull +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / filterNonNull + +# Function: filterNonNull() + +> **filterNonNull**\<`Type`\>(`value`): `value is Type` + +Defined in: [packages/common/src/utils.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L132) + +## Type Parameters + +• **Type** + +## Parameters + +### value + +`null` | `Type` + +## Returns + +`value is Type` diff --git a/src/pages/docs/reference/common/functions/filterNonUndefined.md b/src/pages/docs/reference/common/functions/filterNonUndefined.md new file mode 100644 index 0000000..a385f61 --- /dev/null +++ b/src/pages/docs/reference/common/functions/filterNonUndefined.md @@ -0,0 +1,29 @@ +--- +title: filterNonUndefined +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / filterNonUndefined + +# Function: filterNonUndefined() + +> **filterNonUndefined**\<`Type`\>(`value`): `value is Type` + +Defined in: [packages/common/src/utils.ts:136](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L136) + +## Type Parameters + +• **Type** + +## Parameters + +### value + +`undefined` | `Type` + +## Returns + +`value is Type` diff --git a/src/pages/docs/reference/common/functions/getInjectAliases.md b/src/pages/docs/reference/common/functions/getInjectAliases.md new file mode 100644 index 0000000..38ce23d --- /dev/null +++ b/src/pages/docs/reference/common/functions/getInjectAliases.md @@ -0,0 +1,25 @@ +--- +title: getInjectAliases +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / getInjectAliases + +# Function: getInjectAliases() + +> **getInjectAliases**(`target`): `string`[] + +Defined in: [packages/common/src/config/injectAlias.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/injectAlias.ts#L63) + +## Parameters + +### target + +[`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\> + +## Returns + +`string`[] diff --git a/src/pages/docs/reference/common/functions/hashWithPrefix.md b/src/pages/docs/reference/common/functions/hashWithPrefix.md new file mode 100644 index 0000000..1bebf12 --- /dev/null +++ b/src/pages/docs/reference/common/functions/hashWithPrefix.md @@ -0,0 +1,29 @@ +--- +title: hashWithPrefix +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / hashWithPrefix + +# Function: hashWithPrefix() + +> **hashWithPrefix**(`prefix`, `input`): `Field` + +Defined in: [packages/common/src/utils.ts:154](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L154) + +## Parameters + +### prefix + +`string` + +### input + +`Field`[] + +## Returns + +`Field` diff --git a/src/pages/docs/reference/common/functions/implement.md b/src/pages/docs/reference/common/functions/implement.md new file mode 100644 index 0000000..ab7637e --- /dev/null +++ b/src/pages/docs/reference/common/functions/implement.md @@ -0,0 +1,48 @@ +--- +title: implement +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / implement + +# Function: implement() + +> **implement**\<`T`\>(`name`): (`target`) => `void` + +Defined in: [packages/common/src/config/injectAlias.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/injectAlias.ts#L51) + +Marks the class to implement a certain interface T, while also attaching +a DI-injection alias as metadata, that will be picked up by the ModuleContainer +to allow resolving by that interface name + +## Type Parameters + +• **T** + +## Parameters + +### name + +`string` + +The name of the injection alias, convention is to use the same as the name of T + +## Returns + +`Function` + +### Parameters + +#### target + +[`TypedClass`](../type-aliases/TypedClass.md)\<`T`\> + +Check if the target class extends RuntimeModule, while +also providing static config presets + +### Returns + +`void` diff --git a/src/pages/docs/reference/common/functions/injectAlias.md b/src/pages/docs/reference/common/functions/injectAlias.md new file mode 100644 index 0000000..fff7cee --- /dev/null +++ b/src/pages/docs/reference/common/functions/injectAlias.md @@ -0,0 +1,40 @@ +--- +title: injectAlias +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / injectAlias + +# Function: injectAlias() + +> **injectAlias**(`aliases`): (`target`) => `void` + +Defined in: [packages/common/src/config/injectAlias.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/injectAlias.ts#L11) + +Attaches metadata to the class that the ModuleContainer can pick up +and inject this class in the DI container under the specified aliases. +This method supports inheritance, therefore also gets aliases defined +on superclasses + +## Parameters + +### aliases + +`string`[] + +## Returns + +`Function` + +### Parameters + +#### target + +[`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\> + +### Returns + +`void` diff --git a/src/pages/docs/reference/common/functions/injectOptional.md b/src/pages/docs/reference/common/functions/injectOptional.md new file mode 100644 index 0000000..b471c48 --- /dev/null +++ b/src/pages/docs/reference/common/functions/injectOptional.md @@ -0,0 +1,60 @@ +--- +title: injectOptional +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / injectOptional + +# Function: injectOptional() + +> **injectOptional**\<`T`\>(`token`): (`target`, `propertyKey`, `parameterIndex`) => `any` + +Defined in: [packages/common/src/dependencyFactory/injectOptional.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/injectOptional.ts#L38) + +This function injects a dependency only if it has been registered, otherwise +injects undefined. This can be useful for having optional dependencies, where +tsyringe would normally error out and not be able to resolve. With this +decorator, we can now do this. + +The strategy we employ here is that we inject a dummy into the global +container that is of type UndefinedDisguise. We can't inject undefined +directly, therefore we use this object to disguise itself as undefined. +Then a child container registers something under the same token, it by +default resolves that new dependency. If that doesn't happen, the +resolution hits our disguise, which we then convert into undefined +using the Transform + +## Type Parameters + +• **T** + +## Parameters + +### token + +`string` + +## Returns + +`Function` + +### Parameters + +#### target + +`any` + +#### propertyKey + +`undefined` | `string` | `symbol` + +#### parameterIndex + +`number` + +### Returns + +`any` diff --git a/src/pages/docs/reference/common/functions/isSubtypeOfName.md b/src/pages/docs/reference/common/functions/isSubtypeOfName.md new file mode 100644 index 0000000..83ae3a3 --- /dev/null +++ b/src/pages/docs/reference/common/functions/isSubtypeOfName.md @@ -0,0 +1,32 @@ +--- +title: isSubtypeOfName +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / isSubtypeOfName + +# Function: isSubtypeOfName() + +> **isSubtypeOfName**(`clas`, `name`): `boolean` + +Defined in: [packages/common/src/utils.ts:181](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L181) + +Returns a boolean indicating whether a given class is a subclass of another class, +indicated by the name parameter. + +## Parameters + +### clas + +[`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\> + +### name + +`string` + +## Returns + +`boolean` diff --git a/src/pages/docs/reference/common/functions/mapSequential.md b/src/pages/docs/reference/common/functions/mapSequential.md new file mode 100644 index 0000000..527bce3 --- /dev/null +++ b/src/pages/docs/reference/common/functions/mapSequential.md @@ -0,0 +1,35 @@ +--- +title: mapSequential +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / mapSequential + +# Function: mapSequential() + +> **mapSequential**\<`T`, `R`\>(`array`, `f`): `Promise`\<`R`[]\> + +Defined in: [packages/common/src/utils.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L75) + +## Type Parameters + +• **T** + +• **R** + +## Parameters + +### array + +`T`[] + +### f + +(`element`, `index`, `array`) => `Promise`\<`R`\> + +## Returns + +`Promise`\<`R`[]\> diff --git a/src/pages/docs/reference/common/functions/noop.md b/src/pages/docs/reference/common/functions/noop.md new file mode 100644 index 0000000..a4df4bf --- /dev/null +++ b/src/pages/docs/reference/common/functions/noop.md @@ -0,0 +1,19 @@ +--- +title: noop +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / noop + +# Function: noop() + +> **noop**(): `void` + +Defined in: [packages/common/src/utils.ts:103](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L103) + +## Returns + +`void` diff --git a/src/pages/docs/reference/common/functions/prefixToField.md b/src/pages/docs/reference/common/functions/prefixToField.md new file mode 100644 index 0000000..cae9ba2 --- /dev/null +++ b/src/pages/docs/reference/common/functions/prefixToField.md @@ -0,0 +1,25 @@ +--- +title: prefixToField +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / prefixToField + +# Function: prefixToField() + +> **prefixToField**(`prefix`): `Field` + +Defined in: [packages/common/src/utils.ts:145](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L145) + +## Parameters + +### prefix + +`string` + +## Returns + +`Field` diff --git a/src/pages/docs/reference/common/functions/provableMethod.md b/src/pages/docs/reference/common/functions/provableMethod.md new file mode 100644 index 0000000..a9d4a5d --- /dev/null +++ b/src/pages/docs/reference/common/functions/provableMethod.md @@ -0,0 +1,55 @@ +--- +title: provableMethod +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / provableMethod + +# Function: provableMethod() + +> **provableMethod**(`isFirstParameterPublicInput`, `executionContext`): \<`Target`\>(`target`, `methodName`, `descriptor`) => `TypedPropertyDescriptor`\<(...`args`) => `any`\> + +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L70) + +Decorates a provable method on a 'prover class', depending on +if proofs are enabled or not, either runs the respective zkProgram prover, +or simulates the method execution and issues a mock proof. + +## Parameters + +### isFirstParameterPublicInput + +`boolean` = `true` + +### executionContext + +[`ProvableMethodExecutionContext`](../classes/ProvableMethodExecutionContext.md) = `...` + +## Returns + +`Function` + +### Type Parameters + +• **Target** *extends* [`ZkProgrammable`](../classes/ZkProgrammable.md)\<`any`, `any`\> \| [`WithZkProgrammable`](../interfaces/WithZkProgrammable.md)\<`any`, `any`\> + +### Parameters + +#### target + +`Target` + +#### methodName + +`string` + +#### descriptor + +`TypedPropertyDescriptor`\<(...`args`) => `any`\> + +### Returns + +`TypedPropertyDescriptor`\<(...`args`) => `any`\> diff --git a/src/pages/docs/reference/common/functions/range.md b/src/pages/docs/reference/common/functions/range.md new file mode 100644 index 0000000..6602c1c --- /dev/null +++ b/src/pages/docs/reference/common/functions/range.md @@ -0,0 +1,29 @@ +--- +title: range +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / range + +# Function: range() + +> **range**(`startOrEnd`, `endOrNothing`?): `number`[] + +Defined in: [packages/common/src/utils.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L43) + +## Parameters + +### startOrEnd + +`number` + +### endOrNothing? + +`number` + +## Returns + +`number`[] diff --git a/src/pages/docs/reference/common/functions/reduceSequential.md b/src/pages/docs/reference/common/functions/reduceSequential.md new file mode 100644 index 0000000..77d4f0a --- /dev/null +++ b/src/pages/docs/reference/common/functions/reduceSequential.md @@ -0,0 +1,39 @@ +--- +title: reduceSequential +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / reduceSequential + +# Function: reduceSequential() + +> **reduceSequential**\<`T`, `U`\>(`array`, `callbackfn`, `initialValue`): `Promise`\<`U`\> + +Defined in: [packages/common/src/utils.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L56) + +## Type Parameters + +• **T** + +• **U** + +## Parameters + +### array + +`T`[] + +### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `Promise`\<`U`\> + +### initialValue + +`U` + +## Returns + +`Promise`\<`U`\> diff --git a/src/pages/docs/reference/common/functions/requireTrue.md b/src/pages/docs/reference/common/functions/requireTrue.md new file mode 100644 index 0000000..80596cf --- /dev/null +++ b/src/pages/docs/reference/common/functions/requireTrue.md @@ -0,0 +1,29 @@ +--- +title: requireTrue +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / requireTrue + +# Function: requireTrue() + +> **requireTrue**(`condition`, `errorOrFunction`): `void` + +Defined in: [packages/common/src/utils.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L11) + +## Parameters + +### condition + +`boolean` + +### errorOrFunction + +`Error` | () => `Error` + +## Returns + +`void` diff --git a/src/pages/docs/reference/common/functions/safeParseJson.md b/src/pages/docs/reference/common/functions/safeParseJson.md new file mode 100644 index 0000000..1dc5d0a --- /dev/null +++ b/src/pages/docs/reference/common/functions/safeParseJson.md @@ -0,0 +1,29 @@ +--- +title: safeParseJson +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / safeParseJson + +# Function: safeParseJson() + +> **safeParseJson**\<`T`\>(`json`): `T` + +Defined in: [packages/common/src/utils.ts:197](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L197) + +## Type Parameters + +• **T** + +## Parameters + +### json + +`string` + +## Returns + +`T` diff --git a/src/pages/docs/reference/common/functions/sleep.md b/src/pages/docs/reference/common/functions/sleep.md new file mode 100644 index 0000000..2a582cd --- /dev/null +++ b/src/pages/docs/reference/common/functions/sleep.md @@ -0,0 +1,25 @@ +--- +title: sleep +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / sleep + +# Function: sleep() + +> **sleep**(`ms`): `Promise`\<`void`\> + +Defined in: [packages/common/src/utils.ts:126](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L126) + +## Parameters + +### ms + +`number` + +## Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/common/functions/splitArray.md b/src/pages/docs/reference/common/functions/splitArray.md new file mode 100644 index 0000000..15d91d5 --- /dev/null +++ b/src/pages/docs/reference/common/functions/splitArray.md @@ -0,0 +1,38 @@ +--- +title: splitArray +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / splitArray + +# Function: splitArray() + +> **splitArray**\<`T`, `K`\>(`arr`, `split`): `Record`\<`K`, `T`[] \| `undefined`\> + +Defined in: [packages/common/src/utils.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L26) + +Utility function to split an array of type T into a record based on a +function T => K that determines the key of each record + +## Type Parameters + +• **T** + +• **K** *extends* `string` \| `number` + +## Parameters + +### arr + +`T`[] + +### split + +(`t`) => `K` + +## Returns + +`Record`\<`K`, `T`[] \| `undefined`\> diff --git a/src/pages/docs/reference/common/functions/toProver.md b/src/pages/docs/reference/common/functions/toProver.md new file mode 100644 index 0000000..5040f5f --- /dev/null +++ b/src/pages/docs/reference/common/functions/toProver.md @@ -0,0 +1,47 @@ +--- +title: toProver +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / toProver + +# Function: toProver() + +> **toProver**(`methodName`, `simulatedMethod`, `isFirstParameterPublicInput`, ...`args`): (`this`) => `Promise`\<`Proof`\<`any`, `any`\>\> + +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L20) + +## Parameters + +### methodName + +`string` + +### simulatedMethod + +[`DecoratedMethod`](../type-aliases/DecoratedMethod.md) + +### isFirstParameterPublicInput + +`boolean` + +### args + +...[`ArgumentTypes`](../type-aliases/ArgumentTypes.md) + +## Returns + +`Function` + +### Parameters + +#### this + +[`ZkProgrammable`](../classes/ZkProgrammable.md)\<`any`, `any`\> + +### Returns + +`Promise`\<`Proof`\<`any`, `any`\>\> diff --git a/src/pages/docs/reference/common/functions/verifyToMockable.md b/src/pages/docs/reference/common/functions/verifyToMockable.md new file mode 100644 index 0000000..9e04f3f --- /dev/null +++ b/src/pages/docs/reference/common/functions/verifyToMockable.md @@ -0,0 +1,45 @@ +--- +title: verifyToMockable +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / verifyToMockable + +# Function: verifyToMockable() + +> **verifyToMockable**\<`PublicInput`, `PublicOutput`\>(`verify`, `__namedParameters`): (`proof`) => `Promise`\<`boolean`\> + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L59) + +## Type Parameters + +• **PublicInput** + +• **PublicOutput** + +## Parameters + +### verify + +[`Verify`](../interfaces/Verify.md)\<`PublicInput`, `PublicOutput`\> + +### \_\_namedParameters + +[`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) + +## Returns + +`Function` + +### Parameters + +#### proof + +`Proof`\<`PublicInput`, `PublicOutput`\> + +### Returns + +`Promise`\<`boolean`\> diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md new file mode 100644 index 0000000..f6aca64 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md @@ -0,0 +1,177 @@ +--- +title: AbstractMerkleTree +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / AbstractMerkleTree + +# Interface: AbstractMerkleTree + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L41) + +## Extended by + +- [`RollupMerkleTree`](../classes/RollupMerkleTree.md) +- [`FeeTree`](../../library/classes/FeeTree.md) +- [`BlockHashMerkleTree`](../../protocol/classes/BlockHashMerkleTree.md) +- [`TokenBridgeTree`](../../protocol/classes/TokenBridgeTree.md) +- [`VKTree`](../../protocol/classes/VKTree.md) + +## Properties + +### leafCount + +> `readonly` **leafCount**: `bigint` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L43) + +*** + +### store + +> **store**: [`MerkleTreeStore`](MerkleTreeStore.md) + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L42) + +## Methods + +### assertIndexRange() + +> **assertIndexRange**(`index`): `void` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L45) + +#### Parameters + +##### index + +`bigint` + +#### Returns + +`void` + +*** + +### fill() + +> **fill**(`leaves`): `void` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L81) + +Fills all leaves of the tree. + +#### Parameters + +##### leaves + +`Field`[] + +Values to fill the leaves with. + +#### Returns + +`void` + +*** + +### getNode() + +> **getNode**(`level`, `index`): `Field` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L53) + +Returns a node which lives at a given index and level. + +#### Parameters + +##### level + +`number` + +Level of the node. + +##### index + +`bigint` + +Index of the node. + +#### Returns + +`Field` + +The data of the node. + +*** + +### getRoot() + +> **getRoot**(): `Field` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L59) + +Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). + +#### Returns + +`Field` + +The root of the Merkle Tree. + +*** + +### getWitness() + +> **getWitness**(`index`): [`AbstractMerkleWitness`](AbstractMerkleWitness.md) + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L75) + +Returns the witness (also known as +[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) +for the leaf at the given index. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +#### Returns + +[`AbstractMerkleWitness`](AbstractMerkleWitness.md) + +The witness that belongs to the leaf. + +*** + +### setLeaf() + +> **setLeaf**(`index`, `leaf`): `void` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L66) + +Sets the value of a leaf node at a given index to a given value. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +##### leaf + +`Field` + +New value. + +#### Returns + +`void` diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md new file mode 100644 index 0000000..1cad3c5 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md @@ -0,0 +1,79 @@ +--- +title: AbstractMerkleTreeClass +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / AbstractMerkleTreeClass + +# Interface: AbstractMerkleTreeClass + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L84) + +## Constructors + +### new AbstractMerkleTreeClass() + +> **new AbstractMerkleTreeClass**(`store`): [`AbstractMerkleTree`](AbstractMerkleTree.md) + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L85) + +#### Parameters + +##### store + +[`MerkleTreeStore`](MerkleTreeStore.md) + +#### Returns + +[`AbstractMerkleTree`](AbstractMerkleTree.md) + +## Properties + +### EMPTY\_ROOT + +> **EMPTY\_ROOT**: `bigint` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L92) + +*** + +### HEIGHT + +> **HEIGHT**: `number` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L90) + +*** + +### WITNESS + +> **WITNESS**: [`TypedClass`](../type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L87) + +#### Type declaration + +##### dummy() + +> **dummy**: () => [`AbstractMerkleWitness`](AbstractMerkleWitness.md) + +###### Returns + +[`AbstractMerkleWitness`](AbstractMerkleWitness.md) + +## Accessors + +### leafCount + +#### Get Signature + +> **get** **leafCount**(): `bigint` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L94) + +##### Returns + +`bigint` diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md new file mode 100644 index 0000000..563f681 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md @@ -0,0 +1,155 @@ +--- +title: AbstractMerkleWitness +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / AbstractMerkleWitness + +# Interface: AbstractMerkleWitness + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L14) + +## Extends + +- `StructTemplate` + +## Properties + +### isLeft + +> **isLeft**: `Bool`[] + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L11) + +#### Inherited from + +`StructTemplate.isLeft` + +*** + +### path + +> **path**: `Field`[] + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L10) + +#### Inherited from + +`StructTemplate.path` + +## Methods + +### calculateIndex() + +> **calculateIndex**(): `Field` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L28) + +Calculates the index of the leaf node that belongs to this Witness. + +#### Returns + +`Field` + +Index of the leaf. + +*** + +### calculateRoot() + +> **calculateRoot**(`hash`): `Field` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L22) + +Calculates a root depending on the leaf value. + +#### Parameters + +##### hash + +`Field` + +#### Returns + +`Field` + +The calculated root. + +*** + +### checkMembership() + +> **checkMembership**(`root`, `key`, `value`): `Bool` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L30) + +#### Parameters + +##### root + +`Field` + +##### key + +`Field` + +##### value + +`Field` + +#### Returns + +`Bool` + +*** + +### checkMembershipGetRoots() + +> **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L32) + +#### Parameters + +##### root + +`Field` + +##### key + +`Field` + +##### value + +`Field` + +#### Returns + +\[`Bool`, `Field`, `Field`\] + +*** + +### height() + +> **height**(): `number` + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L15) + +#### Returns + +`number` + +*** + +### toShortenedEntries() + +> **toShortenedEntries**(): `string`[] + +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L38) + +#### Returns + +`string`[] diff --git a/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md b/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md new file mode 100644 index 0000000..7940daf --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md @@ -0,0 +1,39 @@ +--- +title: AreProofsEnabled +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / AreProofsEnabled + +# Interface: AreProofsEnabled + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L23) + +## Properties + +### areProofsEnabled + +> **areProofsEnabled**: `boolean` + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L24) + +*** + +### setProofsEnabled() + +> **setProofsEnabled**: (`areProofsEnabled`) => `void` + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L25) + +#### Parameters + +##### areProofsEnabled + +`boolean` + +#### Returns + +`void` diff --git a/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md b/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md new file mode 100644 index 0000000..fe5a0d9 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md @@ -0,0 +1,51 @@ +--- +title: BaseModuleInstanceType +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / BaseModuleInstanceType + +# Interface: BaseModuleInstanceType + +Defined in: [packages/common/src/config/ModuleContainer.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L73) + +## Extends + +- [`ChildContainerCreatable`](ChildContainerCreatable.md).[`Configurable`](Configurable.md)\<`unknown`\> + +## Properties + +### config + +> **config**: `unknown` + +Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L19) + +#### Inherited from + +[`Configurable`](Configurable.md).[`config`](Configurable.md#config) + +*** + +### create() + +> **create**: (`childContainerProvider`) => `void` + +Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ChildContainerCreatable.ts#L4) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ChildContainerCreatable`](ChildContainerCreatable.md).[`create`](ChildContainerCreatable.md#create) diff --git a/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md b/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md new file mode 100644 index 0000000..e5b249d --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md @@ -0,0 +1,35 @@ +--- +title: ChildContainerCreatable +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ChildContainerCreatable + +# Interface: ChildContainerCreatable + +Defined in: [packages/common/src/config/ChildContainerCreatable.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ChildContainerCreatable.ts#L3) + +## Extended by + +- [`BaseModuleInstanceType`](BaseModuleInstanceType.md) + +## Properties + +### create() + +> **create**: (`childContainerProvider`) => `void` + +Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ChildContainerCreatable.ts#L4) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](ChildContainerProvider.md) + +#### Returns + +`void` diff --git a/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md b/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md new file mode 100644 index 0000000..d551400 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md @@ -0,0 +1,21 @@ +--- +title: ChildContainerProvider +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ChildContainerProvider + +# Interface: ChildContainerProvider() + +Defined in: [packages/common/src/config/ChildContainerProvider.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ChildContainerProvider.ts#L3) + +> **ChildContainerProvider**(): `DependencyContainer` + +Defined in: [packages/common/src/config/ChildContainerProvider.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ChildContainerProvider.ts#L4) + +## Returns + +`DependencyContainer` diff --git a/src/pages/docs/reference/common/interfaces/CompilableModule.md b/src/pages/docs/reference/common/interfaces/CompilableModule.md new file mode 100644 index 0000000..65f1749 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/CompilableModule.md @@ -0,0 +1,36 @@ +--- +title: CompilableModule +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CompilableModule + +# Interface: CompilableModule + +Defined in: [packages/common/src/compiling/CompilableModule.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompilableModule.ts#L4) + +## Extended by + +- [`BlockProvable`](../../protocol/interfaces/BlockProvable.md) +- [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../type-aliases/ArtifactRecord.md)\> + +Defined in: [packages/common/src/compiling/CompilableModule.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompilableModule.ts#L5) + +#### Parameters + +##### registry + +[`CompileRegistry`](../classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`void` \| [`ArtifactRecord`](../type-aliases/ArtifactRecord.md)\> diff --git a/src/pages/docs/reference/common/interfaces/Compile.md b/src/pages/docs/reference/common/interfaces/Compile.md new file mode 100644 index 0000000..cecf1f1 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/Compile.md @@ -0,0 +1,21 @@ +--- +title: Compile +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / Compile + +# Interface: Compile() + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L32) + +> **Compile**(): `Promise`\<[`CompileArtifact`](CompileArtifact.md)\> + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L33) + +## Returns + +`Promise`\<[`CompileArtifact`](CompileArtifact.md)\> diff --git a/src/pages/docs/reference/common/interfaces/CompileArtifact.md b/src/pages/docs/reference/common/interfaces/CompileArtifact.md new file mode 100644 index 0000000..c846d2d --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/CompileArtifact.md @@ -0,0 +1,29 @@ +--- +title: CompileArtifact +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CompileArtifact + +# Interface: CompileArtifact + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L16) + +## Properties + +### verificationKey + +> **verificationKey**: `object` + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L17) + +#### data + +> **data**: `string` + +#### hash + +> **hash**: `Field` diff --git a/src/pages/docs/reference/common/interfaces/Configurable.md b/src/pages/docs/reference/common/interfaces/Configurable.md new file mode 100644 index 0000000..ec9a656 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/Configurable.md @@ -0,0 +1,29 @@ +--- +title: Configurable +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / Configurable + +# Interface: Configurable\ + +Defined in: [packages/common/src/config/ConfigurableModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L18) + +## Extended by + +- [`BaseModuleInstanceType`](BaseModuleInstanceType.md) + +## Type Parameters + +• **Config** + +## Properties + +### config + +> **config**: `Config` + +Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L19) diff --git a/src/pages/docs/reference/common/interfaces/DependencyFactory.md b/src/pages/docs/reference/common/interfaces/DependencyFactory.md new file mode 100644 index 0000000..595a7fc --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/DependencyFactory.md @@ -0,0 +1,41 @@ +--- +title: DependencyFactory +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / DependencyFactory + +# Interface: DependencyFactory + +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L34) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Extended by + +- [`BaseLayer`](../../sequencer/interfaces/BaseLayer.md) +- [`StorageDependencyFactory`](../../sequencer/interfaces/StorageDependencyFactory.md) + +## Properties + +### dependencies() + +> **dependencies**: () => [`DependencyRecord`](../type-aliases/DependencyRecord.md) + +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L35) + +#### Returns + +[`DependencyRecord`](../type-aliases/DependencyRecord.md) diff --git a/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md b/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md new file mode 100644 index 0000000..34af92b --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md @@ -0,0 +1,29 @@ +--- +title: EventEmittingComponent +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventEmittingComponent + +# Interface: EventEmittingComponent\ + +Defined in: [packages/common/src/events/EventEmittingComponent.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmittingComponent.ts#L5) + +## Extended by + +- [`Mempool`](../../sequencer/interfaces/Mempool.md) + +## Type Parameters + +• **Events** *extends* [`EventsRecord`](../type-aliases/EventsRecord.md) + +## Properties + +### events + +> **events**: [`EventEmitter`](../classes/EventEmitter.md)\<`Events`\> + +Defined in: [packages/common/src/events/EventEmittingComponent.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmittingComponent.ts#L6) diff --git a/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md b/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md new file mode 100644 index 0000000..79e8610 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md @@ -0,0 +1,25 @@ +--- +title: EventEmittingContainer +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventEmittingContainer + +# Interface: EventEmittingContainer\ + +Defined in: [packages/common/src/events/EventEmittingComponent.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmittingComponent.ts#L9) + +## Type Parameters + +• **Events** *extends* [`EventsRecord`](../type-aliases/EventsRecord.md) + +## Properties + +### containerEvents + +> **containerEvents**: [`EventEmitter`](../classes/EventEmitter.md)\<`Events`\> + +Defined in: [packages/common/src/events/EventEmittingComponent.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmittingComponent.ts#L10) diff --git a/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md b/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md new file mode 100644 index 0000000..fafc74f --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md @@ -0,0 +1,61 @@ +--- +title: MerkleTreeStore +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MerkleTreeStore + +# Interface: MerkleTreeStore + +Defined in: [packages/common/src/trees/MerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MerkleTreeStore.ts#L1) + +## Properties + +### getNode() + +> **getNode**: (`key`, `level`) => `undefined` \| `bigint` + +Defined in: [packages/common/src/trees/MerkleTreeStore.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MerkleTreeStore.ts#L4) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +#### Returns + +`undefined` \| `bigint` + +*** + +### setNode() + +> **setNode**: (`key`, `level`, `value`) => `void` + +Defined in: [packages/common/src/trees/MerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MerkleTreeStore.ts#L2) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +##### value + +`bigint` + +#### Returns + +`void` diff --git a/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md b/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md new file mode 100644 index 0000000..7c5225a --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md @@ -0,0 +1,37 @@ +--- +title: ModuleContainerDefinition +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModuleContainerDefinition + +# Interface: ModuleContainerDefinition\ + +Defined in: [packages/common/src/config/ModuleContainer.ts:115](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L115) + +Parameters required when creating a module container instance + +## Type Parameters + +• **Modules** *extends* [`ModulesRecord`](ModulesRecord.md) + +## Properties + +### ~~config?~~ + +> `optional` **config**: [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: [packages/common/src/config/ModuleContainer.ts:121](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L121) + +#### Deprecated + +*** + +### modules + +> **modules**: `Modules` + +Defined in: [packages/common/src/config/ModuleContainer.ts:116](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L116) diff --git a/src/pages/docs/reference/common/interfaces/ModulesRecord.md b/src/pages/docs/reference/common/interfaces/ModulesRecord.md new file mode 100644 index 0000000..241e6e2 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/ModulesRecord.md @@ -0,0 +1,21 @@ +--- +title: ModulesRecord +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModulesRecord + +# Interface: ModulesRecord\ + +Defined in: [packages/common/src/config/ModuleContainer.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L81) + +## Type Parameters + +• **ModuleType** *extends* [`BaseModuleType`](../type-aliases/BaseModuleType.md) = [`BaseModuleType`](../type-aliases/BaseModuleType.md) + +## Indexable + +\[`name`: `string`\]: `ModuleType` diff --git a/src/pages/docs/reference/common/interfaces/PlainZkProgram.md b/src/pages/docs/reference/common/interfaces/PlainZkProgram.md new file mode 100644 index 0000000..eb3e93e --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/PlainZkProgram.md @@ -0,0 +1,237 @@ +--- +title: PlainZkProgram +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / PlainZkProgram + +# Interface: PlainZkProgram\ + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L36) + +## Type Parameters + +• **PublicInput** = `undefined` + +• **PublicOutput** = `void` + +## Properties + +### analyzeMethods() + +> **analyzeMethods**: () => `Promise`\<`Record`\<`string`, \{ `digest`: `string`; `gates`: `Gate`[]; `publicInputSize`: `number`; `rows`: `number`; `print`: `void`; `summary`: `Partial`\<`Record`\<`GateType` \| `"Total rows"`, `number`\>\>; \}\>\> + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L54) + +#### Returns + +`Promise`\<`Record`\<`string`, \{ `digest`: `string`; `gates`: `Gate`[]; `publicInputSize`: `number`; `rows`: `number`; `print`: `void`; `summary`: `Partial`\<`Record`\<`GateType` \| `"Total rows"`, `number`\>\>; \}\>\> + +*** + +### compile + +> **compile**: [`Compile`](Compile.md) + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L38) + +*** + +### methods + +> **methods**: `Record`\<`string`, (...`args`) => `Promise`\<`Proof`\<`PublicInput`, `PublicOutput`\>\> \| (`publicInput`, ...`args`) => `Promise`\<`Proof`\<`PublicInput`, `PublicOutput`\>\>\> + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L46) + +*** + +### name + +> **name**: `string` + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L37) + +*** + +### Proof() + +> **Proof**: (`__namedParameters`) => `object` + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L40) + +#### Parameters + +##### \_\_namedParameters + +###### maxProofsVerified + +`0` \| `1` \| `2` + +###### proof + +`unknown` + +###### publicInput + +`PublicInput` \| `StructPure`\<`PublicInput`\> *extends* `GenericProvable`\<`PublicInput`, `any`, `Field`\> ? `PublicInput` : `PublicInput` + +###### publicOutput + +`PublicOutput` \| `StructPure`\<`PublicOutput`\> *extends* `GenericProvable`\<`PublicOutput`, `any`, `Field`\> ? `PublicOutput` : `PublicOutput` + +#### Returns + +`object` + +##### maxProofsVerified + +> **maxProofsVerified**: `0` \| `1` \| `2` + +##### proof + +> **proof**: `unknown` + +##### publicInput + +> **publicInput**: `PublicInput` \| `StructPure`\<`PublicInput`\> *extends* `GenericProvable`\<`PublicInput`, `any`, `Field`\> ? `PublicInput` : `PublicInput` + +##### publicOutput + +> **publicOutput**: `PublicOutput` \| `StructPure`\<`PublicOutput`\> *extends* `GenericProvable`\<`PublicOutput`, `any`, `Field`\> ? `PublicOutput` : `PublicOutput` + +##### shouldVerify + +> **shouldVerify**: `Bool` + +##### toJSON() + +###### Returns + +`JsonProof` + +##### verify() + +###### Returns + +`void` + +##### verifyIf() + +###### Parameters + +###### condition + +`Bool` + +###### Returns + +`void` + +#### publicInputType + +> **publicInputType**: `FlexibleProvablePure`\<`PublicInput`\> + +#### publicOutputType + +> **publicOutputType**: `FlexibleProvablePure`\<`PublicOutput`\> + +#### tag() + +> **tag**: () => `object` + +##### Returns + +`object` + +###### name + +> **name**: `string` + +###### publicInputType + +> **publicInputType**: `FlexibleProvablePure`\<`PublicInput`\> + +###### publicOutputType + +> **publicOutputType**: `FlexibleProvablePure`\<`PublicOutput`\> + +#### dummy() + +Dummy proof. This can be useful for ZkPrograms that handle the base case in the same +method as the inductive case, using a pattern like this: + +```ts +method(proof: SelfProof, isRecursive: Bool) { + proof.verifyIf(isRecursive); + // ... +} +``` + +To use such a method in the base case, you need a dummy proof: + +```ts +let dummy = await MyProof.dummy(publicInput, publicOutput, 1); +await myProgram.myMethod(dummy, Bool(false)); +``` + +**Note**: The types of `publicInput` and `publicOutput`, as well as the `maxProofsVerified` parameter, +must match your ZkProgram. `maxProofsVerified` is the maximum number of proofs that any of your methods take as arguments. + +##### Type Parameters + +• **Input** + +• **OutPut** + +##### Parameters + +###### publicInput + +`Input` + +###### publicOutput + +`OutPut` + +###### maxProofsVerified + +`0` | `1` | `2` + +###### domainLog2? + +`number` + +##### Returns + +`Promise`\<`Proof`\<`Input`, `OutPut`\>\> + +#### fromJSON() + +##### Type Parameters + +• **S** *extends* `Subclass`\<*typeof* `Proof`\> + +##### Parameters + +###### this + +`S` + +###### \_\_namedParameters + +`JsonProof` + +##### Returns + +`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +*** + +### verify + +> **verify**: [`Verify`](Verify.md)\<`PublicInput`, `PublicOutput`\> + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L39) diff --git a/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md b/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md new file mode 100644 index 0000000..1c64742 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md @@ -0,0 +1,25 @@ +--- +title: StaticConfigurableModule +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / StaticConfigurableModule + +# Interface: StaticConfigurableModule\ + +Defined in: [packages/common/src/config/ConfigurableModule.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L55) + +## Type Parameters + +• **Config** + +## Properties + +### presets + +> **presets**: [`Presets`](../type-aliases/Presets.md)\<`Config`\> + +Defined in: [packages/common/src/config/ConfigurableModule.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L56) diff --git a/src/pages/docs/reference/common/interfaces/ToFieldable.md b/src/pages/docs/reference/common/interfaces/ToFieldable.md new file mode 100644 index 0000000..8f100df --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/ToFieldable.md @@ -0,0 +1,25 @@ +--- +title: ToFieldable +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ToFieldable + +# Interface: ToFieldable + +Defined in: [packages/common/src/utils.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L105) + +## Properties + +### toFields() + +> **toFields**: () => `Field`[] + +Defined in: [packages/common/src/utils.ts:106](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L106) + +#### Returns + +`Field`[] diff --git a/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md b/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md new file mode 100644 index 0000000..d648aa4 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md @@ -0,0 +1,31 @@ +--- +title: ToFieldableStatic +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ToFieldableStatic + +# Interface: ToFieldableStatic + +Defined in: [packages/common/src/utils.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L109) + +## Properties + +### toFields() + +> **toFields**: (`value`) => `Field`[] + +Defined in: [packages/common/src/utils.ts:110](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L110) + +#### Parameters + +##### value + +`unknown` + +#### Returns + +`Field`[] diff --git a/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md b/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md new file mode 100644 index 0000000..72af933 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md @@ -0,0 +1,31 @@ +--- +title: ToJSONableStatic +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ToJSONableStatic + +# Interface: ToJSONableStatic + +Defined in: [packages/common/src/utils.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L113) + +## Properties + +### toJSON() + +> **toJSON**: (`value`) => `any` + +Defined in: [packages/common/src/utils.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L114) + +#### Parameters + +##### value + +`unknown` + +#### Returns + +`any` diff --git a/src/pages/docs/reference/common/interfaces/Verify.md b/src/pages/docs/reference/common/interfaces/Verify.md new file mode 100644 index 0000000..4181ea9 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/Verify.md @@ -0,0 +1,33 @@ +--- +title: Verify +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / Verify + +# Interface: Verify()\ + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L28) + +## Type Parameters + +• **PublicInput** + +• **PublicOutput** + +> **Verify**(`proof`): `Promise`\<`boolean`\> + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L29) + +## Parameters + +### proof + +`Proof`\<`PublicInput`, `PublicOutput`\> + +## Returns + +`Promise`\<`boolean`\> diff --git a/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md b/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md new file mode 100644 index 0000000..1bcb362 --- /dev/null +++ b/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md @@ -0,0 +1,33 @@ +--- +title: WithZkProgrammable +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / WithZkProgrammable + +# Interface: WithZkProgrammable\ + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:146](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L146) + +## Extended by + +- [`RuntimeEnvironment`](../../module/interfaces/RuntimeEnvironment.md) +- [`BlockProvable`](../../protocol/interfaces/BlockProvable.md) +- [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) + +## Type Parameters + +• **PublicInput** = `undefined` + +• **PublicOutput** = `void` + +## Properties + +### zkProgrammable + +> **zkProgrammable**: [`ZkProgrammable`](../classes/ZkProgrammable.md)\<`PublicInput`, `PublicOutput`\> + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:150](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L150) diff --git a/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md b/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md new file mode 100644 index 0000000..3b61341 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md @@ -0,0 +1,15 @@ +--- +title: ArgumentTypes +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ArgumentTypes + +# Type Alias: ArgumentTypes + +> **ArgumentTypes**: ([`O1JSPrimitive`](O1JSPrimitive.md) \| `Proof`\<`unknown`, `unknown`\> \| `DynamicProof`\<`unknown`, `unknown`\>)[] + +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L9) diff --git a/src/pages/docs/reference/common/type-aliases/ArrayElement.md b/src/pages/docs/reference/common/type-aliases/ArrayElement.md new file mode 100644 index 0000000..9d1f063 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/ArrayElement.md @@ -0,0 +1,21 @@ +--- +title: ArrayElement +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ArrayElement + +# Type Alias: ArrayElement\ + +> **ArrayElement**\<`ArrayType`\>: `ArrayType` *extends* readonly infer ElementType[] ? `ElementType` : `never` + +Defined in: [packages/common/src/types.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L18) + +Utility type to infer element type from an array type + +## Type Parameters + +• **ArrayType** *extends* readonly `unknown`[] diff --git a/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md b/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md new file mode 100644 index 0000000..a85410d --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md @@ -0,0 +1,15 @@ +--- +title: ArtifactRecord +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ArtifactRecord + +# Type Alias: ArtifactRecord + +> **ArtifactRecord**: `Record`\<`string`, [`CompileArtifact`](../interfaces/CompileArtifact.md)\> + +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/AtomicCompileHelper.ts#L10) diff --git a/src/pages/docs/reference/common/type-aliases/BaseModuleType.md b/src/pages/docs/reference/common/type-aliases/BaseModuleType.md new file mode 100644 index 0000000..f4e7bdd --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/BaseModuleType.md @@ -0,0 +1,15 @@ +--- +title: BaseModuleType +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / BaseModuleType + +# Type Alias: BaseModuleType + +> **BaseModuleType**: [`TypedClass`](TypedClass.md)\<[`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md)\> + +Defined in: [packages/common/src/config/ModuleContainer.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L78) diff --git a/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md b/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md new file mode 100644 index 0000000..909eb29 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md @@ -0,0 +1,19 @@ +--- +title: CapitalizeAny +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CapitalizeAny + +# Type Alias: CapitalizeAny\ + +> **CapitalizeAny**\<`Key`\>: `Key` *extends* `string` ? `Capitalize`\<`Key`\> : `Key` + +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L45) + +## Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` diff --git a/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md b/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md new file mode 100644 index 0000000..9ced49a --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md @@ -0,0 +1,19 @@ +--- +title: CastToEventsRecord +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CastToEventsRecord + +# Type Alias: CastToEventsRecord\ + +> **CastToEventsRecord**\<`Record`\>: `Record` *extends* [`EventsRecord`](EventsRecord.md) ? `Record` : `object` + +Defined in: [packages/common/src/events/EventEmitterProxy.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L15) + +## Type Parameters + +• **Record** diff --git a/src/pages/docs/reference/common/type-aliases/CompileTarget.md b/src/pages/docs/reference/common/type-aliases/CompileTarget.md new file mode 100644 index 0000000..0869f4d --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/CompileTarget.md @@ -0,0 +1,29 @@ +--- +title: CompileTarget +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CompileTarget + +# Type Alias: CompileTarget + +> **CompileTarget**: `object` + +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/AtomicCompileHelper.ts#L12) + +## Type declaration + +### compile() + +> **compile**: () => `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> + +#### Returns + +`Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> + +### name + +> **name**: `string` diff --git a/src/pages/docs/reference/common/type-aliases/ContainerEvents.md b/src/pages/docs/reference/common/type-aliases/ContainerEvents.md new file mode 100644 index 0000000..31230a4 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/ContainerEvents.md @@ -0,0 +1,19 @@ +--- +title: ContainerEvents +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ContainerEvents + +# Type Alias: ContainerEvents\ + +> **ContainerEvents**\<`Modules`\>: `{ [Key in StringKeyOf]: ModuleEvents }` + +Defined in: [packages/common/src/events/EventEmitterProxy.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L32) + +## Type Parameters + +• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md b/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md new file mode 100644 index 0000000..beb95cb --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md @@ -0,0 +1,25 @@ +--- +title: DecoratedMethod +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / DecoratedMethod + +# Type Alias: DecoratedMethod() + +> **DecoratedMethod**: (...`args`) => `Promise`\<`unknown`\> + +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L15) + +## Parameters + +### args + +...[`ArgumentTypes`](ArgumentTypes.md) + +## Returns + +`Promise`\<`unknown`\> diff --git a/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md b/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md new file mode 100644 index 0000000..ca269e8 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md @@ -0,0 +1,19 @@ +--- +title: DependenciesFromModules +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / DependenciesFromModules + +# Type Alias: DependenciesFromModules\ + +> **DependenciesFromModules**\<`Modules`\>: [`FilterNeverValues`](FilterNeverValues.md)\<`{ [Key in keyof Modules]: Modules[Key] extends TypedClass ? InferDependencies> : never }`\> + +Defined in: [packages/common/src/config/ModuleContainer.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L129) + +## Type Parameters + +• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md b/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md new file mode 100644 index 0000000..c5faa9f --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md @@ -0,0 +1,19 @@ +--- +title: DependencyDeclaration +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / DependencyDeclaration + +# Type Alias: DependencyDeclaration\ + +> **DependencyDeclaration**\<`Dependency`\>: `ClassProvider`\<`Dependency`\> \| `FactoryProvider`\<`Dependency`\> \| `TokenProvider`\<`Dependency`\> \| `ValueProvider`\<`Dependency`\> + +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L11) + +## Type Parameters + +• **Dependency** diff --git a/src/pages/docs/reference/common/type-aliases/DependencyRecord.md b/src/pages/docs/reference/common/type-aliases/DependencyRecord.md new file mode 100644 index 0000000..4416504 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/DependencyRecord.md @@ -0,0 +1,15 @@ +--- +title: DependencyRecord +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / DependencyRecord + +# Type Alias: DependencyRecord + +> **DependencyRecord**: `Record`\<`string`, [`DependencyDeclaration`](DependencyDeclaration.md)\<`unknown`\> & `object`\> + +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L17) diff --git a/src/pages/docs/reference/common/type-aliases/EventListenable.md b/src/pages/docs/reference/common/type-aliases/EventListenable.md new file mode 100644 index 0000000..be416a5 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/EventListenable.md @@ -0,0 +1,19 @@ +--- +title: EventListenable +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventListenable + +# Type Alias: EventListenable\ + +> **EventListenable**\<`Events`\>: `Pick`\<[`EventEmitter`](../classes/EventEmitter.md)\<`Events`\>, `"on"` \| `"onAll"` \| `"off"`\> + +Defined in: [packages/common/src/events/EventEmitter.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L58) + +## Type Parameters + +• **Events** *extends* [`EventsRecord`](EventsRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/EventsRecord.md b/src/pages/docs/reference/common/type-aliases/EventsRecord.md new file mode 100644 index 0000000..2559ad2 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/EventsRecord.md @@ -0,0 +1,15 @@ +--- +title: EventsRecord +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventsRecord + +# Type Alias: EventsRecord + +> **EventsRecord**: `Record`\<`string`, `unknown`[]\> + +Defined in: [packages/common/src/events/EventEmittingComponent.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmittingComponent.ts#L3) diff --git a/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md b/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md new file mode 100644 index 0000000..5005f54 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md @@ -0,0 +1,19 @@ +--- +title: FilterNeverValues +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / FilterNeverValues + +# Type Alias: FilterNeverValues\ + +> **FilterNeverValues**\<`Type`\>: `{ [Key in keyof Type as Type[Key] extends never ? never : Key]: Type[Key] }` + +Defined in: [packages/common/src/config/ModuleContainer.ts:125](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L125) + +## Type Parameters + +• **Type** *extends* `Record`\<`string`, `unknown`\> diff --git a/src/pages/docs/reference/common/type-aliases/FlattenObject.md b/src/pages/docs/reference/common/type-aliases/FlattenObject.md new file mode 100644 index 0000000..9991c5c --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/FlattenObject.md @@ -0,0 +1,19 @@ +--- +title: FlattenObject +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / FlattenObject + +# Type Alias: FlattenObject\ + +> **FlattenObject**\<`Target`\>: [`UnionToIntersection`](UnionToIntersection.md)\<`Target`\[keyof `Target`\]\> + +Defined in: [packages/common/src/events/EventEmitterProxy.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L36) + +## Type Parameters + +• **Target** *extends* `Record`\<`string`, [`EventsRecord`](EventsRecord.md)\> diff --git a/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md b/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md new file mode 100644 index 0000000..a0f4e31 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md @@ -0,0 +1,19 @@ +--- +title: FlattenedContainerEvents +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / FlattenedContainerEvents + +# Type Alias: FlattenedContainerEvents\ + +> **FlattenedContainerEvents**\<`Modules`\>: [`FlattenObject`](FlattenObject.md)\<[`ContainerEvents`](ContainerEvents.md)\<`Modules`\>\> + +Defined in: [packages/common/src/events/EventEmitterProxy.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L39) + +## Type Parameters + +• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/InferDependencies.md b/src/pages/docs/reference/common/type-aliases/InferDependencies.md new file mode 100644 index 0000000..c7e851c --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/InferDependencies.md @@ -0,0 +1,19 @@ +--- +title: InferDependencies +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / InferDependencies + +# Type Alias: InferDependencies\ + +> **InferDependencies**\<`Class`\>: `Class` *extends* [`DependencyFactory`](../interfaces/DependencyFactory.md) ? [`MapDependencyRecordToTypes`](MapDependencyRecordToTypes.md)\<`ReturnType`\<`Class`\[`"dependencies"`\]\>\> : `never` + +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L54) + +## Type Parameters + +• **Class** *extends* [`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md) diff --git a/src/pages/docs/reference/common/type-aliases/InferProofBase.md b/src/pages/docs/reference/common/type-aliases/InferProofBase.md new file mode 100644 index 0000000..4e9926d --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/InferProofBase.md @@ -0,0 +1,19 @@ +--- +title: InferProofBase +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / InferProofBase + +# Type Alias: InferProofBase\ + +> **InferProofBase**\<`ProofType`\>: `ProofType` *extends* `Proof`\ ? `ProofBase`\<`PI`, `PO`\> : `ProofType` *extends* `DynamicProof`\ ? `ProofBase`\<`PI`, `PO`\> : `undefined` + +Defined in: [packages/common/src/types.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L51) + +## Type Parameters + +• **ProofType** *extends* `Proof`\<`any`, `any`\> \| `DynamicProof`\<`any`, `any`\> diff --git a/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md b/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md new file mode 100644 index 0000000..ac0a8fa --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md @@ -0,0 +1,19 @@ +--- +title: MapDependencyRecordToTypes +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MapDependencyRecordToTypes + +# Type Alias: MapDependencyRecordToTypes\ + +> **MapDependencyRecordToTypes**\<`Record`\>: `{ [Key in keyof Record as CapitalizeAny]: TypedClass> }` + +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L48) + +## Type Parameters + +• **Record** *extends* [`DependencyRecord`](DependencyRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/MergeObjects.md b/src/pages/docs/reference/common/type-aliases/MergeObjects.md new file mode 100644 index 0000000..4656568 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/MergeObjects.md @@ -0,0 +1,19 @@ +--- +title: MergeObjects +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MergeObjects + +# Type Alias: MergeObjects\ + +> **MergeObjects**\<`Input`\>: [`UnionToIntersection`](UnionToIntersection.md)\<`Input`\[keyof `Input`\]\> + +Defined in: [packages/common/src/types.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L30) + +## Type Parameters + +• **Input** *extends* `Record`\<`string`, `unknown`\> diff --git a/src/pages/docs/reference/common/type-aliases/ModuleEvents.md b/src/pages/docs/reference/common/type-aliases/ModuleEvents.md new file mode 100644 index 0000000..509b063 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/ModuleEvents.md @@ -0,0 +1,19 @@ +--- +title: ModuleEvents +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModuleEvents + +# Type Alias: ModuleEvents\ + +> **ModuleEvents**\<`ModuleType`\>: `InstanceType`\<`ModuleType`\> *extends* [`EventEmittingComponent`](../interfaces/EventEmittingComponent.md)\ ? `Events` : `InstanceType`\<`ModuleType`\> *extends* [`ModuleContainer`](../classes/ModuleContainer.md)\ ? [`CastToEventsRecord`](CastToEventsRecord.md)\<[`ContainerEvents`](ContainerEvents.md)\<`NestedModules`\>\> : [`EventsRecord`](EventsRecord.md) + +Defined in: [packages/common/src/events/EventEmitterProxy.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L19) + +## Type Parameters + +• **ModuleType** *extends* [`BaseModuleType`](BaseModuleType.md) diff --git a/src/pages/docs/reference/common/type-aliases/ModulesConfig.md b/src/pages/docs/reference/common/type-aliases/ModulesConfig.md new file mode 100644 index 0000000..d91582b --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/ModulesConfig.md @@ -0,0 +1,19 @@ +--- +title: ModulesConfig +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModulesConfig + +# Type Alias: ModulesConfig\ + +> **ModulesConfig**\<`Modules`\>: \{ \[ConfigKey in StringKeyOf\\]: InstanceType\ extends Configurable\ ? Config extends NoConfig ? Config \| undefined : Config : never \} + +Defined in: [packages/common/src/config/ModuleContainer.ts:89](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L89) + +## Type Parameters + +• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/NoConfig.md b/src/pages/docs/reference/common/type-aliases/NoConfig.md new file mode 100644 index 0000000..db54b32 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/NoConfig.md @@ -0,0 +1,15 @@ +--- +title: NoConfig +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / NoConfig + +# Type Alias: NoConfig + +> **NoConfig**: `Record`\<`never`, `never`\> + +Defined in: [packages/common/src/config/ConfigurableModule.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L22) diff --git a/src/pages/docs/reference/common/type-aliases/NonMethods.md b/src/pages/docs/reference/common/type-aliases/NonMethods.md new file mode 100644 index 0000000..e77a3f0 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/NonMethods.md @@ -0,0 +1,19 @@ +--- +title: NonMethods +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / NonMethods + +# Type Alias: NonMethods\ + +> **NonMethods**\<`Type`\>: `Pick`\<`Type`, `NonMethodKeys`\<`Type`\>\> + +Defined in: [packages/common/src/utils.ts:172](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L172) + +## Type Parameters + +• **Type** diff --git a/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md b/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md new file mode 100644 index 0000000..9aae968 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md @@ -0,0 +1,15 @@ +--- +title: O1JSPrimitive +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / O1JSPrimitive + +# Type Alias: O1JSPrimitive + +> **O1JSPrimitive**: `object` \| `string` \| `boolean` \| `number` + +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L8) diff --git a/src/pages/docs/reference/common/type-aliases/OmitKeys.md b/src/pages/docs/reference/common/type-aliases/OmitKeys.md new file mode 100644 index 0000000..c838b9d --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/OmitKeys.md @@ -0,0 +1,21 @@ +--- +title: OmitKeys +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / OmitKeys + +# Type Alias: OmitKeys\ + +> **OmitKeys**\<`Record`, `Keys`\>: `{ [Key in keyof Record as Key extends Keys ? never : Key]: Record[Key] }` + +Defined in: [packages/common/src/types.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L33) + +## Type Parameters + +• **Record** + +• **Keys** diff --git a/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md b/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md new file mode 100644 index 0000000..0b5b6d9 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md @@ -0,0 +1,21 @@ +--- +title: OverwriteObjectType +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / OverwriteObjectType + +# Type Alias: OverwriteObjectType\ + +> **OverwriteObjectType**\<`Base`, `New`\>: `{ [Key in keyof Base]: Key extends keyof New ? New[Key] : Base[Key] }` & `New` + +Defined in: [packages/common/src/types.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L47) + +## Type Parameters + +• **Base** + +• **New** diff --git a/src/pages/docs/reference/common/type-aliases/Preset.md b/src/pages/docs/reference/common/type-aliases/Preset.md new file mode 100644 index 0000000..1f87a1e --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/Preset.md @@ -0,0 +1,19 @@ +--- +title: Preset +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / Preset + +# Type Alias: Preset\ + +> **Preset**\<`Config`\>: `Config` \| (...`args`) => `Config` + +Defined in: [packages/common/src/config/ConfigurableModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L14) + +## Type Parameters + +• **Config** diff --git a/src/pages/docs/reference/common/type-aliases/Presets.md b/src/pages/docs/reference/common/type-aliases/Presets.md new file mode 100644 index 0000000..360af15 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/Presets.md @@ -0,0 +1,19 @@ +--- +title: Presets +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / Presets + +# Type Alias: Presets\ + +> **Presets**\<`Config`\>: `Record`\<`string`, [`Preset`](Preset.md)\<`Config`\>\> + +Defined in: [packages/common/src/config/ConfigurableModule.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L15) + +## Type Parameters + +• **Config** diff --git a/src/pages/docs/reference/common/type-aliases/ProofTypes.md b/src/pages/docs/reference/common/type-aliases/ProofTypes.md new file mode 100644 index 0000000..465214f --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/ProofTypes.md @@ -0,0 +1,15 @@ +--- +title: ProofTypes +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ProofTypes + +# Type Alias: ProofTypes + +> **ProofTypes**: *typeof* `Proof` \| *typeof* `DynamicProof` + +Defined in: [packages/common/src/utils.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L122) diff --git a/src/pages/docs/reference/common/type-aliases/RecursivePartial.md b/src/pages/docs/reference/common/type-aliases/RecursivePartial.md new file mode 100644 index 0000000..2cc6551 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/RecursivePartial.md @@ -0,0 +1,26 @@ +--- +title: RecursivePartial +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / RecursivePartial + +# Type Alias: RecursivePartial\ + +> **RecursivePartial**\<`T`\>: `{ [Key in keyof T]?: Partial }` + +Defined in: [packages/common/src/config/ModuleContainer.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L108) + +This type make any config partial (i.e. optional) up to the first level +So { Module: { a: { b: string } } } +will become +{ Module?: { a?: { b: string } } } +Note that b does not become optional, as we don't want nested objects to +become unreasonably partialized (for example Field). + +## Type Parameters + +• **T** diff --git a/src/pages/docs/reference/common/type-aliases/ResolvableModules.md b/src/pages/docs/reference/common/type-aliases/ResolvableModules.md new file mode 100644 index 0000000..b2c643f --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/ResolvableModules.md @@ -0,0 +1,19 @@ +--- +title: ResolvableModules +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ResolvableModules + +# Type Alias: ResolvableModules\ + +> **ResolvableModules**\<`Modules`\>: [`MergeObjects`](MergeObjects.md)\<[`DependenciesFromModules`](DependenciesFromModules.md)\<`Modules`\>\> & `Modules` + +Defined in: [packages/common/src/config/ModuleContainer.ts:136](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L136) + +## Type Parameters + +• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/StringKeyOf.md b/src/pages/docs/reference/common/type-aliases/StringKeyOf.md new file mode 100644 index 0000000..ea59082 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/StringKeyOf.md @@ -0,0 +1,22 @@ +--- +title: StringKeyOf +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / StringKeyOf + +# Type Alias: StringKeyOf\ + +> **StringKeyOf**\<`Target`\>: `Extract`\ & `string` + +Defined in: [packages/common/src/types.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L12) + +Using simple `keyof Target` would result into the key +being `string | number | symbol`, but we want just a `string` + +## Type Parameters + +• **Target** *extends* `object` diff --git a/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md b/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md new file mode 100644 index 0000000..ae866f6 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md @@ -0,0 +1,19 @@ +--- +title: TypeFromDependencyDeclaration +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / TypeFromDependencyDeclaration + +# Type Alias: TypeFromDependencyDeclaration\ + +> **TypeFromDependencyDeclaration**\<`Declaration`\>: `Declaration` *extends* [`DependencyDeclaration`](DependencyDeclaration.md)\ ? `Dependency` : `never` + +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L38) + +## Type Parameters + +• **Declaration** *extends* [`DependencyDeclaration`](DependencyDeclaration.md)\<`unknown`\> diff --git a/src/pages/docs/reference/common/type-aliases/TypedClass.md b/src/pages/docs/reference/common/type-aliases/TypedClass.md new file mode 100644 index 0000000..afcf49d --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/TypedClass.md @@ -0,0 +1,29 @@ +--- +title: TypedClass +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / TypedClass + +# Type Alias: TypedClass()\ + +> **TypedClass**\<`Class`\>: (...`args`) => `Class` + +Defined in: [packages/common/src/types.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L4) + +## Type Parameters + +• **Class** + +## Parameters + +### args + +...`any`[] + +## Returns + +`Class` diff --git a/src/pages/docs/reference/common/type-aliases/UnTypedClass.md b/src/pages/docs/reference/common/type-aliases/UnTypedClass.md new file mode 100644 index 0000000..833d3f2 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/UnTypedClass.md @@ -0,0 +1,25 @@ +--- +title: UnTypedClass +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / UnTypedClass + +# Type Alias: UnTypedClass() + +> **UnTypedClass**: (...`args`) => `unknown` + +Defined in: [packages/common/src/types.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L6) + +## Parameters + +### args + +...`any`[] + +## Returns + +`unknown` diff --git a/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md b/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md new file mode 100644 index 0000000..824e107 --- /dev/null +++ b/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md @@ -0,0 +1,21 @@ +--- +title: UnionToIntersection +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / UnionToIntersection + +# Type Alias: UnionToIntersection\ + +> **UnionToIntersection**\<`Union`\>: `Union` *extends* `any` ? (`x`) => `void` : `never` *extends* (`x`) => `void` ? `Intersection` : `never` + +Defined in: [packages/common/src/types.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L24) + +Transforms X | Y => X & Y + +## Type Parameters + +• **Union** diff --git a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md new file mode 100644 index 0000000..f7036d4 --- /dev/null +++ b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md @@ -0,0 +1,15 @@ +--- +title: EMPTY_PUBLICKEY +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EMPTY\_PUBLICKEY + +# Variable: EMPTY\_PUBLICKEY + +> `const` **EMPTY\_PUBLICKEY**: `PublicKey` + +Defined in: [packages/common/src/types.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L42) diff --git a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md new file mode 100644 index 0000000..d5991a6 --- /dev/null +++ b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md @@ -0,0 +1,15 @@ +--- +title: EMPTY_PUBLICKEY_X +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EMPTY\_PUBLICKEY\_X + +# Variable: EMPTY\_PUBLICKEY\_X + +> `const` **EMPTY\_PUBLICKEY\_X**: `Field` + +Defined in: [packages/common/src/types.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L41) diff --git a/src/pages/docs/reference/common/variables/MAX_FIELD.md b/src/pages/docs/reference/common/variables/MAX_FIELD.md new file mode 100644 index 0000000..65571ae --- /dev/null +++ b/src/pages/docs/reference/common/variables/MAX_FIELD.md @@ -0,0 +1,15 @@ +--- +title: MAX_FIELD +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MAX\_FIELD + +# Variable: MAX\_FIELD + +> `const` **MAX\_FIELD**: `Field` + +Defined in: [packages/common/src/utils.ts:174](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L174) diff --git a/src/pages/docs/reference/common/variables/MOCK_PROOF.md b/src/pages/docs/reference/common/variables/MOCK_PROOF.md new file mode 100644 index 0000000..acc0c92 --- /dev/null +++ b/src/pages/docs/reference/common/variables/MOCK_PROOF.md @@ -0,0 +1,15 @@ +--- +title: MOCK_PROOF +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MOCK\_PROOF + +# Variable: MOCK\_PROOF + +> `const` **MOCK\_PROOF**: `"mock-proof"` = `"mock-proof"` + +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L17) diff --git a/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md b/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md new file mode 100644 index 0000000..66ec3cb --- /dev/null +++ b/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md @@ -0,0 +1,15 @@ +--- +title: MOCK_VERIFICATION_KEY +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MOCK\_VERIFICATION\_KEY + +# Variable: MOCK\_VERIFICATION\_KEY + +> `const` **MOCK\_VERIFICATION\_KEY**: `VerificationKey` + +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L82) diff --git a/src/pages/docs/reference/common/variables/ModuleContainerErrors.md b/src/pages/docs/reference/common/variables/ModuleContainerErrors.md new file mode 100644 index 0000000..267a3ff --- /dev/null +++ b/src/pages/docs/reference/common/variables/ModuleContainerErrors.md @@ -0,0 +1,121 @@ +--- +title: ModuleContainerErrors +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModuleContainerErrors + +# Variable: ModuleContainerErrors + +> `const` **ModuleContainerErrors**: `object` = `errors` + +Defined in: [packages/common/src/config/ModuleContainer.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L71) + +## Type declaration + +### configNotSetInContainer() + +> **configNotSetInContainer**: (`moduleName`) => `Error` + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`Error` + +### dependencyContainerNotSet() + +> **dependencyContainerNotSet**: (`className`) => `Error` + +#### Parameters + +##### className + +`string` + +#### Returns + +`Error` + +### nonModuleDependency() + +> **nonModuleDependency**: (`runtimeModuleName`) => `Error` + +#### Parameters + +##### runtimeModuleName + +`string` + +#### Returns + +`Error` + +### onlyValidModuleNames() + +> **onlyValidModuleNames**: (`moduleName`) => `Error` + +#### Parameters + +##### moduleName + +#### Returns + +`Error` + +### unableToDecorateModule() + +> **unableToDecorateModule**: (`moduleName`) => `Error` + +#### Parameters + +##### moduleName + +`InjectionToken`\<`unknown`\> + +#### Returns + +`Error` + +### unknownDependency() + +> **unknownDependency**: (`runtimeModuleName`, `name`) => `Error` + +#### Parameters + +##### runtimeModuleName + +`string` + +##### name + +`string` + +#### Returns + +`Error` + +### validModuleInstance() + +> **validModuleInstance**: (`moduleName`, `moduleTypeName`) => `Error` + +#### Parameters + +##### moduleName + +`string` + +##### moduleTypeName + +`string` + +#### Returns + +`Error` diff --git a/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md b/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md new file mode 100644 index 0000000..b0e5e05 --- /dev/null +++ b/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md @@ -0,0 +1,15 @@ +--- +title: injectAliasMetadataKey +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / injectAliasMetadataKey + +# Variable: injectAliasMetadataKey + +> `const` **injectAliasMetadataKey**: `"protokit-inject-alias"` = `"protokit-inject-alias"` + +Defined in: [packages/common/src/config/injectAlias.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/injectAlias.ts#L3) diff --git a/src/pages/docs/reference/common/variables/log.md b/src/pages/docs/reference/common/variables/log.md new file mode 100644 index 0000000..4f85542 --- /dev/null +++ b/src/pages/docs/reference/common/variables/log.md @@ -0,0 +1,355 @@ +--- +title: log +--- + +[**@proto-kit/common**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / log + +# Variable: log + +> `const` **log**: `object` + +Defined in: [packages/common/src/log.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/log.ts#L53) + +## Type declaration + +### debug() + +> **debug**: (...`args`) => `void` + +#### Parameters + +##### args + +...`unknown`[] + +#### Returns + +`void` + +### error() + +> **error**: (...`args`) => `void` + +#### Parameters + +##### args + +...`unknown`[] + +#### Returns + +`void` + +### getLevel() + +> **getLevel**: () => `0` \| `1` \| `2` \| `3` \| `4` \| `5` + +#### Returns + +`0` \| `1` \| `2` \| `3` \| `4` \| `5` + +### info() + +> **info**: (...`args`) => `void` + +#### Parameters + +##### args + +...`unknown`[] + +#### Returns + +`void` + +### provable + +> **provable**: `object` + +#### provable.debug() + +> **provable.debug**: (...`args`) => `void` + +##### Parameters + +###### args + +...`unknown`[] + +##### Returns + +`void` + +#### provable.error() + +> **provable.error**: (...`args`) => `void` + +##### Parameters + +###### args + +...`unknown`[] + +##### Returns + +`void` + +#### provable.info() + +> **provable.info**: (...`args`) => `void` + +##### Parameters + +###### args + +...`unknown`[] + +##### Returns + +`void` + +#### provable.trace() + +> **provable.trace**: (...`args`) => `void` + +##### Parameters + +###### args + +...`unknown`[] + +##### Returns + +`void` + +#### provable.warn() + +> **provable.warn**: (...`args`) => `void` + +##### Parameters + +###### args + +...`unknown`[] + +##### Returns + +`void` + +### setLevel() + +> **setLevel**: (`level`) => `void` + +#### Parameters + +##### level + +`LogLevelDesc` + +#### Returns + +`void` + +### time() + +> **time**: (`label`) => `void` + +#### Parameters + +##### label + +`string` = `"time"` + +#### Returns + +`void` + +### timeEnd + +> **timeEnd**: `object` + +#### timeEnd.debug() + +> **timeEnd.debug**: (`label`?) => `void` + +##### Parameters + +###### label? + +`string` + +##### Returns + +`void` + +#### timeEnd.error() + +> **timeEnd.error**: (`label`?) => `void` + +##### Parameters + +###### label? + +`string` + +##### Returns + +`void` + +#### timeEnd.info() + +> **timeEnd.info**: (`label`?) => `void` + +##### Parameters + +###### label? + +`string` + +##### Returns + +`void` + +#### timeEnd.trace() + +> **timeEnd.trace**: (`label`?) => `void` + +##### Parameters + +###### label? + +`string` + +##### Returns + +`void` + +#### timeEnd.warn() + +> **timeEnd.warn**: (`label`?) => `void` + +##### Parameters + +###### label? + +`string` + +##### Returns + +`void` + +### timeLog + +> **timeLog**: `object` + +#### timeLog.debug() + +> **timeLog.debug**: (`label`?) => `void` + +##### Parameters + +###### label? + +`string` + +##### Returns + +`void` + +#### timeLog.error() + +> **timeLog.error**: (`label`?) => `void` + +##### Parameters + +###### label? + +`string` + +##### Returns + +`void` + +#### timeLog.info() + +> **timeLog.info**: (`label`?) => `void` + +##### Parameters + +###### label? + +`string` + +##### Returns + +`void` + +#### timeLog.trace() + +> **timeLog.trace**: (`label`?) => `void` + +##### Parameters + +###### label? + +`string` + +##### Returns + +`void` + +#### timeLog.warn() + +> **timeLog.warn**: (`label`?) => `void` + +##### Parameters + +###### label? + +`string` + +##### Returns + +`void` + +### trace() + +> **trace**: (...`args`) => `void` + +#### Parameters + +##### args + +...`unknown`[] + +#### Returns + +`void` + +### warn() + +> **warn**: (...`args`) => `void` + +#### Parameters + +##### args + +...`unknown`[] + +#### Returns + +`void` + +### levels + +#### Get Signature + +> **get** **levels**(): `LogLevel` + +##### Returns + +`LogLevel` diff --git a/src/pages/docs/reference/deployment/README.md b/src/pages/docs/reference/deployment/README.md new file mode 100644 index 0000000..1802e83 --- /dev/null +++ b/src/pages/docs/reference/deployment/README.md @@ -0,0 +1,48 @@ +--- +title: "@proto-kit/deployment" +--- + +**@proto-kit/deployment** + +*** + +[Documentation](../../README.md) / @proto-kit/deployment + +### General + +This package provides a suite of Dockerfiles and compose files to start protokit +in a variety of settings and modes. + +Everything is controlled via `Environments`. +These are basically bundles of Appchains that are configured for different roles. +Every environment has a name and consists of multiple `Configurations`. + +The base image built from `base/Dockerfile` executes any js file and passes in the environment and configuration name as arguments. + +Configuration happens via a `.env` file that specifies a few things: +Among those are the profiles that should executed, the DB connection string, and the entrypoints for the different images + +##### Currently available services: + +- Persistance with + - Postgres (profile: `db`) + - Redis (profiles: `db, worker`) +- Sequencer: `SEQUENCER_CONFIG` (profile: `simple-sequencer`) +- Worker: `WORKER_CONFIG` (profile: `worker`) + +- Development-base: Usage for locally built starter-kit, see starter-kit documentation + +### Usage + +A example of how to use it with a local framework repo can be found under the package `stack` +The configuration of that setup can be found under .env + +Executing it works via `docker-compose up --build` run in the `stack` package. + +### Extentending deployment compose files + +Option 1: Using include and specifying a exported `Environments` configuration + +Option 2: Using extend and override the `cmd` + +Be aware that including docker-compose files preserves their relationship in terms of relational paths, while extend does not (it behaves like copying the text into the parent file) diff --git a/src/pages/docs/reference/deployment/_meta.tsx b/src/pages/docs/reference/deployment/_meta.tsx new file mode 100644 index 0000000..9304eb2 --- /dev/null +++ b/src/pages/docs/reference/deployment/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/deployment/classes/BullQueue.md b/src/pages/docs/reference/deployment/classes/BullQueue.md new file mode 100644 index 0000000..9444b36 --- /dev/null +++ b/src/pages/docs/reference/deployment/classes/BullQueue.md @@ -0,0 +1,266 @@ +--- +title: BullQueue +--- + +[**@proto-kit/deployment**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/deployment](../README.md) / BullQueue + +# Class: BullQueue + +Defined in: [deployment/src/queue/BullQueue.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L29) + +TaskQueue implementation for BullMQ + +## Extends + +- [`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md)\<[`BullQueueConfig`](../interfaces/BullQueueConfig.md)\> + +## Implements + +- [`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) +- [`Closeable`](../../sequencer/interfaces/Closeable.md) + +## Constructors + +### new BullQueue() + +> **new BullQueue**(): [`BullQueue`](BullQueue.md) + +#### Returns + +[`BullQueue`](BullQueue.md) + +#### Inherited from + +[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`constructor`](../../sequencer/classes/AbstractTaskQueue.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`BullQueueConfig`](../interfaces/BullQueueConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`currentConfig`](../../sequencer/classes/AbstractTaskQueue.md#currentconfig) + +*** + +### queues + +> `protected` **queues**: `Record`\<`string`, [`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md)\> + +Defined in: sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:4 + +#### Inherited from + +[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`queues`](../../sequencer/classes/AbstractTaskQueue.md#queues) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> + +Defined in: sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 + +#### Inherited from + +[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`presets`](../../sequencer/classes/AbstractTaskQueue.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`config`](../../sequencer/classes/AbstractTaskQueue.md#config) + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [deployment/src/queue/BullQueue.ts:107](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L107) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Closeable`](../../sequencer/interfaces/Closeable.md).[`close`](../../sequencer/interfaces/Closeable.md#close) + +*** + +### closeQueues() + +> `protected` **closeQueues**(): `Promise`\<`void`\> + +Defined in: sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:6 + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`closeQueues`](../../sequencer/classes/AbstractTaskQueue.md#closequeues) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`create`](../../sequencer/classes/AbstractTaskQueue.md#create) + +*** + +### createOrGetQueue() + +> `protected` **createOrGetQueue**(`name`, `creator`): [`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md) + +Defined in: sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:5 + +#### Parameters + +##### name + +`string` + +##### creator + +(`name`) => [`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md) + +#### Returns + +[`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md) + +#### Inherited from + +[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`createOrGetQueue`](../../sequencer/classes/AbstractTaskQueue.md#createorgetqueue) + +*** + +### createWorker() + +> **createWorker**(`name`, `executor`, `options`?): [`Closeable`](../../sequencer/interfaces/Closeable.md) + +Defined in: [deployment/src/queue/BullQueue.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L35) + +#### Parameters + +##### name + +`string` + +##### executor + +(`data`) => `Promise`\<[`TaskPayload`](../../sequencer/interfaces/TaskPayload.md)\> + +##### options? + +###### concurrency + +`number` + +#### Returns + +[`Closeable`](../../sequencer/interfaces/Closeable.md) + +#### Implementation of + +[`TaskQueue`](../../sequencer/interfaces/TaskQueue.md).[`createWorker`](../../sequencer/interfaces/TaskQueue.md#createworker) + +*** + +### getQueue() + +> **getQueue**(`queueName`): `Promise`\<[`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md)\> + +Defined in: [deployment/src/queue/BullQueue.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L88) + +#### Parameters + +##### queueName + +`string` + +#### Returns + +`Promise`\<[`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md)\> + +#### Implementation of + +[`TaskQueue`](../../sequencer/interfaces/TaskQueue.md).[`getQueue`](../../sequencer/interfaces/TaskQueue.md#getqueue) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [deployment/src/queue/BullQueue.ts:103](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L103) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`start`](../../sequencer/classes/AbstractTaskQueue.md#start) diff --git a/src/pages/docs/reference/deployment/classes/Environment.md b/src/pages/docs/reference/deployment/classes/Environment.md new file mode 100644 index 0000000..97fff3b --- /dev/null +++ b/src/pages/docs/reference/deployment/classes/Environment.md @@ -0,0 +1,105 @@ +--- +title: Environment +--- + +[**@proto-kit/deployment**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/deployment](../README.md) / Environment + +# Class: Environment\ + +Defined in: [deployment/src/environment/Environment.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L12) + +## Type Parameters + +• **T** *extends* [`Startable`](../interfaces/Startable.md) + +## Constructors + +### new Environment() + +> **new Environment**\<`T`\>(`configurations`): [`Environment`](Environment.md)\<`T`\> + +Defined in: [deployment/src/environment/Environment.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L13) + +#### Parameters + +##### configurations + +[`StartableEnvironment`](../type-aliases/StartableEnvironment.md)\<`T`\> + +#### Returns + +[`Environment`](Environment.md)\<`T`\> + +## Methods + +### getConfiguration() + +> **getConfiguration**(`configurationName`): `T` + +Defined in: [deployment/src/environment/Environment.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L31) + +#### Parameters + +##### configurationName + +`string` + +#### Returns + +`T` + +*** + +### hasConfiguration() + +> **hasConfiguration**(`configurationName`): `configurationName is string` + +Defined in: [deployment/src/environment/Environment.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L17) + +#### Parameters + +##### configurationName + +`string` + +#### Returns + +`configurationName is string` + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [deployment/src/environment/Environment.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L42) + +#### Returns + +`Promise`\<`void`\> + +*** + +### from() + +> `static` **from**\<`T`\>(`configurations`): [`Environment`](Environment.md)\<`T`\> + +Defined in: [deployment/src/environment/Environment.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L36) + +#### Type Parameters + +• **T** *extends* [`Startable`](../interfaces/Startable.md) + +#### Parameters + +##### configurations + +[`StartableEnvironment`](../type-aliases/StartableEnvironment.md)\<`T`\> + +#### Returns + +[`Environment`](Environment.md)\<`T`\> diff --git a/src/pages/docs/reference/deployment/globals.md b/src/pages/docs/reference/deployment/globals.md new file mode 100644 index 0000000..6420a85 --- /dev/null +++ b/src/pages/docs/reference/deployment/globals.md @@ -0,0 +1,25 @@ +--- +title: "@proto-kit/deployment" +--- + +[**@proto-kit/deployment**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/deployment + +# @proto-kit/deployment + +## Classes + +- [BullQueue](classes/BullQueue.md) +- [Environment](classes/Environment.md) + +## Interfaces + +- [BullQueueConfig](interfaces/BullQueueConfig.md) +- [Startable](interfaces/Startable.md) + +## Type Aliases + +- [StartableEnvironment](type-aliases/StartableEnvironment.md) diff --git a/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md b/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md new file mode 100644 index 0000000..7d52f0a --- /dev/null +++ b/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md @@ -0,0 +1,49 @@ +--- +title: BullQueueConfig +--- + +[**@proto-kit/deployment**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/deployment](../README.md) / BullQueueConfig + +# Interface: BullQueueConfig + +Defined in: [deployment/src/queue/BullQueue.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L14) + +## Properties + +### redis + +> **redis**: `object` + +Defined in: [deployment/src/queue/BullQueue.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L15) + +#### db? + +> `optional` **db**: `number` + +#### host + +> **host**: `string` + +#### password? + +> `optional` **password**: `string` + +#### port + +> **port**: `number` + +#### username? + +> `optional` **username**: `string` + +*** + +### retryAttempts? + +> `optional` **retryAttempts**: `number` + +Defined in: [deployment/src/queue/BullQueue.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L22) diff --git a/src/pages/docs/reference/deployment/interfaces/Startable.md b/src/pages/docs/reference/deployment/interfaces/Startable.md new file mode 100644 index 0000000..8630d81 --- /dev/null +++ b/src/pages/docs/reference/deployment/interfaces/Startable.md @@ -0,0 +1,25 @@ +--- +title: Startable +--- + +[**@proto-kit/deployment**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/deployment](../README.md) / Startable + +# Interface: Startable + +Defined in: [deployment/src/environment/Environment.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L6) + +## Methods + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [deployment/src/environment/Environment.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L7) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md b/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md new file mode 100644 index 0000000..89d33de --- /dev/null +++ b/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md @@ -0,0 +1,19 @@ +--- +title: StartableEnvironment +--- + +[**@proto-kit/deployment**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/deployment](../README.md) / StartableEnvironment + +# Type Alias: StartableEnvironment\ + +> **StartableEnvironment**\<`T`\>: `Record`\<`string`, `T`\> + +Defined in: [deployment/src/environment/Environment.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L10) + +## Type Parameters + +• **T** diff --git a/src/pages/docs/reference/indexer/README.md b/src/pages/docs/reference/indexer/README.md new file mode 100644 index 0000000..a78f91d --- /dev/null +++ b/src/pages/docs/reference/indexer/README.md @@ -0,0 +1,34 @@ +--- +title: "@proto-kit/indexer" +--- + +**@proto-kit/indexer** + +*** + +[Documentation](../../README.md) / @proto-kit/indexer + +# @proto-kit/indexer + +## Classes + +- [GeneratedResolverFactoryGraphqlModule](classes/GeneratedResolverFactoryGraphqlModule.md) +- [IndexBlockTask](classes/IndexBlockTask.md) +- [IndexBlockTaskParametersSerializer](classes/IndexBlockTaskParametersSerializer.md) +- [Indexer](classes/Indexer.md) +- [IndexerModule](classes/IndexerModule.md) +- [IndexerNotifier](classes/IndexerNotifier.md) + +## Interfaces + +- [IndexBlockTaskParameters](interfaces/IndexBlockTaskParameters.md) + +## Type Aliases + +- [IndexerModulesRecord](type-aliases/IndexerModulesRecord.md) +- [NotifierMandatorySequencerModules](type-aliases/NotifierMandatorySequencerModules.md) + +## Functions + +- [cleanResolvers](functions/cleanResolvers.md) +- [ValidateTakeArg](functions/ValidateTakeArg.md) diff --git a/src/pages/docs/reference/indexer/_meta.tsx b/src/pages/docs/reference/indexer/_meta.tsx new file mode 100644 index 0000000..a31554d --- /dev/null +++ b/src/pages/docs/reference/indexer/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md b/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md new file mode 100644 index 0000000..030fb9f --- /dev/null +++ b/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md @@ -0,0 +1,148 @@ +--- +title: GeneratedResolverFactoryGraphqlModule +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / GeneratedResolverFactoryGraphqlModule + +# Class: GeneratedResolverFactoryGraphqlModule + +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L83) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md) + +## Constructors + +### new GeneratedResolverFactoryGraphqlModule() + +> **new GeneratedResolverFactoryGraphqlModule**(`graphqlServer`): [`GeneratedResolverFactoryGraphqlModule`](GeneratedResolverFactoryGraphqlModule.md) + +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L84) + +#### Parameters + +##### graphqlServer + +[`GraphqlServer`](../../api/classes/GraphqlServer.md) + +#### Returns + +[`GeneratedResolverFactoryGraphqlModule`](GeneratedResolverFactoryGraphqlModule.md) + +#### Overrides + +[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`constructor`](../../api/classes/ResolverFactoryGraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`currentConfig`](../../api/classes/ResolverFactoryGraphqlModule.md#currentconfig) + +*** + +### graphqlServer + +> **graphqlServer**: [`GraphqlServer`](../../api/classes/GraphqlServer.md) + +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L85) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`config`](../../api/classes/ResolverFactoryGraphqlModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`create`](../../api/classes/ResolverFactoryGraphqlModule.md#create) + +*** + +### initializePrismaClient() + +> **initializePrismaClient**(): `Promise`\<`PrismaClient`\<`never`\>\> + +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:90](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L90) + +#### Returns + +`Promise`\<`PrismaClient`\<`never`\>\> + +*** + +### resolvers() + +> **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> + +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:101](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L101) + +#### Returns + +`Promise`\<`NonEmptyArray`\<`Function`\>\> + +#### Overrides + +[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`resolvers`](../../api/classes/ResolverFactoryGraphqlModule.md#resolvers) diff --git a/src/pages/docs/reference/indexer/classes/IndexBlockTask.md b/src/pages/docs/reference/indexer/classes/IndexBlockTask.md new file mode 100644 index 0000000..2131636 --- /dev/null +++ b/src/pages/docs/reference/indexer/classes/IndexBlockTask.md @@ -0,0 +1,218 @@ +--- +title: IndexBlockTask +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexBlockTask + +# Class: IndexBlockTask + +Defined in: [indexer/src/tasks/IndexBlockTask.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L16) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md) + +## Implements + +- [`Task`](../../sequencer/interfaces/Task.md)\<[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md), `void`\> + +## Constructors + +### new IndexBlockTask() + +> **new IndexBlockTask**(`taskSerializer`, `blockStorage`): [`IndexBlockTask`](IndexBlockTask.md) + +Defined in: [indexer/src/tasks/IndexBlockTask.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L22) + +#### Parameters + +##### taskSerializer + +[`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) + +##### blockStorage + +[`BlockQueue`](../../sequencer/interfaces/BlockQueue.md) + +#### Returns + +[`IndexBlockTask`](IndexBlockTask.md) + +#### Overrides + +[`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md).[`constructor`](../../sequencer/classes/TaskWorkerModule.md#constructors) + +## Properties + +### blockStorage + +> **blockStorage**: [`BlockQueue`](../../sequencer/interfaces/BlockQueue.md) + +Defined in: [indexer/src/tasks/IndexBlockTask.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L25) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md).[`currentConfig`](../../sequencer/classes/TaskWorkerModule.md#currentconfig) + +*** + +### name + +> **name**: `string` = `"index-block"` + +Defined in: [indexer/src/tasks/IndexBlockTask.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L20) + +#### Implementation of + +[`Task`](../../sequencer/interfaces/Task.md).[`name`](../../sequencer/interfaces/Task.md#name) + +*** + +### taskSerializer + +> **taskSerializer**: [`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) + +Defined in: [indexer/src/tasks/IndexBlockTask.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L23) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md).[`config`](../../sequencer/classes/TaskWorkerModule.md#config) + +## Methods + +### compute() + +> **compute**(`input`): `Promise`\<`void`\> + +Defined in: [indexer/src/tasks/IndexBlockTask.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L33) + +#### Parameters + +##### input + +[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Task`](../../sequencer/interfaces/Task.md).[`compute`](../../sequencer/interfaces/Task.md#compute) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md).[`create`](../../sequencer/classes/TaskWorkerModule.md#create) + +*** + +### inputSerializer() + +> **inputSerializer**(): [`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md)\> + +Defined in: [indexer/src/tasks/IndexBlockTask.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L45) + +#### Returns + +[`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md)\> + +#### Implementation of + +[`Task`](../../sequencer/interfaces/Task.md).[`inputSerializer`](../../sequencer/interfaces/Task.md#inputserializer) + +*** + +### prepare() + +> **prepare**(): `Promise`\<`void`\> + +Defined in: [indexer/src/tasks/IndexBlockTask.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L31) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Task`](../../sequencer/interfaces/Task.md).[`prepare`](../../sequencer/interfaces/Task.md#prepare) + +*** + +### resultSerializer() + +> **resultSerializer**(): [`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<`void`\> + +Defined in: [indexer/src/tasks/IndexBlockTask.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L49) + +#### Returns + +[`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<`void`\> + +#### Implementation of + +[`Task`](../../sequencer/interfaces/Task.md).[`resultSerializer`](../../sequencer/interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md b/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md new file mode 100644 index 0000000..6abbe04 --- /dev/null +++ b/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md @@ -0,0 +1,99 @@ +--- +title: IndexBlockTaskParametersSerializer +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexBlockTaskParametersSerializer + +# Class: IndexBlockTaskParametersSerializer + +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L12) + +## Constructors + +### new IndexBlockTaskParametersSerializer() + +> **new IndexBlockTaskParametersSerializer**(`blockMapper`, `blockResultMapper`, `transactionResultMapper`): [`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) + +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L13) + +#### Parameters + +##### blockMapper + +[`BlockMapper`](../../persistance/classes/BlockMapper.md) + +##### blockResultMapper + +[`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) + +##### transactionResultMapper + +[`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) + +#### Returns + +[`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) + +## Properties + +### blockMapper + +> **blockMapper**: [`BlockMapper`](../../persistance/classes/BlockMapper.md) + +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L14) + +*** + +### blockResultMapper + +> **blockResultMapper**: [`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) + +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L15) + +*** + +### transactionResultMapper + +> **transactionResultMapper**: [`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) + +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L16) + +## Methods + +### fromJSON() + +> **fromJSON**(`json`): [`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md) + +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L29) + +#### Parameters + +##### json + +`string` + +#### Returns + +[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md) + +*** + +### toJSON() + +> **toJSON**(`parameters`): `string` + +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L19) + +#### Parameters + +##### parameters + +[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md) + +#### Returns + +`string` diff --git a/src/pages/docs/reference/indexer/classes/Indexer.md b/src/pages/docs/reference/indexer/classes/Indexer.md new file mode 100644 index 0000000..c975983 --- /dev/null +++ b/src/pages/docs/reference/indexer/classes/Indexer.md @@ -0,0 +1,632 @@ +--- +title: Indexer +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / Indexer + +# Class: Indexer\ + +Defined in: [indexer/src/Indexer.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/Indexer.ts#L15) + +Reusable module container facilitating registration, resolution +configuration, decoration and validation of modules + +## Extends + +- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Modules`\> + +## Type Parameters + +• **Modules** *extends* [`IndexerModulesRecord`](../type-aliases/IndexerModulesRecord.md) + +## Constructors + +### new Indexer() + +> **new Indexer**\<`Modules`\>(`definition`): [`Indexer`](Indexer.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:68 + +#### Parameters + +##### definition + +[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +#### Returns + +[`Indexer`](Indexer.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) + +*** + +### definition + +> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:60 + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) + +*** + +### taskQueue + +#### Get Signature + +> **get** **taskQueue**(): `InstanceType`\<`Modules`\[`"TaskQueue"`\]\> + +Defined in: [indexer/src/Indexer.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/Indexer.ts#L24) + +##### Returns + +`InstanceType`\<`Modules`\[`"TaskQueue"`\]\> + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` + +Defined in: common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:160 + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) + +*** + +### decorateModule() + +> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:134 + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +`InstanceType`\<`Modules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>\]\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>[] + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` + +Defined in: common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +`Modules` + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +`Modules` + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +Defined in: common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [indexer/src/Indexer.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/Indexer.ts#L28) + +#### Returns + +`Promise`\<`void`\> + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`Modules`\>(`definition`): [`Indexer`](Indexer.md)\<`Modules`\> + +Defined in: [indexer/src/Indexer.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/Indexer.ts#L18) + +#### Type Parameters + +• **Modules** *extends* [`IndexerModulesRecord`](../type-aliases/IndexerModulesRecord.md) + +#### Parameters + +##### definition + +[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +#### Returns + +[`Indexer`](Indexer.md)\<`Modules`\> diff --git a/src/pages/docs/reference/indexer/classes/IndexerModule.md b/src/pages/docs/reference/indexer/classes/IndexerModule.md new file mode 100644 index 0000000..207c352 --- /dev/null +++ b/src/pages/docs/reference/indexer/classes/IndexerModule.md @@ -0,0 +1,120 @@ +--- +title: IndexerModule +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexerModule + +# Class: `abstract` IndexerModule\ + +Defined in: [indexer/src/IndexerModule.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerModule.ts#L3) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> + +## Type Parameters + +• **Config** + +## Constructors + +### new IndexerModule() + +> **new IndexerModule**\<`Config`\>(): [`IndexerModule`](IndexerModule.md)\<`Config`\> + +#### Returns + +[`IndexerModule`](IndexerModule.md)\<`Config`\> + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) + +*** + +### start() + +> `abstract` **start**(): `Promise`\<`void`\> + +Defined in: [indexer/src/IndexerModule.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerModule.ts#L4) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/indexer/classes/IndexerNotifier.md b/src/pages/docs/reference/indexer/classes/IndexerNotifier.md new file mode 100644 index 0000000..eb57d2d --- /dev/null +++ b/src/pages/docs/reference/indexer/classes/IndexerNotifier.md @@ -0,0 +1,191 @@ +--- +title: IndexerNotifier +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexerNotifier + +# Class: IndexerNotifier + +Defined in: [indexer/src/IndexerNotifier.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L19) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`Record`\<`never`, `never`\>\> + +## Constructors + +### new IndexerNotifier() + +> **new IndexerNotifier**(`sequencer`, `taskQueue`, `indexBlockTask`): [`IndexerNotifier`](IndexerNotifier.md) + +Defined in: [indexer/src/IndexerNotifier.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L20) + +#### Parameters + +##### sequencer + +[`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`NotifierMandatorySequencerModules`](../type-aliases/NotifierMandatorySequencerModules.md)\> + +##### taskQueue + +[`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) + +##### indexBlockTask + +[`IndexBlockTask`](IndexBlockTask.md) + +#### Returns + +[`IndexerNotifier`](IndexerNotifier.md) + +#### Overrides + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`constructor`](../../sequencer/classes/SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Record`\<`never`, `never`\> + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) + +*** + +### indexBlockTask + +> **indexBlockTask**: [`IndexBlockTask`](IndexBlockTask.md) + +Defined in: [indexer/src/IndexerNotifier.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L25) + +*** + +### sequencer + +> **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`NotifierMandatorySequencerModules`](../type-aliases/NotifierMandatorySequencerModules.md)\> + +Defined in: [indexer/src/IndexerNotifier.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L22) + +*** + +### taskQueue + +> **taskQueue**: [`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) + +Defined in: [indexer/src/IndexerNotifier.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L24) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> + +Defined in: sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`presets`](../../sequencer/classes/SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) + +*** + +### propagateEventsAsTasks() + +> **propagateEventsAsTasks**(): `Promise`\<`void`\> + +Defined in: [indexer/src/IndexerNotifier.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L30) + +#### Returns + +`Promise`\<`void`\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [indexer/src/IndexerNotifier.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L51) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) diff --git a/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md b/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md new file mode 100644 index 0000000..733c356 --- /dev/null +++ b/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md @@ -0,0 +1,19 @@ +--- +title: ValidateTakeArg +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / ValidateTakeArg + +# Function: ValidateTakeArg() + +> **ValidateTakeArg**(): `MethodDecorator` + +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L68) + +## Returns + +`MethodDecorator` diff --git a/src/pages/docs/reference/indexer/functions/cleanResolvers.md b/src/pages/docs/reference/indexer/functions/cleanResolvers.md new file mode 100644 index 0000000..a0b83f7 --- /dev/null +++ b/src/pages/docs/reference/indexer/functions/cleanResolvers.md @@ -0,0 +1,25 @@ +--- +title: cleanResolvers +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / cleanResolvers + +# Function: cleanResolvers() + +> **cleanResolvers**(`resolvers`): `Function`[] + +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L47) + +## Parameters + +### resolvers + +`NonEmptyArray`\<`Function`\> + +## Returns + +`Function`[] diff --git a/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md b/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md new file mode 100644 index 0000000..7846e8f --- /dev/null +++ b/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md @@ -0,0 +1,41 @@ +--- +title: IndexBlockTaskParameters +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexBlockTaskParameters + +# Interface: IndexBlockTaskParameters + +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L9) + +## Extends + +- [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md) + +## Properties + +### block + +> **block**: [`Block`](../../sequencer/interfaces/Block.md) + +Defined in: sequencer/dist/storage/model/Block.d.ts:45 + +#### Inherited from + +[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md).[`block`](../../sequencer/interfaces/BlockWithResult.md#block) + +*** + +### result + +> **result**: [`BlockResult`](../../sequencer/interfaces/BlockResult.md) + +Defined in: sequencer/dist/storage/model/Block.d.ts:46 + +#### Inherited from + +[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md).[`result`](../../sequencer/interfaces/BlockWithResult.md#result) diff --git a/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md b/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md new file mode 100644 index 0000000..80b9e1a --- /dev/null +++ b/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md @@ -0,0 +1,15 @@ +--- +title: IndexerModulesRecord +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexerModulesRecord + +# Type Alias: IndexerModulesRecord + +> **IndexerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`IndexerModule`](../classes/IndexerModule.md)\<`unknown`\>\>\> + +Defined in: [indexer/src/Indexer.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/Indexer.ts#L11) diff --git a/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md b/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md new file mode 100644 index 0000000..eee0ab3 --- /dev/null +++ b/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md @@ -0,0 +1,21 @@ +--- +title: NotifierMandatorySequencerModules +--- + +[**@proto-kit/indexer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / NotifierMandatorySequencerModules + +# Type Alias: NotifierMandatorySequencerModules + +> **NotifierMandatorySequencerModules**: `object` + +Defined in: [indexer/src/IndexerNotifier.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L14) + +## Type declaration + +### BlockTrigger + +> **BlockTrigger**: *typeof* [`BlockTriggerBase`](../../sequencer/classes/BlockTriggerBase.md) diff --git a/src/pages/docs/reference/library/README.md b/src/pages/docs/reference/library/README.md new file mode 100644 index 0000000..71f49ce --- /dev/null +++ b/src/pages/docs/reference/library/README.md @@ -0,0 +1,60 @@ +--- +title: "@proto-kit/library" +--- + +**@proto-kit/library** + +*** + +[Documentation](../../README.md) / @proto-kit/library + +# @proto-kit/library + +## Classes + +- [Balance](classes/Balance.md) +- [Balances](classes/Balances.md) +- [BalancesKey](classes/BalancesKey.md) +- [FeeTree](classes/FeeTree.md) +- [InMemorySequencerModules](classes/InMemorySequencerModules.md) +- [MethodFeeConfigData](classes/MethodFeeConfigData.md) +- [RuntimeFeeAnalyzerService](classes/RuntimeFeeAnalyzerService.md) +- [SimpleSequencerModules](classes/SimpleSequencerModules.md) +- [TokenId](classes/TokenId.md) +- [TransactionFeeHook](classes/TransactionFeeHook.md) +- [UInt](classes/UInt.md) +- [UInt112](classes/UInt112.md) +- [UInt224](classes/UInt224.md) +- [UInt32](classes/UInt32.md) +- [UInt64](classes/UInt64.md) +- [VanillaProtocolModules](classes/VanillaProtocolModules.md) +- [VanillaRuntimeModules](classes/VanillaRuntimeModules.md) +- [WithdrawalEvent](classes/WithdrawalEvent.md) +- [WithdrawalKey](classes/WithdrawalKey.md) +- [Withdrawals](classes/Withdrawals.md) + +## Interfaces + +- [BalancesEvents](interfaces/BalancesEvents.md) +- [FeeIndexes](interfaces/FeeIndexes.md) +- [FeeTreeValues](interfaces/FeeTreeValues.md) +- [MethodFeeConfig](interfaces/MethodFeeConfig.md) +- [RuntimeFeeAnalyzerServiceConfig](interfaces/RuntimeFeeAnalyzerServiceConfig.md) +- [TransactionFeeHookConfig](interfaces/TransactionFeeHookConfig.md) + +## Type Aliases + +- [AdditionalSequencerModules](type-aliases/AdditionalSequencerModules.md) +- [InMemorySequencerModulesRecord](type-aliases/InMemorySequencerModulesRecord.md) +- [MinimalBalances](type-aliases/MinimalBalances.md) +- [MinimumAdditionalSequencerModules](type-aliases/MinimumAdditionalSequencerModules.md) +- [SimpleSequencerModulesRecord](type-aliases/SimpleSequencerModulesRecord.md) +- [SimpleSequencerWorkerModulesRecord](type-aliases/SimpleSequencerWorkerModulesRecord.md) +- [UIntConstructor](type-aliases/UIntConstructor.md) +- [VanillaProtocolModulesRecord](type-aliases/VanillaProtocolModulesRecord.md) +- [VanillaRuntimeModulesRecord](type-aliases/VanillaRuntimeModulesRecord.md) + +## Variables + +- [errors](variables/errors.md) +- [treeFeeHeight](variables/treeFeeHeight.md) diff --git a/src/pages/docs/reference/library/_meta.tsx b/src/pages/docs/reference/library/_meta.tsx new file mode 100644 index 0000000..48a0c5e --- /dev/null +++ b/src/pages/docs/reference/library/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/library/classes/Balance.md b/src/pages/docs/reference/library/classes/Balance.md new file mode 100644 index 0000000..bc59df2 --- /dev/null +++ b/src/pages/docs/reference/library/classes/Balance.md @@ -0,0 +1,1125 @@ +--- +title: Balance +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / Balance + +# Class: Balance + +Defined in: [packages/library/src/runtime/Balances.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L28) + +UInt is a base class for all soft-failing UInt* implementations. +It has to be overridden for every bitlength that should be available. + +For this, the developer has to create a subclass of UInt implementing the +static methods from interface UIntConstructor + +## Extends + +- [`UInt64`](UInt64.md) + +## Constructors + +### new Balance() + +> **new Balance**(`value`): [`Balance`](Balance.md) + +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) + +#### Parameters + +##### value + +###### value + +`Field` + +#### Returns + +[`Balance`](Balance.md) + +#### Inherited from + +[`UInt64`](UInt64.md).[`constructor`](UInt64.md#constructors) + +## Properties + +### value + +> **value**: `Field` = `Field` + +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) + +#### Inherited from + +[`UInt64`](UInt64.md).[`value`](UInt64.md#value-2) + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +[`UInt64`](UInt64.md).[`_isStruct`](UInt64.md#_isstruct) + +*** + +### assertionFunction() + +> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` + +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) + +#### Parameters + +##### bool + +`Bool` + +##### msg? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt64`](UInt64.md).[`assertionFunction`](UInt64.md#assertionfunction) + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt64`](UInt64.md).[`empty`](UInt64.md#empty) + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt64`](UInt64.md).[`fromFields`](UInt64.md#fromfields) + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### value + +`string` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt64`](UInt64.md).[`fromJSON`](UInt64.md#fromjson) + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +[`UInt64`](UInt64.md).[`fromValue`](UInt64.md#fromvalue) + +*** + +### Safe + +> `static` **Safe**: `object` + +Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L12) + +#### fromField() + +##### Parameters + +###### value + +`Field` + +##### Returns + +[`UInt64`](UInt64.md) + +#### Inherited from + +[`UInt64`](UInt64.md).[`Safe`](UInt64.md#safe) + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### value + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +[`UInt64`](UInt64.md).[`toAuxiliary`](UInt64.md#toauxiliary) + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### value + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +[`UInt64`](UInt64.md).[`toFields`](UInt64.md#tofields) + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +[`UInt64`](UInt64.md).[`toInput`](UInt64.md#toinput) + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `string` = `Field` + +#### Inherited from + +[`UInt64`](UInt64.md).[`toJSON`](UInt64.md#tojson) + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `bigint` = `Field` + +#### Inherited from + +[`UInt64`](UInt64.md).[`toValue`](UInt64.md#tovalue) + +*** + +### Unsafe + +> `static` **Unsafe**: `object` + +Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L6) + +#### fromField() + +##### Parameters + +###### value + +`Field` + +##### Returns + +[`UInt64`](UInt64.md) + +#### Inherited from + +[`UInt64`](UInt64.md).[`Unsafe`](UInt64.md#unsafe) + +## Accessors + +### max + +#### Get Signature + +> **get** `static` **max**(): [`UInt64`](UInt64.md) + +Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L35) + +##### Returns + +[`UInt64`](UInt64.md) + +#### Inherited from + +[`UInt64`](UInt64.md).[`max`](UInt64.md#max) + +*** + +### zero + +#### Get Signature + +> **get** `static` **zero**(): [`UInt64`](UInt64.md) + +Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L31) + +##### Returns + +[`UInt64`](UInt64.md) + +#### Inherited from + +[`UInt64`](UInt64.md).[`zero`](UInt64.md#zero) + +## Methods + +### add() + +> **add**(`y`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) + +Addition with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt64`](UInt64.md).[`add`](UInt64.md#add) + +*** + +### assertEquals() + +> **assertEquals**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) + +Asserts that a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt64`](UInt64.md).[`assertEquals`](UInt64.md#assertequals) + +*** + +### assertGreaterThan() + +> **assertGreaterThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) + +Asserts that a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt64`](UInt64.md).[`assertGreaterThan`](UInt64.md#assertgreaterthan) + +*** + +### assertGreaterThanOrEqual() + +> **assertGreaterThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) + +Asserts that a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt64`](UInt64.md).[`assertGreaterThanOrEqual`](UInt64.md#assertgreaterthanorequal) + +*** + +### assertLessThan() + +> **assertLessThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) + +Asserts that a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt64`](UInt64.md).[`assertLessThan`](UInt64.md#assertlessthan) + +*** + +### assertLessThanOrEqual() + +> **assertLessThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) + +Asserts that a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt64`](UInt64.md).[`assertLessThanOrEqual`](UInt64.md#assertlessthanorequal) + +*** + +### constructorReference() + +> **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L39) + +#### Returns + +[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> + +#### Inherited from + +[`UInt64`](UInt64.md).[`constructorReference`](UInt64.md#constructorreference) + +*** + +### div() + +> **div**(`y`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) + +Integer division. + +`x.div(y)` returns the floor of `x / y`, that is, the greatest +`z` such that `z * y <= x`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt64`](UInt64.md).[`div`](UInt64.md#div) + +*** + +### divMod() + +> **divMod**(`divisor`): `object` + +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) + +Integer division with remainder. + +`x.divMod(y)` returns the quotient and the remainder. + +#### Parameters + +##### divisor + +`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +`object` + +##### quotient + +> **quotient**: [`UInt`](UInt.md)\<`64`\> + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt64`](UInt64.md).[`divMod`](UInt64.md#divmod) + +*** + +### equals() + +> **equals**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) + +Checks if a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt64`](UInt64.md).[`equals`](UInt64.md#equals) + +*** + +### greaterThan() + +> **greaterThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) + +Checks if a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt64`](UInt64.md).[`greaterThan`](UInt64.md#greaterthan) + +*** + +### greaterThanOrEqual() + +> **greaterThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) + +Checks if a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt64`](UInt64.md).[`greaterThanOrEqual`](UInt64.md#greaterthanorequal) + +*** + +### lessThan() + +> **lessThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) + +Checks if a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt64`](UInt64.md).[`lessThan`](UInt64.md#lessthan) + +*** + +### lessThanOrEqual() + +> **lessThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) + +Checks if a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt64`](UInt64.md).[`lessThanOrEqual`](UInt64.md#lessthanorequal) + +*** + +### mod() + +> **mod**(`y`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) + +Integer remainder. + +`x.mod(y)` returns the value `z` such that `0 <= z < y` and +`x - z` is divisble by `y`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt64`](UInt64.md).[`mod`](UInt64.md#mod) + +*** + +### mul() + +> **mul**(`y`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) + +Multiplication with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt64`](UInt64.md).[`mul`](UInt64.md#mul) + +*** + +### numBits() + +> **numBits**(): `64` + +Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L43) + +#### Returns + +`64` + +#### Inherited from + +[`UInt64`](UInt64.md).[`numBits`](UInt64.md#numbits) + +*** + +### sqrtFloor() + +> **sqrtFloor**(): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) + +Wraps sqrtMod() by only returning the sqrt and omitting the rest field. + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt64`](UInt64.md).[`sqrtFloor`](UInt64.md#sqrtfloor) + +*** + +### sqrtMod() + +> **sqrtMod**(): `object` + +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) + +Implements a non-overflowing square-root with rest. +Normal Field.sqrt() provides the sqrt as it is defined by the finite +field operations. This implementation however mimics the natural-numbers +style of sqrt to be used inside applications with the tradeoff that it +also returns a "rest" that indicates the amount the actual result is off +(since we floor the result to stay inside the ff). + +Some assertions are hard-failing, because they represent malicious +witness values + +#### Returns + +`object` + +sqrt: The non-overflowing sqrt + +rest: The remainder indicating how far off the result +is from the "real" sqrt + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`64`\> + +##### sqrt + +> **sqrt**: [`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt64`](UInt64.md).[`sqrtMod`](UInt64.md#sqrtmod) + +*** + +### sub() + +> **sub**(`y`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) + +Subtraction with underflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt64`](UInt64.md).[`sub`](UInt64.md#sub) + +*** + +### toBigInt() + +> **toBigInt**(): `bigint` + +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) + +Turns the [UInt](UInt.md) into a BigInt. + +#### Returns + +`bigint` + +#### Inherited from + +[`UInt64`](UInt64.md).[`toBigInt`](UInt64.md#tobigint) + +*** + +### toO1UInt64() + +> **toO1UInt64**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. + +#### Returns + +`UInt64` + +#### Inherited from + +[`UInt64`](UInt64.md).[`toO1UInt64`](UInt64.md#too1uint64) + +*** + +### toO1UInt64Clamped() + +> **toO1UInt64Clamped**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), +clamping to the 64 bits range if it's too large. + +#### Returns + +`UInt64` + +#### Inherited from + +[`UInt64`](UInt64.md).[`toO1UInt64Clamped`](UInt64.md#too1uint64clamped) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) + +Turns the [UInt](UInt.md) into a string. + +#### Returns + +`string` + +#### Inherited from + +[`UInt64`](UInt64.md).[`toString`](UInt64.md#tostring) + +*** + +### check() + +> `static` **check**(`x`): `void` + +Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L20) + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### x + +###### value + +`Field` + +#### Returns + +`void` + +#### Inherited from + +[`UInt64`](UInt64.md).[`check`](UInt64.md#check) + +*** + +### checkConstant() + +> `static` **checkConstant**(`x`, `numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) + +#### Parameters + +##### x + +`Field` + +##### numBits + +`number` + +#### Returns + +`Field` + +#### Inherited from + +[`UInt64`](UInt64.md).[`checkConstant`](UInt64.md#checkconstant) + +*** + +### from() + +> `static` **from**(`x`): [`UInt64`](UInt64.md) + +Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L24) + +#### Parameters + +##### x + +`string` | `number` | `bigint` | [`UInt64`](UInt64.md) + +#### Returns + +[`UInt64`](UInt64.md) + +#### Inherited from + +[`UInt64`](UInt64.md).[`from`](UInt64.md#from) + +*** + +### maxIntField() + +> `static` **maxIntField**(`numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) + +Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. + +#### Parameters + +##### numBits + +`number` + +#### Returns + +`Field` + +#### Inherited from + +[`UInt64`](UInt64.md).[`maxIntField`](UInt64.md#maxintfield) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +[`UInt64`](UInt64.md).[`sizeInFields`](UInt64.md#sizeinfields) diff --git a/src/pages/docs/reference/library/classes/Balances.md b/src/pages/docs/reference/library/classes/Balances.md new file mode 100644 index 0000000..d6d1712 --- /dev/null +++ b/src/pages/docs/reference/library/classes/Balances.md @@ -0,0 +1,424 @@ +--- +title: Balances +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / Balances + +# Class: Balances\ + +Defined in: [packages/library/src/runtime/Balances.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L45) + +Base class for runtime modules providing the necessary utilities. + +## Extends + +- [`RuntimeModule`](../../module/classes/RuntimeModule.md)\<`Config`\> + +## Extended by + +- [`TestBalances`](../../stack/classes/TestBalances.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +## Implements + +- [`MinimalBalances`](../type-aliases/MinimalBalances.md) + +## Constructors + +### new Balances() + +> **new Balances**\<`Config`\>(): [`Balances`](Balances.md)\<`Config`\> + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:31 + +#### Returns + +[`Balances`](Balances.md)\<`Config`\> + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`constructor`](../../module/classes/RuntimeModule.md#constructors) + +## Properties + +### balances + +> **balances**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`BalancesKey`](BalancesKey.md), [`Balance`](Balance.md)\> + +Defined in: [packages/library/src/runtime/Balances.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L49) + +#### Implementation of + +`MinimalBalances.balances` + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`currentConfig`](../../module/classes/RuntimeModule.md#currentconfig) + +*** + +### events? + +> `optional` **events**: [`RuntimeEvents`](../../module/classes/RuntimeEvents.md)\<`any`\> + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:30 + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`events`](../../module/classes/RuntimeModule.md#events) + +*** + +### isRuntimeModule + +> **isRuntimeModule**: `boolean` + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:27 + +This property exists only to typecheck that the RuntimeModule +was extended correctly in e.g. a decorator. We need at least +one non-optional property in this class to make the typechecking work. + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`isRuntimeModule`](../../module/classes/RuntimeModule.md#isruntimemodule) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:28 + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`name`](../../module/classes/RuntimeModule.md#name) + +*** + +### runtime? + +> `optional` **runtime**: [`RuntimeEnvironment`](../../module/interfaces/RuntimeEnvironment.md) + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:29 + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`runtime`](../../module/classes/RuntimeModule.md#runtime) + +*** + +### runtimeMethodNames + +> `readonly` **runtimeMethodNames**: `string`[] + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:21 + +Holds all method names that are callable throw transactions + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`runtimeMethodNames`](../../module/classes/RuntimeModule.md#runtimemethodnames) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:17 + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`presets`](../../module/classes/RuntimeModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`config`](../../module/classes/RuntimeModule.md#config) + +*** + +### network + +#### Get Signature + +> **get** **network**(): [`NetworkState`](../../protocol/classes/NetworkState.md) + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:34 + +##### Returns + +[`NetworkState`](../../protocol/classes/NetworkState.md) + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`network`](../../module/classes/RuntimeModule.md#network) + +*** + +### transaction + +#### Get Signature + +> **get** **transaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:33 + +##### Returns + +[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`transaction`](../../module/classes/RuntimeModule.md#transaction) + +## Methods + +### burn() + +> **burn**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> + +Defined in: [packages/library/src/runtime/Balances.ts:99](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L99) + +#### Parameters + +##### tokenId + +[`TokenId`](TokenId.md) + +##### address + +`PublicKey` + +##### amount + +[`Balance`](Balance.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`create`](../../module/classes/RuntimeModule.md#create) + +*** + +### getBalance() + +> **getBalance**(`tokenId`, `address`): `Promise`\<[`Balance`](Balance.md)\> + +Defined in: [packages/library/src/runtime/Balances.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L54) + +#### Parameters + +##### tokenId + +[`TokenId`](TokenId.md) + +##### address + +`PublicKey` + +#### Returns + +`Promise`\<[`Balance`](Balance.md)\> + +*** + +### getInputs() + +> **getInputs**(): [`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:32 + +#### Returns + +[`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`getInputs`](../../module/classes/RuntimeModule.md#getinputs) + +*** + +### mint() + +> **mint**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> + +Defined in: [packages/library/src/runtime/Balances.ts:93](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L93) + +#### Parameters + +##### tokenId + +[`TokenId`](TokenId.md) + +##### address + +`PublicKey` + +##### amount + +[`Balance`](Balance.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### setBalance() + +> **setBalance**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> + +Defined in: [packages/library/src/runtime/Balances.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L63) + +#### Parameters + +##### tokenId + +[`TokenId`](TokenId.md) + +##### address + +`PublicKey` + +##### amount + +[`Balance`](Balance.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### transfer() + +> **transfer**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> + +Defined in: [packages/library/src/runtime/Balances.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L72) + +#### Parameters + +##### tokenId + +[`TokenId`](TokenId.md) + +##### from + +`PublicKey` + +##### to + +`PublicKey` + +##### amount + +[`Balance`](Balance.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +`MinimalBalances.transfer` + +*** + +### transferSigned() + +> **transferSigned**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> + +Defined in: [packages/library/src/runtime/Balances.ts:107](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L107) + +#### Parameters + +##### tokenId + +[`TokenId`](TokenId.md) + +##### from + +`PublicKey` + +##### to + +`PublicKey` + +##### amount + +[`Balance`](Balance.md) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/library/classes/BalancesKey.md b/src/pages/docs/reference/library/classes/BalancesKey.md new file mode 100644 index 0000000..44dc92d --- /dev/null +++ b/src/pages/docs/reference/library/classes/BalancesKey.md @@ -0,0 +1,451 @@ +--- +title: BalancesKey +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / BalancesKey + +# Class: BalancesKey + +Defined in: [packages/library/src/runtime/Balances.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L19) + +## Extends + +- `object` + +## Constructors + +### new BalancesKey() + +> **new BalancesKey**(`value`): [`BalancesKey`](BalancesKey.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +[`TokenId`](TokenId.md) = `TokenId` + +#### Returns + +[`BalancesKey`](BalancesKey.md) + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).constructor` + +## Properties + +### address + +> **address**: `PublicKey` = `PublicKey` + +Defined in: [packages/library/src/runtime/Balances.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L21) + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).address` + +*** + +### tokenId + +> **tokenId**: [`TokenId`](TokenId.md) = `TokenId` + +Defined in: [packages/library/src/runtime/Balances.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L20) + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).tokenId` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +[`TokenId`](TokenId.md) = `TokenId` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: [`TokenId`](TokenId.md) = `TokenId` + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: [`TokenId`](TokenId.md) = `TokenId` + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### address + +`string` = `PublicKey` + +###### tokenId + +`string` = `TokenId` + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: [`TokenId`](TokenId.md) = `TokenId` + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +[`TokenId`](TokenId.md) = `TokenId` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +[`TokenId`](TokenId.md) = `TokenId` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +[`TokenId`](TokenId.md) = `TokenId` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +[`TokenId`](TokenId.md) = `TokenId` + +#### Returns + +`object` + +##### address + +> **address**: `string` = `PublicKey` + +##### tokenId + +> **tokenId**: `string` = `TokenId` + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +[`TokenId`](TokenId.md) = `TokenId` + +#### Returns + +`object` + +##### address + +> **address**: `object` = `PublicKey` + +###### address.isOdd + +> **address.isOdd**: `boolean` + +###### address.x + +> **address.x**: `bigint` + +##### tokenId + +> **tokenId**: `bigint` = `TokenId` + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).toValue` + +## Methods + +### from() + +> `static` **from**(`tokenId`, `address`): [`BalancesKey`](BalancesKey.md) + +Defined in: [packages/library/src/runtime/Balances.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L23) + +#### Parameters + +##### tokenId + +[`TokenId`](TokenId.md) + +##### address + +`PublicKey` + +#### Returns + +[`BalancesKey`](BalancesKey.md) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ tokenId: TokenId, address: PublicKey, }).sizeInFields` diff --git a/src/pages/docs/reference/library/classes/FeeTree.md b/src/pages/docs/reference/library/classes/FeeTree.md new file mode 100644 index 0000000..d2b5d8e --- /dev/null +++ b/src/pages/docs/reference/library/classes/FeeTree.md @@ -0,0 +1,291 @@ +--- +title: FeeTree +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / FeeTree + +# Class: FeeTree + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L44) + +## Extends + +- [`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md) + +## Constructors + +### new FeeTree() + +> **new FeeTree**(`store`): [`FeeTree`](FeeTree.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:113 + +#### Parameters + +##### store + +[`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) + +#### Returns + +[`FeeTree`](FeeTree.md) + +#### Inherited from + +`createMerkleTree(treeFeeHeight).constructor` + +## Properties + +### leafCount + +> `readonly` **leafCount**: `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:78 + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`leafCount`](../../common/interfaces/AbstractMerkleTree.md#leafcount) + +*** + +### store + +> **store**: [`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:77 + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`store`](../../common/interfaces/AbstractMerkleTree.md#store) + +*** + +### EMPTY\_ROOT + +> `static` **EMPTY\_ROOT**: `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:118 + +#### Inherited from + +`createMerkleTree(treeFeeHeight).EMPTY_ROOT` + +*** + +### HEIGHT + +> `static` **HEIGHT**: `number` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:117 + +#### Inherited from + +`createMerkleTree(treeFeeHeight).HEIGHT` + +*** + +### WITNESS + +> `static` **WITNESS**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:114 + +#### Type declaration + +##### dummy() + +> **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +###### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +#### Inherited from + +`createMerkleTree(treeFeeHeight).WITNESS` + +## Accessors + +### leafCount + +#### Get Signature + +> **get** `static` **leafCount**(): `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:119 + +##### Returns + +`bigint` + +#### Inherited from + +`createMerkleTree(treeFeeHeight).leafCount` + +## Methods + +### assertIndexRange() + +> **assertIndexRange**(`index`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:79 + +#### Parameters + +##### index + +`bigint` + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`assertIndexRange`](../../common/interfaces/AbstractMerkleTree.md#assertindexrange) + +*** + +### fill() + +> **fill**(`leaves`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:110 + +Fills all leaves of the tree. + +#### Parameters + +##### leaves + +`Field`[] + +Values to fill the leaves with. + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`fill`](../../common/interfaces/AbstractMerkleTree.md#fill) + +*** + +### getNode() + +> **getNode**(`level`, `index`): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:86 + +Returns a node which lives at a given index and level. + +#### Parameters + +##### level + +`number` + +Level of the node. + +##### index + +`bigint` + +Index of the node. + +#### Returns + +`Field` + +The data of the node. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getNode`](../../common/interfaces/AbstractMerkleTree.md#getnode) + +*** + +### getRoot() + +> **getRoot**(): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:91 + +Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). + +#### Returns + +`Field` + +The root of the Merkle Tree. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getRoot`](../../common/interfaces/AbstractMerkleTree.md#getroot) + +*** + +### getWitness() + +> **getWitness**(`index`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:105 + +Returns the witness (also known as +[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) +for the leaf at the given index. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +#### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +The witness that belongs to the leaf. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getWitness`](../../common/interfaces/AbstractMerkleTree.md#getwitness) + +*** + +### setLeaf() + +> **setLeaf**(`index`, `leaf`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:97 + +Sets the value of a leaf node at a given index to a given value. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +##### leaf + +`Field` + +New value. + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`setLeaf`](../../common/interfaces/AbstractMerkleTree.md#setleaf) diff --git a/src/pages/docs/reference/library/classes/InMemorySequencerModules.md b/src/pages/docs/reference/library/classes/InMemorySequencerModules.md new file mode 100644 index 0000000..21cb540 --- /dev/null +++ b/src/pages/docs/reference/library/classes/InMemorySequencerModules.md @@ -0,0 +1,45 @@ +--- +title: InMemorySequencerModules +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / InMemorySequencerModules + +# Class: InMemorySequencerModules + +Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/InMemorySequencerModules.ts#L31) + +## Constructors + +### new InMemorySequencerModules() + +> **new InMemorySequencerModules**(): [`InMemorySequencerModules`](InMemorySequencerModules.md) + +#### Returns + +[`InMemorySequencerModules`](InMemorySequencerModules.md) + +## Methods + +### with() + +> `static` **with**\<`SequencerModules`\>(`additionalModules`): `object` & `SequencerModules` + +Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/InMemorySequencerModules.ts#L32) + +#### Type Parameters + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +#### Parameters + +##### additionalModules + +`SequencerModules` + +#### Returns + +`object` & `SequencerModules` diff --git a/src/pages/docs/reference/library/classes/MethodFeeConfigData.md b/src/pages/docs/reference/library/classes/MethodFeeConfigData.md new file mode 100644 index 0000000..0d268c6 --- /dev/null +++ b/src/pages/docs/reference/library/classes/MethodFeeConfigData.md @@ -0,0 +1,597 @@ +--- +title: MethodFeeConfigData +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / MethodFeeConfigData + +# Class: MethodFeeConfigData + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L32) + +## Extends + +- `object` + +## Constructors + +### new MethodFeeConfigData() + +> **new MethodFeeConfigData**(`value`): [`MethodFeeConfigData`](MethodFeeConfigData.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### baseFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### methodId + +`Field` = `Field` + +###### perWeightUnitFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### weight + +[`UInt64`](UInt64.md) = `UInt64` + +#### Returns + +[`MethodFeeConfigData`](MethodFeeConfigData.md) + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).constructor` + +## Properties + +### baseFee + +> **baseFee**: [`UInt64`](UInt64.md) = `UInt64` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L34) + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).baseFee` + +*** + +### methodId + +> **methodId**: `Field` = `Field` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L33) + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).methodId` + +*** + +### perWeightUnitFee + +> **perWeightUnitFee**: [`UInt64`](UInt64.md) = `UInt64` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L35) + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).perWeightUnitFee` + +*** + +### weight + +> **weight**: [`UInt64`](UInt64.md) = `UInt64` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L36) + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).weight` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### baseFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### methodId + +`Field` = `Field` + +###### perWeightUnitFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### weight + +[`UInt64`](UInt64.md) = `UInt64` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### baseFee + +> **baseFee**: [`UInt64`](UInt64.md) = `UInt64` + +##### methodId + +> **methodId**: `Field` = `Field` + +##### perWeightUnitFee + +> **perWeightUnitFee**: [`UInt64`](UInt64.md) = `UInt64` + +##### weight + +> **weight**: [`UInt64`](UInt64.md) = `UInt64` + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### baseFee + +> **baseFee**: [`UInt64`](UInt64.md) = `UInt64` + +##### methodId + +> **methodId**: `Field` = `Field` + +##### perWeightUnitFee + +> **perWeightUnitFee**: [`UInt64`](UInt64.md) = `UInt64` + +##### weight + +> **weight**: [`UInt64`](UInt64.md) = `UInt64` + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### baseFee + +\{ `value`: `string`; \} = `UInt64` + +###### baseFee.value + +`string` = `Field` + +###### methodId + +`string` = `Field` + +###### perWeightUnitFee + +\{ `value`: `string`; \} = `UInt64` + +###### perWeightUnitFee.value + +`string` = `Field` + +###### weight + +\{ `value`: `string`; \} = `UInt64` + +###### weight.value + +`string` = `Field` + +#### Returns + +`object` + +##### baseFee + +> **baseFee**: [`UInt64`](UInt64.md) = `UInt64` + +##### methodId + +> **methodId**: `Field` = `Field` + +##### perWeightUnitFee + +> **perWeightUnitFee**: [`UInt64`](UInt64.md) = `UInt64` + +##### weight + +> **weight**: [`UInt64`](UInt64.md) = `UInt64` + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### baseFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### methodId + +`Field` = `Field` + +###### perWeightUnitFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### weight + +[`UInt64`](UInt64.md) = `UInt64` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### baseFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### methodId + +`Field` = `Field` + +###### perWeightUnitFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### weight + +[`UInt64`](UInt64.md) = `UInt64` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### baseFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### methodId + +`Field` = `Field` + +###### perWeightUnitFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### weight + +[`UInt64`](UInt64.md) = `UInt64` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### baseFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### methodId + +`Field` = `Field` + +###### perWeightUnitFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### weight + +[`UInt64`](UInt64.md) = `UInt64` + +#### Returns + +`object` + +##### baseFee + +> **baseFee**: `object` = `UInt64` + +###### baseFee.value + +> **baseFee.value**: `string` = `Field` + +##### methodId + +> **methodId**: `string` = `Field` + +##### perWeightUnitFee + +> **perWeightUnitFee**: `object` = `UInt64` + +###### perWeightUnitFee.value + +> **perWeightUnitFee.value**: `string` = `Field` + +##### weight + +> **weight**: `object` = `UInt64` + +###### weight.value + +> **weight.value**: `string` = `Field` + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### baseFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### methodId + +`Field` = `Field` + +###### perWeightUnitFee + +[`UInt64`](UInt64.md) = `UInt64` + +###### weight + +[`UInt64`](UInt64.md) = `UInt64` + +#### Returns + +`object` + +##### baseFee + +> **baseFee**: `object` = `UInt64` + +###### baseFee.value + +> **baseFee.value**: `bigint` = `Field` + +##### methodId + +> **methodId**: `bigint` = `Field` + +##### perWeightUnitFee + +> **perWeightUnitFee**: `object` = `UInt64` + +###### perWeightUnitFee.value + +> **perWeightUnitFee.value**: `bigint` = `Field` + +##### weight + +> **weight**: `object` = `UInt64` + +###### weight.value + +> **weight.value**: `bigint` = `Field` + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).toValue` + +## Methods + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L38) + +#### Returns + +`Field` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).sizeInFields` diff --git a/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md b/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md new file mode 100644 index 0000000..8696c28 --- /dev/null +++ b/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md @@ -0,0 +1,216 @@ +--- +title: RuntimeFeeAnalyzerService +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / RuntimeFeeAnalyzerService + +# Class: RuntimeFeeAnalyzerService + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L56) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<[`RuntimeFeeAnalyzerServiceConfig`](../interfaces/RuntimeFeeAnalyzerServiceConfig.md)\> + +## Constructors + +### new RuntimeFeeAnalyzerService() + +> **new RuntimeFeeAnalyzerService**(`runtime`): [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L67) + +#### Parameters + +##### runtime + +[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> + +#### Returns + +[`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) + +#### Overrides + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`RuntimeFeeAnalyzerServiceConfig`](../interfaces/RuntimeFeeAnalyzerServiceConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) + +*** + +### runtime + +> **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L68) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) + +*** + +### getFeeConfig() + +> **getFeeConfig**(`methodId`): [`MethodFeeConfigData`](MethodFeeConfigData.md) + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:169](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L169) + +#### Parameters + +##### methodId + +`bigint` + +#### Returns + +[`MethodFeeConfigData`](MethodFeeConfigData.md) + +*** + +### getFeeTree() + +> **getFeeTree**(): `object` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:161](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L161) + +#### Returns + +`object` + +##### indexes + +> **indexes**: [`FeeIndexes`](../interfaces/FeeIndexes.md) + +##### tree + +> **tree**: [`FeeTree`](FeeTree.md) + +##### values + +> **values**: [`FeeTreeValues`](../interfaces/FeeTreeValues.md) + +*** + +### getRoot() + +> **getRoot**(): `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:185](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L185) + +#### Returns + +`bigint` + +*** + +### getWitness() + +> **getWitness**(`methodId`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:180](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L180) + +#### Parameters + +##### methodId + +`bigint` + +#### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +*** + +### initializeFeeTree() + +> **initializeFeeTree**(): `Promise`\<`void`\> + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L73) + +#### Returns + +`Promise`\<`void`\> + +*** + +### getWitnessType() + +> `static` **getWitnessType**(): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L57) + +#### Returns + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` diff --git a/src/pages/docs/reference/library/classes/SimpleSequencerModules.md b/src/pages/docs/reference/library/classes/SimpleSequencerModules.md new file mode 100644 index 0000000..830f0de --- /dev/null +++ b/src/pages/docs/reference/library/classes/SimpleSequencerModules.md @@ -0,0 +1,161 @@ +--- +title: SimpleSequencerModules +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / SimpleSequencerModules + +# Class: SimpleSequencerModules + +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L46) + +## Constructors + +### new SimpleSequencerModules() + +> **new SimpleSequencerModules**(): [`SimpleSequencerModules`](SimpleSequencerModules.md) + +#### Returns + +[`SimpleSequencerModules`](SimpleSequencerModules.md) + +## Methods + +### defaultConfig() + +> `static` **defaultConfig**(): `object` + +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:97](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L97) + +#### Returns + +`object` + +##### BatchProducerModule + +> **BatchProducerModule**: `object` = `{}` + +##### BlockProducerModule + +> **BlockProducerModule**: `object` + +###### BlockProducerModule.allowEmptyBlock + +> **BlockProducerModule.allowEmptyBlock**: `true` = `true` + +##### Mempool + +> **Mempool**: `object` = `{}` + +##### SequencerStartupModule + +> **SequencerStartupModule**: `object` = `{}` + +*** + +### defaultWorkerConfig() + +> `static` **defaultWorkerConfig**(): `object` + +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L109) + +#### Returns + +`object` + +##### LocalTaskWorkerModule + +> **LocalTaskWorkerModule**: `object` + +###### LocalTaskWorkerModule.BlockBuildingTask + +> **LocalTaskWorkerModule.BlockBuildingTask**: `object` + +###### LocalTaskWorkerModule.BlockProvingTask + +> **LocalTaskWorkerModule.BlockProvingTask**: `object` + +###### LocalTaskWorkerModule.BlockReductionTask + +> **LocalTaskWorkerModule.BlockReductionTask**: `object` + +###### LocalTaskWorkerModule.CircuitCompilerTask + +> **LocalTaskWorkerModule.CircuitCompilerTask**: `object` + +###### LocalTaskWorkerModule.RuntimeProvingTask + +> **LocalTaskWorkerModule.RuntimeProvingTask**: `object` + +###### LocalTaskWorkerModule.SettlementProvingTask + +> **LocalTaskWorkerModule.SettlementProvingTask**: `object` + +###### LocalTaskWorkerModule.StateTransitionReductionTask + +> **LocalTaskWorkerModule.StateTransitionReductionTask**: `object` + +###### LocalTaskWorkerModule.StateTransitionTask + +> **LocalTaskWorkerModule.StateTransitionTask**: `object` + +###### LocalTaskWorkerModule.TransactionProvingTask + +> **LocalTaskWorkerModule.TransactionProvingTask**: `object` + +###### LocalTaskWorkerModule.WorkerRegistrationTask + +> **LocalTaskWorkerModule.WorkerRegistrationTask**: `object` + +*** + +### with() + +> `static` **with**\<`SequencerModules`\>(`additionalModules`): `object` & `Omit`\<`SequencerModules`, `"Database"` \| `"BlockTrigger"` \| `"TaskQueue"` \| `"BaseLayer"` \| `"DatabasePruneModule"`\> & `object` + +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L60) + +#### Type Parameters + +• **SequencerModules** *extends* [`AdditionalSequencerModules`](../type-aliases/AdditionalSequencerModules.md) + +#### Parameters + +##### additionalModules + +`SequencerModules` + +#### Returns + +`object` & `Omit`\<`SequencerModules`, `"Database"` \| `"BlockTrigger"` \| `"TaskQueue"` \| `"BaseLayer"` \| `"DatabasePruneModule"`\> & `object` + +*** + +### worker() + +> `static` **worker**\<`QueueModule`, `SequencerModules`\>(`queue`, `additionalModules`): `object` & `SequencerModules` + +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L47) + +#### Type Parameters + +• **QueueModule** *extends* [`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +#### Parameters + +##### queue + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`QueueModule`\> + +##### additionalModules + +`SequencerModules` + +#### Returns + +`object` & `SequencerModules` diff --git a/src/pages/docs/reference/library/classes/TokenId.md b/src/pages/docs/reference/library/classes/TokenId.md new file mode 100644 index 0000000..ec2b549 --- /dev/null +++ b/src/pages/docs/reference/library/classes/TokenId.md @@ -0,0 +1,1605 @@ +--- +title: TokenId +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / TokenId + +# Class: TokenId + +Defined in: [packages/library/src/runtime/Balances.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L18) + +## Extends + +- `Field` + +## Constructors + +### new TokenId() + +> **new TokenId**(`x`): [`TokenId`](TokenId.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:55 + +Coerce anything "field-like" (bigint, number, string, and Field) to a Field. + +#### Parameters + +##### x + +`string` | `number` | `bigint` | `Field` | `FieldVar` | `FieldConst` + +#### Returns + +[`TokenId`](TokenId.md) + +#### Inherited from + +`Field.constructor` + +## Properties + +### value + +> **value**: `FieldVar` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:46 + +#### Inherited from + +`Field.value` + +*** + +### ORDER + +> `static` **ORDER**: `bigint` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:51 + +The order of the pasta curve that Field type build on as a `bigint`. +Order of the Field is 28948022309329048855892746252171976963363056481941560715954676764349967630337. + +#### Inherited from + +`Field.ORDER` + +*** + +### sizeInBits + +> `static` **sizeInBits**: `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:710 + +The size of a Field element in bits - 255. + +#### Inherited from + +`Field.sizeInBits` + +*** + +### sizeInBytes + +> `static` **sizeInBytes**: `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:706 + +The size of a Field element in bytes - 32. + +#### Inherited from + +`Field.sizeInBytes` + +## Methods + +### add() + +> **add**(`y`): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:159 + +Add a field-like value to this Field element. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Field` + +A Field element equivalent to the modular addition of the two value. + +#### Examples + +```ts +const x = Field(3); +const sum = x.add(5); + +sum.assertEquals(Field(8)); +``` + +**Warning**: This is a modular addition in the pasta field. + +```ts +const x = Field(1); +const sum = x.add(Field(-7)); + +// If you try to print sum - `console.log(sum.toBigInt())` - you will realize that it prints a very big integer because this is modular arithmetic, and 1 + (-7) circles around the field to become p - 6. +// You can use the reverse operation of addition (subtraction) to prove the sum is calculated correctly. + +sum.sub(x).assertEquals(Field(-7)); +sum.sub(Field(-7)).assertEquals(x); +``` + +#### Inherited from + +`Field.add` + +*** + +### assertBool() + +> **assertBool**(`message`?): `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:493 + +Prove that this Field is equal to 0 or 1. +Returns the Field wrapped in a Bool. + +If the assertion fails, the code throws an error. + +#### Parameters + +##### message? + +`string` + +#### Returns + +`Bool` + +#### Inherited from + +`Field.assertBool` + +*** + +### assertEquals() + +> **assertEquals**(`y`, `message`?): `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:130 + +Assert that this Field is equal another "field-like" value. +Calling this function is equivalent to `Field(...).equals(...).assertEquals(Bool(true))`. +See [Field.equals](TokenId.md#equals) for more details. + +**Important**: If an assertion fails, the code throws an error. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +`Field.assertEquals` + +*** + +### assertGreaterThan() + +> **assertGreaterThan**(`y`, `message`?): `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:461 + +Assert that this Field is greater than another "field-like" value. + +Note: This uses fewer constraints than `x.greaterThan(y).assertTrue()`. +See [Field.greaterThan](TokenId.md#greaterthan) for more details. + +**Important**: If an assertion fails, the code throws an error. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +`Field.assertGreaterThan` + +*** + +### assertGreaterThanOrEqual() + +> **assertGreaterThanOrEqual**(`y`, `message`?): `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:473 + +Assert that this Field is greater than or equal to another "field-like" value. + +Note: This uses fewer constraints than `x.greaterThanOrEqual(y).assertTrue()`. +See [Field.greaterThanOrEqual](TokenId.md#greaterthanorequal) for more details. + +**Important**: If an assertion fails, the code throws an error. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +`Field.assertGreaterThanOrEqual` + +*** + +### assertLessThan() + +> **assertLessThan**(`y`, `message`?): `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:437 + +Assert that this Field is less than another "field-like" value. + +Note: This uses fewer constraints than `x.lessThan(y).assertTrue()`. +See [lessThan](TokenId.md#lessthan) for more details. + +**Important**: If an assertion fails, the code throws an error. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +`Field.assertLessThan` + +*** + +### assertLessThanOrEqual() + +> **assertLessThanOrEqual**(`y`, `message`?): `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:449 + +Assert that this Field is less than or equal to another "field-like" value. + +Note: This uses fewer constraints than `x.lessThanOrEqual(y).assertTrue()`. +See [Field.lessThanOrEqual](TokenId.md#lessthanorequal) for more details. + +**Important**: If an assertion fails, the code throws an error. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +`Field.assertLessThanOrEqual` + +*** + +### assertNotEquals() + +> **assertNotEquals**(`y`, `message`?): `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:484 + +Assert that this Field does not equal another field-like value. + +Note: This uses fewer constraints than `x.equals(y).assertFalse()`. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +##### message? + +`string` + +#### Returns + +`void` + +#### Example + +```ts +x.assertNotEquals(0, "expect x to be non-zero"); +``` + +#### Inherited from + +`Field.assertNotEquals` + +*** + +### div() + +> **div**(`y`): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:293 + +Divide another "field-like" value through this Field. + +Proves that the denominator is non-zero, or throws a "Division by zero" error. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Field` + +A Field element equivalent to the modular division of the two value. + +#### Examples + +```ts +const x = Field(6); +const quotient = x.div(Field(3)); + +quotient.assertEquals(Field(2)); +``` + +**Warning**: This is a modular division in the pasta field. You can think this as the reverse operation of modular multiplication. + +```ts +const x = Field(2); +const y = Field(5); + +const quotient = x.div(y); + +// If you try to print quotient - `console.log(quotient.toBigInt())` - you will realize that it prints a very big integer because this is a modular inverse. +// You can use the reverse operation of division (multiplication) to prove the quotient is calculated correctly. + +quotient.mul(y).assertEquals(x); +``` + +#### Inherited from + +`Field.div` + +*** + +### equals() + +> **equals**(`y`): `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:341 + +Check if this Field is equal another "field-like" value. +Returns a Bool, which is a provable type and can be used to prove the validity of this statement. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Bool` + +A Bool representing if this Field is equal another "field-like" value. + +#### Example + +```ts +Field(5).equals(5).assertEquals(Bool(true)); +``` + +#### Inherited from + +`Field.equals` + +*** + +### greaterThan() + +> **greaterThan**(`y`): `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:404 + +Check if this Field is greater than another "field-like" value. +Returns a Bool, which is a provable type and can be used to prove the validity of this statement. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Bool` + +A Bool representing if this Field is greater than another "field-like" value. + +#### Examples + +```ts +let isTrue = Field(5).greaterThan(3); +``` + +**Warning**: As this method compares the bigint value of a Field, it can result in unexpected behaviour when used with negative inputs or modular division. + +```ts +let isFalse = Field(1).div(2).greaterThan(Field(1).div(3); // in fact, 1/3 > 1/2 +``` + +#### Inherited from + +`Field.greaterThan` + +*** + +### greaterThanOrEqual() + +> **greaterThanOrEqual**(`y`): `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:425 + +Check if this Field is greater than or equal another "field-like" value. +Returns a Bool, which is a provable type and can be used to prove the validity of this statement. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Bool` + +A Bool representing if this Field is greater than or equal another "field-like" value. + +#### Examples + +```ts +let isTrue = Field(3).greaterThanOrEqual(3); +``` + +**Warning**: As this method compares the bigint value of a Field, it can result in unexpected behaviour when used with negative inputs or modular division. + +```ts +let isFalse = Field(1).div(2).greaterThanOrEqual(Field(1).div(3); // in fact, 1/3 > 1/2 +``` + +#### Inherited from + +`Field.greaterThanOrEqual` + +*** + +### inv() + +> **inv**(): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:260 + +[Modular inverse](https://en.wikipedia.org/wiki/Modular_multiplicative_inverse) of this Field element. +Equivalent to 1 divided by this Field, in the sense of modular arithmetic. + +Proves that this Field is non-zero, or throws a "Division by zero" error. + +#### Returns + +`Field` + +A Field element that is equivalent to one divided by this element. + +#### Example + +```ts +const someField = Field(42); +const inverse = someField.inv(); +inverse.assertEquals(Field(1).div(someField)); // This statement is always true regardless of the value of `someField` +``` + +**Warning**: This is a modular inverse. See [div](TokenId.md#div) method for more details. + +#### Inherited from + +`Field.inv` + +*** + +### isConstant() + +> **isConstant**(): `this is { value: ConstantFieldVar }` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:75 + +Check whether this Field element is a hard-coded constant in the constraint system. +If a Field is constructed outside a zkApp method, it is a constant. + +#### Returns + +`this is { value: ConstantFieldVar }` + +A `boolean` showing if this Field is a constant or not. + +#### Examples + +```ts +console.log(Field(42).isConstant()); // true +``` + +```ts +\@method myMethod(x: Field) { + console.log(x.isConstant()); // false +} +``` + +#### Inherited from + +`Field.isConstant` + +*** + +### isEven() + +> **isEven**(): `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:226 + +Checks if this Field is even. Returns `true` for even elements and `false` for odd elements. + +#### Returns + +`Bool` + +#### Example + +```ts +let a = Field(5); +a.isEven(); // false + +let b = Field(4); +b.isEven(); // true +``` + +#### Inherited from + +`Field.isEven` + +*** + +### isOdd() + +> **isOdd**(): `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:213 + +Checks if this Field is odd. Returns `true` for odd elements and `false` for even elements. + +See [Field.isEven](TokenId.md#iseven) for examples. + +#### Returns + +`Bool` + +#### Inherited from + +`Field.isOdd` + +*** + +### lessThan() + +> **lessThan**(`y`): `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:362 + +Check if this Field is less than another "field-like" value. +Returns a Bool, which is a provable type and can be used prove to the validity of this statement. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Bool` + +A Bool representing if this Field is less than another "field-like" value. + +#### Examples + +```ts +let isTrue = Field(2).lessThan(3); +``` + +**Warning**: As this method compares the bigint value of a Field, it can result in unexpected behavior when used with negative inputs or modular division. + +```ts +let isFalse = Field(1).div(3).lessThan(Field(1).div(2)); // in fact, 1/3 > 1/2 +``` + +#### Inherited from + +`Field.lessThan` + +*** + +### lessThanOrEqual() + +> **lessThanOrEqual**(`y`): `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:383 + +Check if this Field is less than or equal to another "field-like" value. +Returns a Bool, which is a provable type and can be used to prove the validity of this statement. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Bool` + +A Bool representing if this Field is less than or equal another "field-like" value. + +#### Examples + +```ts +let isTrue = Field(3).lessThanOrEqual(3); +``` + +**Warning**: As this method compares the bigint value of a Field, it can result in unexpected behaviour when used with negative inputs or modular division. + +```ts +let isFalse = Field(1).div(3).lessThanOrEqual(Field(1).div(2)); // in fact, 1/3 > 1/2 +``` + +#### Inherited from + +`Field.lessThanOrEqual` + +*** + +### mul() + +> **mul**(`y`): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:242 + +Multiply another "field-like" value with this Field element. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Field` + +A Field element equivalent to the modular difference of the two value. + +#### Example + +```ts +const x = Field(3); +const product = x.mul(Field(5)); + +product.assertEquals(Field(15)); +``` + +#### Inherited from + +`Field.mul` + +*** + +### neg() + +> **neg**(): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:179 + +Negate a Field. This is equivalent to multiplying the Field by -1. + +#### Returns + +`Field` + +A Field element that is equivalent to the element multiplied by -1. + +#### Examples + +```ts +const negOne = Field(1).neg(); +negOne.assertEquals(-1); +``` + +```ts +const someField = Field(42); +someField.neg().assertEquals(someField.mul(Field(-1))); // This statement is always true regardless of the value of `someField` +``` + +**Warning**: This is a modular negation. For details, see the [sub](TokenId.md#sub) method. + +#### Inherited from + +`Field.neg` + +*** + +### seal() + +> **seal**(): `VarField` \| `ConstantField` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:531 + +**Warning**: This function is mainly for internal use. Normally it is not intended to be used by a zkApp developer. + +In o1js, addition and scaling (multiplication of variables by a constant) of variables is represented as an AST - [abstract syntax tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree). For example, the expression `x.add(y).mul(2)` is represented as `Scale(2, Add(x, y))`. + + A new internal variable is created only when the variable is needed in a multiplicative or any higher level constraint (for example multiplication of two Field elements) to represent the operation. + +The `seal()` function tells o1js to stop building an AST and create a new variable right away. + +#### Returns + +`VarField` \| `ConstantField` + +A Field element that is equal to the result of AST that was previously on this Field element. + +#### Inherited from + +`Field.seal` + +*** + +### sqrt() + +> **sqrt**(): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:327 + +Take the square root of this Field element. + +Proves that the Field element has a square root in the finite field, or throws if it doesn't. + +#### Returns + +`Field` + +A Field element equivalent to the square root of the Field element. + +#### Example + +```ts +let z = x.sqrt(); +z.mul(z).assertEquals(x); // true for every `x` +``` + +**Warning**: This is a modular square root, which is any number z that satisfies z*z = x (mod p). +Note that, if a square root z exists, there also exists a second one, -z (which is different if z != 0). +Therefore, this method leaves an adversarial prover the choice between two different values to return. + +#### Inherited from + +`Field.sqrt` + +*** + +### square() + +> **square**(): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:309 + +Square this Field element. + +#### Returns + +`Field` + +A Field element equivalent to the multiplication of the Field element with itself. + +#### Example + +```ts +const someField = Field(7); +const square = someField.square(); + +square.assertEquals(someField.mul(someField)); // This statement is always true regardless of the value of `someField` +``` + +** Warning: This is a modular multiplication. See `mul()` method for more details. + +#### Inherited from + +`Field.square` + +*** + +### sub() + +> **sub**(`y`): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:207 + +Subtract another "field-like" value from this Field element. + +#### Parameters + +##### y + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Field` + +A Field element equivalent to the modular difference of the two value. + +#### Examples + +```ts +const x = Field(3); +const difference = x.sub(5); + +difference.assertEquals(Field(-2)); +``` + +**Warning**: This is a modular subtraction in the pasta field. + +```ts +const x = Field(1); +const difference = x.sub(Field(2)); + +// If you try to print difference - `console.log(difference.toBigInt())` - you will realize that it prints a very big integer because this is modular arithmetic, and 1 - 2 circles around the field to become p - 1. +// You can use the reverse operation of subtraction (addition) to prove the difference is calculated correctly. +difference.add(Field(2)).assertEquals(x); +``` + +#### Inherited from + +`Field.sub` + +*** + +### toAuxiliary() + +> **toAuxiliary**(): \[\] + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:621 + +This function is the implementation of Provable.toAuxiliary for the Field type. + +As the primitive Field type has no auxiliary data associated with it, this function will always return an empty array. + +#### Returns + +\[\] + +#### Inherited from + +`Field.toAuxiliary` + +*** + +### toBigInt() + +> **toBigInt**(): `bigint` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:105 + +Serialize the Field to a bigint, e.g. for printing. Trying to print a Field without this function will directly stringify the Field object, resulting in unreadable output. + +**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the bigint representation of the Field. Use the operation only during debugging. + +#### Returns + +`bigint` + +A bigint equivalent to the bigint representation of the Field. + +#### Example + +```ts +const someField = Field(42); +console.log(someField.toBigInt()); +``` + +#### Inherited from + +`Field.toBigInt` + +*** + +### toBits() + +> **toBits**(`length`?): `Bool`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:507 + +Returns an array of Bool elements representing [little endian binary representation](https://en.wikipedia.org/wiki/Endianness) of this Field element. + +If you use the optional `length` argument, proves that the field element fits in `length` bits. +The `length` has to be between 0 and 254 and the method throws if it isn't. + +**Warning**: The cost of this operation in a zk proof depends on the `length` you specify, +which by default is 254 bits. Prefer to pass a smaller `length` if possible. + +#### Parameters + +##### length? + +`number` + +the number of bits to fit the element. If the element does not fit in `length` bits, the functions throws an error. + +#### Returns + +`Bool`[] + +An array of Bool element representing little endian binary representation of this Field. + +#### Inherited from + +`Field.toBits` + +*** + +### toConstant() + +> **toConstant**(): `ConstantField` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:91 + +Create a Field element equivalent to this Field element's value, +but is a constant. +See [Field.isConstant](TokenId.md#isconstant) for more information about what is a constant Field. + +#### Returns + +`ConstantField` + +A constant Field element equivalent to this Field element. + +#### Example + +```ts +const someField = Field(42); +someField.toConstant().assertEquals(someField); // Always true +``` + +#### Inherited from + +`Field.toConstant` + +*** + +### toFields() + +> **toFields**(): `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:615 + +This function is the implementation of Provable.toFields for the Field type. + +The result will be always an array of length 1, where the first and only element equals the Field itself. + +#### Returns + +`Field`[] + +A Field array of length 1 created from this Field. + +#### Inherited from + +`Field.toFields` + +*** + +### toJSON() + +> **toJSON**(): `string` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:636 + +Serialize the Field to a JSON string, e.g. for printing. Trying to print a Field without this function will directly stringify the Field object, resulting in unreadable output. + +**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the JSON string representation of the Field. Use the operation only during debugging. + +#### Returns + +`string` + +A string equivalent to the JSON representation of the Field. + +#### Example + +```ts +const someField = Field(42); +console.log(someField.toJSON()); +``` + +#### Inherited from + +`Field.toJSON` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:119 + +Serialize the Field to a string, e.g. for printing. Trying to print a Field without this function will directly stringify the Field object, resulting in unreadable output. + +**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the string representation of the Field. Use the operation only during debugging. + +#### Returns + +`string` + +A string equivalent to the string representation of the Field. + +#### Example + +```ts +const someField = Field(42); +console.log(someField.toString()); +``` + +#### Inherited from + +`Field.toString` + +*** + +### check() + +> `static` **check**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:595 + +This function is the implementation of Provable.check in Field type. + +As any field element can be a Field, this function does not create any assertions, so it does nothing. + +#### Returns + +`void` + +#### Inherited from + +`Field.check` + +*** + +### empty() + +> `static` **empty**(): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:622 + +#### Returns + +`Field` + +#### Inherited from + +`Field.empty` + +*** + +### from() + +> `static` **from**(`x`): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:56 + +#### Parameters + +##### x + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Field` + +#### Inherited from + +`Field.from` + +*** + +### fromBits() + +> `static` **fromBits**(`bits`): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:519 + +Convert a bit array into a Field element using [little endian binary representation](https://en.wikipedia.org/wiki/Endianness) + +The method throws if the given bits do not fit in a single Field element. In this case, no more than 254 bits are allowed because some 255 bit integers do not fit into a single Field element. + +**Important**: If the given `bytes` array is an array of `booleans` or Bool elements that all are `constant`, the resulting Field element will be a constant as well. Or else, if the given array is a mixture of constants and variables of Bool type, the resulting Field will be a variable as well. + +#### Parameters + +##### bits + +(`boolean` \| `Bool`)[] + +#### Returns + +`Field` + +A Field element matching the [little endian binary representation](https://en.wikipedia.org/wiki/Endianness) of the given `bytes` array. + +#### Inherited from + +`Field.fromBits` + +*** + +### fromBytes() + +> `static` **fromBytes**(`bytes`): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:702 + +Coerce a new Field element using the [little-endian](https://en.wikipedia.org/wiki/Endianness) representation of the given `bytes` array. +Note that the given `bytes` array may have at most 32 elements as the Field is a `finite-field` in the order of [Field.ORDER](TokenId.md#order). + +**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the byte representation of the Field. + +#### Parameters + +##### bytes + +`number`[] + +The bytes array to coerce the Field from. + +#### Returns + +`Field` + +A new Field element created using the [little-endian](https://en.wikipedia.org/wiki/Endianness) representation of the given `bytes` array. + +#### Inherited from + +`Field.fromBytes` + +*** + +### fromFields() + +> `static` **fromFields**(`fields`): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:587 + +Implementation of Provable.fromFields for the Field type. + +**Warning**: This function is designed for internal use. It is not intended to be used by a zkApp developer. + +Creates a Field from an array of Fields of length 1. + +#### Parameters + +##### fields + +`Field`[] + +an array of length 1 serialized from Field elements. + +#### Returns + +`Field` + +The first Field element of the given array. + +#### Inherited from + +`Field.fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**(`json`): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:662 + +Deserialize a JSON string containing a "field-like" value into a Field element. + +**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the string representation of the Field. + +#### Parameters + +##### json + +`string` + +#### Returns + +`Field` + +A Field coerced from the given JSON string. + +#### Inherited from + +`Field.fromJSON` + +*** + +### fromValue() + +> `static` **fromValue**(`x`): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:607 + +`Provable.fromValue()` + +#### Parameters + +##### x + +`string` | `number` | `bigint` | `Field` + +#### Returns + +`Field` + +#### Inherited from + +`Field.fromValue` + +*** + +### random() + +> `static` **random**(): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:542 + +A random Field element. + +#### Returns + +`Field` + +A random Field element. + +#### Example + +```ts +console.log(Field.random().toBigInt()); // Run this code twice! +``` + +#### Inherited from + +`Field.random` + +*** + +### readBytes() + +> `static` **readBytes**\<`N`\>(`bytes`, `offset`): \[`Field`, `number`\] + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:691 + +Part of the `Binable` interface. + +**Warning**: This function is for internal use. It is not intended to be used by a zkApp developer. + +#### Type Parameters + +• **N** *extends* `number` + +#### Parameters + +##### bytes + +`number`[] + +##### offset + +`NonNegativeInteger`\<`N`\> + +#### Returns + +\[`Field`, `number`\] + +#### Inherited from + +`Field.readBytes` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:575 + +This function is the implementation of Provable.sizeInFields for the Field type. + +Size of the Field type is 1, as it is the primitive type. +This function returns a regular number, so you cannot use it to prove something on chain. You can use it during debugging or to understand the memory complexity of some type. + +#### Returns + +`number` + +A number representing the size of the Field type in terms of Field type itself. + +#### Example + +```ts +console.log(Field.sizeInFields()); // Prints 1 +``` + +#### Inherited from + +`Field.sizeInFields` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**(): \[\] + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:561 + +This function is the implementation of Provable.toAuxiliary for the Field type. + +As the primitive Field type has no auxiliary data associated with it, this function will always return an empty array. + +#### Returns + +\[\] + +#### Inherited from + +`Field.toAuxiliary` + +*** + +### toBigint() + +> `static` **toBigint**(`x`): `bigint` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:603 + +Convert a Field element to a bigint. + +#### Parameters + +##### x + +`Field` + +#### Returns + +`bigint` + +#### Inherited from + +`Field.toBigint` + +*** + +### toBytes() + +> `static` **toBytes**(`x`): `number`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:685 + +Create an array of digits equal to the [little-endian](https://en.wikipedia.org/wiki/Endianness) byte order of the given Field element. +Note that the array has always 32 elements as the Field is a `finite-field` in the order of [Field.ORDER](TokenId.md#order). + +#### Parameters + +##### x + +`Field` + +#### Returns + +`number`[] + +An array of digits equal to the [little-endian](https://en.wikipedia.org/wiki/Endianness) byte order of the given Field element. + +#### Inherited from + +`Field.toBytes` + +*** + +### toFields() + +> `static` **toFields**(`x`): `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:553 + +This function is the implementation of Provable.toFields for the Field type. + +Static function to serializes a Field into an array of Field elements. +This will be always an array of length 1, where the first and only element equals the given parameter itself. + +#### Parameters + +##### x + +`Field` + +#### Returns + +`Field`[] + +A Field array of length 1 created from this Field. + +#### Inherited from + +`Field.toFields` + +*** + +### toInput() + +> `static` **toInput**(`x`): `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:673 + +**Warning**: This function is mainly for internal use. Normally it is not intended to be used by a zkApp developer. + +This function is the implementation of `ProvableExtended.toInput()` for the Field type. + +#### Parameters + +##### x + +`Field` + +#### Returns + +`object` + +An object where the `fields` key is a Field array of length 1 created from this Field. + +##### fields + +> **fields**: `Field`[] + +#### Inherited from + +`Field.toInput` + +*** + +### toJSON() + +> `static` **toJSON**(`x`): `string` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:652 + +Serialize the given Field element to a JSON string, e.g. for printing. Trying to print a Field without this function will directly stringify the Field object, resulting in unreadable output. + +**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the JSON string representation of the Field. Use the operation only during debugging. + +#### Parameters + +##### x + +`Field` + +#### Returns + +`string` + +A string equivalent to the JSON representation of the given Field. + +#### Example + +```ts +const someField = Field(42); +console.log(Field.toJSON(someField)); +``` + +#### Inherited from + +`Field.toJSON` + +*** + +### toValue() + +> `static` **toValue**(`x`): `bigint` + +Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:599 + +`Provable.toValue()` + +#### Parameters + +##### x + +`Field` + +#### Returns + +`bigint` + +#### Inherited from + +`Field.toValue` diff --git a/src/pages/docs/reference/library/classes/TransactionFeeHook.md b/src/pages/docs/reference/library/classes/TransactionFeeHook.md new file mode 100644 index 0000000..a3c3c47 --- /dev/null +++ b/src/pages/docs/reference/library/classes/TransactionFeeHook.md @@ -0,0 +1,291 @@ +--- +title: TransactionFeeHook +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / TransactionFeeHook + +# Class: TransactionFeeHook + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L51) + +Transaction hook for deducting transaction fees from the sender's balance. + +## Extends + +- [`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md)\<[`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md)\> + +## Constructors + +### new TransactionFeeHook() + +> **new TransactionFeeHook**(`runtime`): [`TransactionFeeHook`](TransactionFeeHook.md) + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L52) + +#### Parameters + +##### runtime + +[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> + +#### Returns + +[`TransactionFeeHook`](TransactionFeeHook.md) + +#### Overrides + +[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`constructor`](../../protocol/classes/ProvableTransactionHook.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`currentConfig`](../../protocol/classes/ProvableTransactionHook.md#currentconfig) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: packages/protocol/dist/protocol/TransitioningProtocolModule.d.ts:8 + +#### Inherited from + +[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`name`](../../protocol/classes/ProvableTransactionHook.md#name) + +*** + +### persistedFeeAnalyzer + +> `protected` **persistedFeeAnalyzer**: `undefined` \| [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) = `undefined` + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L59) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../../protocol/interfaces/ProtocolEnvironment.md) + +Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:4 + +#### Inherited from + +[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`protocol`](../../protocol/classes/ProvableTransactionHook.md#protocol) + +*** + +### runtime + +> **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L54) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:5 + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`areProofsEnabled`](../../protocol/classes/ProvableTransactionHook.md#areproofsenabled) + +*** + +### balances + +#### Get Signature + +> **get** **balances**(): `Balances` + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L94) + +##### Returns + +`Balances` + +*** + +### config + +#### Get Signature + +> **get** **config**(): [`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L85) + +##### Returns + +[`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) + +#### Set Signature + +> **set** **config**(`value`): `void` + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:90](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L90) + +##### Parameters + +###### value + +[`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) + +##### Returns + +`void` + +#### Overrides + +[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`config`](../../protocol/classes/ProvableTransactionHook.md#config) + +*** + +### feeAnalyzer + +#### Get Signature + +> **get** **feeAnalyzer**(): [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L98) + +##### Returns + +[`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:6 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`create`](../../protocol/classes/ProvableTransactionHook.md#create) + +*** + +### getFee() + +> **getFee**(`feeConfig`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L114) + +#### Parameters + +##### feeConfig + +[`MethodFeeConfigData`](MethodFeeConfigData.md) + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +*** + +### onTransaction() + +> **onTransaction**(`executionData`): `Promise`\<`void`\> + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:128](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L128) + +Determine the transaction fee for the given transaction, and transfer it +from the transaction sender to the fee recipient. + +#### Parameters + +##### executionData + +[`BlockProverExecutionData`](../../protocol/classes/BlockProverExecutionData.md) + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`onTransaction`](../../protocol/classes/ProvableTransactionHook.md#ontransaction) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L79) + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`start`](../../protocol/classes/ProvableTransactionHook.md#start) + +*** + +### transferFee() + +> **transferFee**(`from`, `fee`): `Promise`\<`void`\> + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L105) + +#### Parameters + +##### from + +[`PublicKeyOption`](../../protocol/classes/PublicKeyOption.md) + +##### fee + +[`UInt64`](UInt64.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### verifyConfig() + +> **verifyConfig**(): `void` + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L64) + +#### Returns + +`void` diff --git a/src/pages/docs/reference/library/classes/UInt.md b/src/pages/docs/reference/library/classes/UInt.md new file mode 100644 index 0000000..9ac051c --- /dev/null +++ b/src/pages/docs/reference/library/classes/UInt.md @@ -0,0 +1,924 @@ +--- +title: UInt +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UInt + +# Class: `abstract` UInt\ + +Defined in: [packages/library/src/math/UInt.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L45) + +UInt is a base class for all soft-failing UInt* implementations. +It has to be overridden for every bitlength that should be available. + +For this, the developer has to create a subclass of UInt implementing the +static methods from interface UIntConstructor + +## Extends + +- `object` + +## Extended by + +- [`UInt32`](UInt32.md) +- [`UInt64`](UInt64.md) +- [`UInt112`](UInt112.md) +- [`UInt224`](UInt224.md) + +## Type Parameters + +• **BITS** *extends* `number` + +## Constructors + +### new UInt() + +> **new UInt**\<`BITS`\>(`value`): [`UInt`](UInt.md)\<`BITS`\> + +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) + +#### Parameters + +##### value + +###### value + +`Field` + +#### Returns + +[`UInt`](UInt.md)\<`BITS`\> + +#### Overrides + +`Struct({ value: Field, }).constructor` + +## Properties + +### value + +> **value**: `Field` = `Field` + +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) + +#### Inherited from + +`Struct({ value: Field, }).value` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ value: Field, })._isStruct` + +*** + +### assertionFunction() + +> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` + +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) + +#### Parameters + +##### bool + +`Bool` + +##### msg? + +`string` + +#### Returns + +`void` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### value + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ value: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +`Struct({ value: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +`Struct({ value: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### value + +`string` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +`Struct({ value: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ value: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### value + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ value: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### value + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ value: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ value: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `string` = `Field` + +#### Inherited from + +`Struct({ value: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `bigint` = `Field` + +#### Inherited from + +`Struct({ value: Field, }).toValue` + +## Methods + +### add() + +> **add**(`y`): [`UInt`](UInt.md)\<`BITS`\> + +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) + +Addition with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +[`UInt`](UInt.md)\<`BITS`\> + +*** + +### assertEquals() + +> **assertEquals**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) + +Asserts that a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> + +##### message? + +`string` + +#### Returns + +`void` + +*** + +### assertGreaterThan() + +> **assertGreaterThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) + +Asserts that a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`BITS`\> + +##### message? + +`string` + +#### Returns + +`void` + +*** + +### assertGreaterThanOrEqual() + +> **assertGreaterThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) + +Asserts that a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`BITS`\> + +##### message? + +`string` + +#### Returns + +`void` + +*** + +### assertLessThan() + +> **assertLessThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) + +Asserts that a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`BITS`\> + +##### message? + +`string` + +#### Returns + +`void` + +*** + +### assertLessThanOrEqual() + +> **assertLessThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) + +Asserts that a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`BITS`\> + +##### message? + +`string` + +#### Returns + +`void` + +*** + +### constructorReference() + +> `abstract` **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`BITS`\> + +Defined in: [packages/library/src/math/UInt.ts:91](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L91) + +#### Returns + +[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`BITS`\> + +*** + +### div() + +> **div**(`y`): [`UInt`](UInt.md)\<`BITS`\> + +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) + +Integer division. + +`x.div(y)` returns the floor of `x / y`, that is, the greatest +`z` such that `z * y <= x`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +[`UInt`](UInt.md)\<`BITS`\> + +*** + +### divMod() + +> **divMod**(`divisor`): `object` + +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) + +Integer division with remainder. + +`x.divMod(y)` returns the quotient and the remainder. + +#### Parameters + +##### divisor + +`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +`object` + +##### quotient + +> **quotient**: [`UInt`](UInt.md)\<`BITS`\> + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`BITS`\> + +*** + +### equals() + +> **equals**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) + +Checks if a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +`Bool` + +*** + +### greaterThan() + +> **greaterThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) + +Checks if a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +`Bool` + +*** + +### greaterThanOrEqual() + +> **greaterThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) + +Checks if a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +`Bool` + +*** + +### lessThan() + +> **lessThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) + +Checks if a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +`Bool` + +*** + +### lessThanOrEqual() + +> **lessThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) + +Checks if a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +`Bool` + +*** + +### mod() + +> **mod**(`y`): [`UInt`](UInt.md)\<`BITS`\> + +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) + +Integer remainder. + +`x.mod(y)` returns the value `z` such that `0 <= z < y` and +`x - z` is divisble by `y`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +[`UInt`](UInt.md)\<`BITS`\> + +*** + +### mul() + +> **mul**(`y`): [`UInt`](UInt.md)\<`BITS`\> + +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) + +Multiplication with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +[`UInt`](UInt.md)\<`BITS`\> + +*** + +### numBits() + +> `abstract` **numBits**(): `BITS` + +Defined in: [packages/library/src/math/UInt.ts:89](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L89) + +#### Returns + +`BITS` + +*** + +### sqrtFloor() + +> **sqrtFloor**(): [`UInt`](UInt.md)\<`BITS`\> + +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) + +Wraps sqrtMod() by only returning the sqrt and omitting the rest field. + +#### Returns + +[`UInt`](UInt.md)\<`BITS`\> + +*** + +### sqrtMod() + +> **sqrtMod**(): `object` + +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) + +Implements a non-overflowing square-root with rest. +Normal Field.sqrt() provides the sqrt as it is defined by the finite +field operations. This implementation however mimics the natural-numbers +style of sqrt to be used inside applications with the tradeoff that it +also returns a "rest" that indicates the amount the actual result is off +(since we floor the result to stay inside the ff). + +Some assertions are hard-failing, because they represent malicious +witness values + +#### Returns + +`object` + +sqrt: The non-overflowing sqrt + +rest: The remainder indicating how far off the result +is from the "real" sqrt + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`BITS`\> + +##### sqrt + +> **sqrt**: [`UInt`](UInt.md)\<`BITS`\> + +*** + +### sub() + +> **sub**(`y`): [`UInt`](UInt.md)\<`BITS`\> + +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) + +Subtraction with underflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> + +#### Returns + +[`UInt`](UInt.md)\<`BITS`\> + +*** + +### toBigInt() + +> **toBigInt**(): `bigint` + +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) + +Turns the [UInt](UInt.md) into a BigInt. + +#### Returns + +`bigint` + +*** + +### toO1UInt64() + +> **toO1UInt64**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. + +#### Returns + +`UInt64` + +*** + +### toO1UInt64Clamped() + +> **toO1UInt64Clamped**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), +clamping to the 64 bits range if it's too large. + +#### Returns + +`UInt64` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) + +Turns the [UInt](UInt.md) into a string. + +#### Returns + +`string` + +*** + +### checkConstant() + +> `static` **checkConstant**(`x`, `numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) + +#### Parameters + +##### x + +`Field` + +##### numBits + +`number` + +#### Returns + +`Field` + +*** + +### maxIntField() + +> `static` **maxIntField**(`numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) + +Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. + +#### Parameters + +##### numBits + +`number` + +#### Returns + +`Field` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ value: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/library/classes/UInt112.md b/src/pages/docs/reference/library/classes/UInt112.md new file mode 100644 index 0000000..c6bcc8f --- /dev/null +++ b/src/pages/docs/reference/library/classes/UInt112.md @@ -0,0 +1,1117 @@ +--- +title: UInt112 +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UInt112 + +# Class: UInt112 + +Defined in: [packages/library/src/math/UInt112.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L6) + +UInt is a base class for all soft-failing UInt* implementations. +It has to be overridden for every bitlength that should be available. + +For this, the developer has to create a subclass of UInt implementing the +static methods from interface UIntConstructor + +## Extends + +- [`UInt`](UInt.md)\<`112`\> + +## Constructors + +### new UInt112() + +> **new UInt112**(`value`): [`UInt112`](UInt112.md) + +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) + +#### Parameters + +##### value + +###### value + +`Field` + +#### Returns + +[`UInt112`](UInt112.md) + +#### Inherited from + +[`UInt`](UInt.md).[`constructor`](UInt.md#constructors) + +## Properties + +### value + +> **value**: `Field` = `Field` + +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) + +#### Inherited from + +[`UInt`](UInt.md).[`value`](UInt.md#value-2) + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +[`UInt`](UInt.md).[`_isStruct`](UInt.md#_isstruct) + +*** + +### assertionFunction() + +> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` + +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) + +#### Parameters + +##### bool + +`Bool` + +##### msg? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertionFunction`](UInt.md#assertionfunction) + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`empty`](UInt.md#empty) + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`fromFields`](UInt.md#fromfields) + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### value + +`string` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`fromJSON`](UInt.md#fromjson) + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +[`UInt`](UInt.md).[`fromValue`](UInt.md#fromvalue) + +*** + +### Safe + +> `static` **Safe**: `object` + +Defined in: [packages/library/src/math/UInt112.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L13) + +#### fromField() + +##### Parameters + +###### value + +`Field` + +##### Returns + +[`UInt112`](UInt112.md) + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### value + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +[`UInt`](UInt.md).[`toAuxiliary`](UInt.md#toauxiliary) + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### value + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +[`UInt`](UInt.md).[`toFields`](UInt.md#tofields) + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +[`UInt`](UInt.md).[`toInput`](UInt.md#toinput) + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `string` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`toJSON`](UInt.md#tojson) + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `bigint` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`toValue`](UInt.md#tovalue) + +*** + +### Unsafe + +> `static` **Unsafe**: `object` + +Defined in: [packages/library/src/math/UInt112.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L7) + +#### fromField() + +##### Parameters + +###### value + +`Field` + +##### Returns + +[`UInt112`](UInt112.md) + +## Accessors + +### max + +#### Get Signature + +> **get** `static` **max**(): [`UInt112`](UInt112.md) + +Defined in: [packages/library/src/math/UInt112.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L36) + +##### Returns + +[`UInt112`](UInt112.md) + +*** + +### zero + +#### Get Signature + +> **get** `static` **zero**(): [`UInt112`](UInt112.md) + +Defined in: [packages/library/src/math/UInt112.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L32) + +##### Returns + +[`UInt112`](UInt112.md) + +## Methods + +### add() + +> **add**(`y`): [`UInt`](UInt.md)\<`112`\> + +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) + +Addition with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> + +#### Returns + +[`UInt`](UInt.md)\<`112`\> + +#### Inherited from + +[`UInt`](UInt.md).[`add`](UInt.md#add) + +*** + +### assertEquals() + +> **assertEquals**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) + +Asserts that a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertEquals`](UInt.md#assertequals) + +*** + +### assertGreaterThan() + +> **assertGreaterThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) + +Asserts that a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`112`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertGreaterThan`](UInt.md#assertgreaterthan) + +*** + +### assertGreaterThanOrEqual() + +> **assertGreaterThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) + +Asserts that a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`112`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertGreaterThanOrEqual`](UInt.md#assertgreaterthanorequal) + +*** + +### assertLessThan() + +> **assertLessThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) + +Asserts that a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`112`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertLessThan`](UInt.md#assertlessthan) + +*** + +### assertLessThanOrEqual() + +> **assertLessThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) + +Asserts that a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`112`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertLessThanOrEqual`](UInt.md#assertlessthanorequal) + +*** + +### constructorReference() + +> **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`112`\> + +Defined in: [packages/library/src/math/UInt112.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L40) + +#### Returns + +[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`112`\> + +#### Overrides + +[`UInt`](UInt.md).[`constructorReference`](UInt.md#constructorreference) + +*** + +### div() + +> **div**(`y`): [`UInt`](UInt.md)\<`112`\> + +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) + +Integer division. + +`x.div(y)` returns the floor of `x / y`, that is, the greatest +`z` such that `z * y <= x`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> + +#### Returns + +[`UInt`](UInt.md)\<`112`\> + +#### Inherited from + +[`UInt`](UInt.md).[`div`](UInt.md#div) + +*** + +### divMod() + +> **divMod**(`divisor`): `object` + +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) + +Integer division with remainder. + +`x.divMod(y)` returns the quotient and the remainder. + +#### Parameters + +##### divisor + +`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`112`\> + +#### Returns + +`object` + +##### quotient + +> **quotient**: [`UInt`](UInt.md)\<`112`\> + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`112`\> + +#### Inherited from + +[`UInt`](UInt.md).[`divMod`](UInt.md#divmod) + +*** + +### equals() + +> **equals**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) + +Checks if a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`equals`](UInt.md#equals) + +*** + +### greaterThan() + +> **greaterThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) + +Checks if a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`112`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`greaterThan`](UInt.md#greaterthan) + +*** + +### greaterThanOrEqual() + +> **greaterThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) + +Checks if a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`112`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`greaterThanOrEqual`](UInt.md#greaterthanorequal) + +*** + +### lessThan() + +> **lessThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) + +Checks if a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`112`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`lessThan`](UInt.md#lessthan) + +*** + +### lessThanOrEqual() + +> **lessThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) + +Checks if a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`112`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`lessThanOrEqual`](UInt.md#lessthanorequal) + +*** + +### mod() + +> **mod**(`y`): [`UInt`](UInt.md)\<`112`\> + +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) + +Integer remainder. + +`x.mod(y)` returns the value `z` such that `0 <= z < y` and +`x - z` is divisble by `y`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> + +#### Returns + +[`UInt`](UInt.md)\<`112`\> + +#### Inherited from + +[`UInt`](UInt.md).[`mod`](UInt.md#mod) + +*** + +### mul() + +> **mul**(`y`): [`UInt`](UInt.md)\<`112`\> + +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) + +Multiplication with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> + +#### Returns + +[`UInt`](UInt.md)\<`112`\> + +#### Inherited from + +[`UInt`](UInt.md).[`mul`](UInt.md#mul) + +*** + +### numBits() + +> **numBits**(): `112` + +Defined in: [packages/library/src/math/UInt112.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L44) + +#### Returns + +`112` + +#### Overrides + +[`UInt`](UInt.md).[`numBits`](UInt.md#numbits) + +*** + +### sqrtFloor() + +> **sqrtFloor**(): [`UInt`](UInt.md)\<`112`\> + +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) + +Wraps sqrtMod() by only returning the sqrt and omitting the rest field. + +#### Returns + +[`UInt`](UInt.md)\<`112`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sqrtFloor`](UInt.md#sqrtfloor) + +*** + +### sqrtMod() + +> **sqrtMod**(): `object` + +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) + +Implements a non-overflowing square-root with rest. +Normal Field.sqrt() provides the sqrt as it is defined by the finite +field operations. This implementation however mimics the natural-numbers +style of sqrt to be used inside applications with the tradeoff that it +also returns a "rest" that indicates the amount the actual result is off +(since we floor the result to stay inside the ff). + +Some assertions are hard-failing, because they represent malicious +witness values + +#### Returns + +`object` + +sqrt: The non-overflowing sqrt + +rest: The remainder indicating how far off the result +is from the "real" sqrt + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`112`\> + +##### sqrt + +> **sqrt**: [`UInt`](UInt.md)\<`112`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sqrtMod`](UInt.md#sqrtmod) + +*** + +### sub() + +> **sub**(`y`): [`UInt`](UInt.md)\<`112`\> + +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) + +Subtraction with underflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> + +#### Returns + +[`UInt`](UInt.md)\<`112`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sub`](UInt.md#sub) + +*** + +### toBigInt() + +> **toBigInt**(): `bigint` + +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) + +Turns the [UInt](UInt.md) into a BigInt. + +#### Returns + +`bigint` + +#### Inherited from + +[`UInt`](UInt.md).[`toBigInt`](UInt.md#tobigint) + +*** + +### toO1UInt64() + +> **toO1UInt64**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. + +#### Returns + +`UInt64` + +#### Inherited from + +[`UInt`](UInt.md).[`toO1UInt64`](UInt.md#too1uint64) + +*** + +### toO1UInt64Clamped() + +> **toO1UInt64Clamped**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), +clamping to the 64 bits range if it's too large. + +#### Returns + +`UInt64` + +#### Inherited from + +[`UInt`](UInt.md).[`toO1UInt64Clamped`](UInt.md#too1uint64clamped) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) + +Turns the [UInt](UInt.md) into a string. + +#### Returns + +`string` + +#### Inherited from + +[`UInt`](UInt.md).[`toString`](UInt.md#tostring) + +*** + +### toUInt224() + +> **toUInt224**(): [`UInt224`](UInt224.md) + +Defined in: [packages/library/src/math/UInt112.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L48) + +#### Returns + +[`UInt224`](UInt224.md) + +*** + +### check() + +> `static` **check**(`x`): `void` + +Defined in: [packages/library/src/math/UInt112.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L21) + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### x + +###### value + +`Field` + +#### Returns + +`void` + +#### Overrides + +`UInt.check` + +*** + +### checkConstant() + +> `static` **checkConstant**(`x`, `numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) + +#### Parameters + +##### x + +`Field` + +##### numBits + +`number` + +#### Returns + +`Field` + +#### Inherited from + +[`UInt`](UInt.md).[`checkConstant`](UInt.md#checkconstant) + +*** + +### from() + +> `static` **from**(`x`): [`UInt112`](UInt112.md) + +Defined in: [packages/library/src/math/UInt112.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L25) + +#### Parameters + +##### x + +`string` | `number` | `bigint` | [`UInt112`](UInt112.md) + +#### Returns + +[`UInt112`](UInt112.md) + +*** + +### maxIntField() + +> `static` **maxIntField**(`numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) + +Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. + +#### Parameters + +##### numBits + +`number` + +#### Returns + +`Field` + +#### Inherited from + +[`UInt`](UInt.md).[`maxIntField`](UInt.md#maxintfield) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +[`UInt`](UInt.md).[`sizeInFields`](UInt.md#sizeinfields) diff --git a/src/pages/docs/reference/library/classes/UInt224.md b/src/pages/docs/reference/library/classes/UInt224.md new file mode 100644 index 0000000..920e120 --- /dev/null +++ b/src/pages/docs/reference/library/classes/UInt224.md @@ -0,0 +1,1105 @@ +--- +title: UInt224 +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UInt224 + +# Class: UInt224 + +Defined in: [packages/library/src/math/UInt224.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L5) + +UInt is a base class for all soft-failing UInt* implementations. +It has to be overridden for every bitlength that should be available. + +For this, the developer has to create a subclass of UInt implementing the +static methods from interface UIntConstructor + +## Extends + +- [`UInt`](UInt.md)\<`224`\> + +## Constructors + +### new UInt224() + +> **new UInt224**(`value`): [`UInt224`](UInt224.md) + +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) + +#### Parameters + +##### value + +###### value + +`Field` + +#### Returns + +[`UInt224`](UInt224.md) + +#### Inherited from + +[`UInt`](UInt.md).[`constructor`](UInt.md#constructors) + +## Properties + +### value + +> **value**: `Field` = `Field` + +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) + +#### Inherited from + +[`UInt`](UInt.md).[`value`](UInt.md#value-2) + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +[`UInt`](UInt.md).[`_isStruct`](UInt.md#_isstruct) + +*** + +### assertionFunction() + +> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` + +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) + +#### Parameters + +##### bool + +`Bool` + +##### msg? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertionFunction`](UInt.md#assertionfunction) + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`empty`](UInt.md#empty) + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`fromFields`](UInt.md#fromfields) + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### value + +`string` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`fromJSON`](UInt.md#fromjson) + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +[`UInt`](UInt.md).[`fromValue`](UInt.md#fromvalue) + +*** + +### Safe + +> `static` **Safe**: `object` + +Defined in: [packages/library/src/math/UInt224.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L12) + +#### fromField() + +##### Parameters + +###### value + +`Field` + +##### Returns + +[`UInt224`](UInt224.md) + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### value + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +[`UInt`](UInt.md).[`toAuxiliary`](UInt.md#toauxiliary) + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### value + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +[`UInt`](UInt.md).[`toFields`](UInt.md#tofields) + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +[`UInt`](UInt.md).[`toInput`](UInt.md#toinput) + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `string` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`toJSON`](UInt.md#tojson) + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `bigint` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`toValue`](UInt.md#tovalue) + +*** + +### Unsafe + +> `static` **Unsafe**: `object` + +Defined in: [packages/library/src/math/UInt224.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L6) + +#### fromField() + +##### Parameters + +###### value + +`Field` + +##### Returns + +[`UInt224`](UInt224.md) + +## Accessors + +### max + +#### Get Signature + +> **get** `static` **max**(): [`UInt224`](UInt224.md) + +Defined in: [packages/library/src/math/UInt224.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L35) + +##### Returns + +[`UInt224`](UInt224.md) + +*** + +### zero + +#### Get Signature + +> **get** `static` **zero**(): [`UInt224`](UInt224.md) + +Defined in: [packages/library/src/math/UInt224.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L31) + +##### Returns + +[`UInt224`](UInt224.md) + +## Methods + +### add() + +> **add**(`y`): [`UInt`](UInt.md)\<`224`\> + +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) + +Addition with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> + +#### Returns + +[`UInt`](UInt.md)\<`224`\> + +#### Inherited from + +[`UInt`](UInt.md).[`add`](UInt.md#add) + +*** + +### assertEquals() + +> **assertEquals**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) + +Asserts that a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertEquals`](UInt.md#assertequals) + +*** + +### assertGreaterThan() + +> **assertGreaterThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) + +Asserts that a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`224`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertGreaterThan`](UInt.md#assertgreaterthan) + +*** + +### assertGreaterThanOrEqual() + +> **assertGreaterThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) + +Asserts that a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`224`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertGreaterThanOrEqual`](UInt.md#assertgreaterthanorequal) + +*** + +### assertLessThan() + +> **assertLessThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) + +Asserts that a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`224`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertLessThan`](UInt.md#assertlessthan) + +*** + +### assertLessThanOrEqual() + +> **assertLessThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) + +Asserts that a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`224`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertLessThanOrEqual`](UInt.md#assertlessthanorequal) + +*** + +### constructorReference() + +> **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`224`\> + +Defined in: [packages/library/src/math/UInt224.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L39) + +#### Returns + +[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`224`\> + +#### Overrides + +[`UInt`](UInt.md).[`constructorReference`](UInt.md#constructorreference) + +*** + +### div() + +> **div**(`y`): [`UInt`](UInt.md)\<`224`\> + +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) + +Integer division. + +`x.div(y)` returns the floor of `x / y`, that is, the greatest +`z` such that `z * y <= x`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> + +#### Returns + +[`UInt`](UInt.md)\<`224`\> + +#### Inherited from + +[`UInt`](UInt.md).[`div`](UInt.md#div) + +*** + +### divMod() + +> **divMod**(`divisor`): `object` + +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) + +Integer division with remainder. + +`x.divMod(y)` returns the quotient and the remainder. + +#### Parameters + +##### divisor + +`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`224`\> + +#### Returns + +`object` + +##### quotient + +> **quotient**: [`UInt`](UInt.md)\<`224`\> + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`224`\> + +#### Inherited from + +[`UInt`](UInt.md).[`divMod`](UInt.md#divmod) + +*** + +### equals() + +> **equals**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) + +Checks if a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`equals`](UInt.md#equals) + +*** + +### greaterThan() + +> **greaterThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) + +Checks if a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`224`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`greaterThan`](UInt.md#greaterthan) + +*** + +### greaterThanOrEqual() + +> **greaterThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) + +Checks if a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`224`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`greaterThanOrEqual`](UInt.md#greaterthanorequal) + +*** + +### lessThan() + +> **lessThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) + +Checks if a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`224`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`lessThan`](UInt.md#lessthan) + +*** + +### lessThanOrEqual() + +> **lessThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) + +Checks if a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`224`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`lessThanOrEqual`](UInt.md#lessthanorequal) + +*** + +### mod() + +> **mod**(`y`): [`UInt`](UInt.md)\<`224`\> + +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) + +Integer remainder. + +`x.mod(y)` returns the value `z` such that `0 <= z < y` and +`x - z` is divisble by `y`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> + +#### Returns + +[`UInt`](UInt.md)\<`224`\> + +#### Inherited from + +[`UInt`](UInt.md).[`mod`](UInt.md#mod) + +*** + +### mul() + +> **mul**(`y`): [`UInt`](UInt.md)\<`224`\> + +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) + +Multiplication with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> + +#### Returns + +[`UInt`](UInt.md)\<`224`\> + +#### Inherited from + +[`UInt`](UInt.md).[`mul`](UInt.md#mul) + +*** + +### numBits() + +> **numBits**(): `224` + +Defined in: [packages/library/src/math/UInt224.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L43) + +#### Returns + +`224` + +#### Overrides + +[`UInt`](UInt.md).[`numBits`](UInt.md#numbits) + +*** + +### sqrtFloor() + +> **sqrtFloor**(): [`UInt`](UInt.md)\<`224`\> + +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) + +Wraps sqrtMod() by only returning the sqrt and omitting the rest field. + +#### Returns + +[`UInt`](UInt.md)\<`224`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sqrtFloor`](UInt.md#sqrtfloor) + +*** + +### sqrtMod() + +> **sqrtMod**(): `object` + +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) + +Implements a non-overflowing square-root with rest. +Normal Field.sqrt() provides the sqrt as it is defined by the finite +field operations. This implementation however mimics the natural-numbers +style of sqrt to be used inside applications with the tradeoff that it +also returns a "rest" that indicates the amount the actual result is off +(since we floor the result to stay inside the ff). + +Some assertions are hard-failing, because they represent malicious +witness values + +#### Returns + +`object` + +sqrt: The non-overflowing sqrt + +rest: The remainder indicating how far off the result +is from the "real" sqrt + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`224`\> + +##### sqrt + +> **sqrt**: [`UInt`](UInt.md)\<`224`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sqrtMod`](UInt.md#sqrtmod) + +*** + +### sub() + +> **sub**(`y`): [`UInt`](UInt.md)\<`224`\> + +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) + +Subtraction with underflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> + +#### Returns + +[`UInt`](UInt.md)\<`224`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sub`](UInt.md#sub) + +*** + +### toBigInt() + +> **toBigInt**(): `bigint` + +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) + +Turns the [UInt](UInt.md) into a BigInt. + +#### Returns + +`bigint` + +#### Inherited from + +[`UInt`](UInt.md).[`toBigInt`](UInt.md#tobigint) + +*** + +### toO1UInt64() + +> **toO1UInt64**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. + +#### Returns + +`UInt64` + +#### Inherited from + +[`UInt`](UInt.md).[`toO1UInt64`](UInt.md#too1uint64) + +*** + +### toO1UInt64Clamped() + +> **toO1UInt64Clamped**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), +clamping to the 64 bits range if it's too large. + +#### Returns + +`UInt64` + +#### Inherited from + +[`UInt`](UInt.md).[`toO1UInt64Clamped`](UInt.md#too1uint64clamped) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) + +Turns the [UInt](UInt.md) into a string. + +#### Returns + +`string` + +#### Inherited from + +[`UInt`](UInt.md).[`toString`](UInt.md#tostring) + +*** + +### check() + +> `static` **check**(`x`): `void` + +Defined in: [packages/library/src/math/UInt224.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L20) + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### x + +###### value + +`Field` + +#### Returns + +`void` + +#### Overrides + +`UInt.check` + +*** + +### checkConstant() + +> `static` **checkConstant**(`x`, `numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) + +#### Parameters + +##### x + +`Field` + +##### numBits + +`number` + +#### Returns + +`Field` + +#### Inherited from + +[`UInt`](UInt.md).[`checkConstant`](UInt.md#checkconstant) + +*** + +### from() + +> `static` **from**(`x`): [`UInt224`](UInt224.md) + +Defined in: [packages/library/src/math/UInt224.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L24) + +#### Parameters + +##### x + +`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`224`\> + +#### Returns + +[`UInt224`](UInt224.md) + +*** + +### maxIntField() + +> `static` **maxIntField**(`numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) + +Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. + +#### Parameters + +##### numBits + +`number` + +#### Returns + +`Field` + +#### Inherited from + +[`UInt`](UInt.md).[`maxIntField`](UInt.md#maxintfield) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +[`UInt`](UInt.md).[`sizeInFields`](UInt.md#sizeinfields) diff --git a/src/pages/docs/reference/library/classes/UInt32.md b/src/pages/docs/reference/library/classes/UInt32.md new file mode 100644 index 0000000..3a54029 --- /dev/null +++ b/src/pages/docs/reference/library/classes/UInt32.md @@ -0,0 +1,1117 @@ +--- +title: UInt32 +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UInt32 + +# Class: UInt32 + +Defined in: [packages/library/src/math/UInt32.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L6) + +UInt is a base class for all soft-failing UInt* implementations. +It has to be overridden for every bitlength that should be available. + +For this, the developer has to create a subclass of UInt implementing the +static methods from interface UIntConstructor + +## Extends + +- [`UInt`](UInt.md)\<`32`\> + +## Constructors + +### new UInt32() + +> **new UInt32**(`value`): [`UInt32`](UInt32.md) + +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) + +#### Parameters + +##### value + +###### value + +`Field` + +#### Returns + +[`UInt32`](UInt32.md) + +#### Inherited from + +[`UInt`](UInt.md).[`constructor`](UInt.md#constructors) + +## Properties + +### value + +> **value**: `Field` = `Field` + +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) + +#### Inherited from + +[`UInt`](UInt.md).[`value`](UInt.md#value-2) + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +[`UInt`](UInt.md).[`_isStruct`](UInt.md#_isstruct) + +*** + +### assertionFunction() + +> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` + +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) + +#### Parameters + +##### bool + +`Bool` + +##### msg? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertionFunction`](UInt.md#assertionfunction) + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`empty`](UInt.md#empty) + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`fromFields`](UInt.md#fromfields) + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### value + +`string` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`fromJSON`](UInt.md#fromjson) + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +[`UInt`](UInt.md).[`fromValue`](UInt.md#fromvalue) + +*** + +### Safe + +> `static` **Safe**: `object` + +Defined in: [packages/library/src/math/UInt32.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L13) + +#### fromField() + +##### Parameters + +###### value + +`Field` + +##### Returns + +[`UInt32`](UInt32.md) + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### value + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +[`UInt`](UInt.md).[`toAuxiliary`](UInt.md#toauxiliary) + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### value + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +[`UInt`](UInt.md).[`toFields`](UInt.md#tofields) + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +[`UInt`](UInt.md).[`toInput`](UInt.md#toinput) + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `string` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`toJSON`](UInt.md#tojson) + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `bigint` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`toValue`](UInt.md#tovalue) + +*** + +### Unsafe + +> `static` **Unsafe**: `object` + +Defined in: [packages/library/src/math/UInt32.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L7) + +#### fromField() + +##### Parameters + +###### value + +`Field` + +##### Returns + +[`UInt32`](UInt32.md) + +## Accessors + +### max + +#### Get Signature + +> **get** `static` **max**(): [`UInt32`](UInt32.md) + +Defined in: [packages/library/src/math/UInt32.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L36) + +##### Returns + +[`UInt32`](UInt32.md) + +*** + +### zero + +#### Get Signature + +> **get** `static` **zero**(): [`UInt32`](UInt32.md) + +Defined in: [packages/library/src/math/UInt32.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L32) + +##### Returns + +[`UInt32`](UInt32.md) + +## Methods + +### add() + +> **add**(`y`): [`UInt`](UInt.md)\<`32`\> + +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) + +Addition with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> + +#### Returns + +[`UInt`](UInt.md)\<`32`\> + +#### Inherited from + +[`UInt`](UInt.md).[`add`](UInt.md#add) + +*** + +### assertEquals() + +> **assertEquals**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) + +Asserts that a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertEquals`](UInt.md#assertequals) + +*** + +### assertGreaterThan() + +> **assertGreaterThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) + +Asserts that a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`32`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertGreaterThan`](UInt.md#assertgreaterthan) + +*** + +### assertGreaterThanOrEqual() + +> **assertGreaterThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) + +Asserts that a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`32`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertGreaterThanOrEqual`](UInt.md#assertgreaterthanorequal) + +*** + +### assertLessThan() + +> **assertLessThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) + +Asserts that a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`32`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertLessThan`](UInt.md#assertlessthan) + +*** + +### assertLessThanOrEqual() + +> **assertLessThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) + +Asserts that a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`32`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertLessThanOrEqual`](UInt.md#assertlessthanorequal) + +*** + +### constructorReference() + +> **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`32`\> + +Defined in: [packages/library/src/math/UInt32.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L40) + +#### Returns + +[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`32`\> + +#### Overrides + +[`UInt`](UInt.md).[`constructorReference`](UInt.md#constructorreference) + +*** + +### div() + +> **div**(`y`): [`UInt`](UInt.md)\<`32`\> + +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) + +Integer division. + +`x.div(y)` returns the floor of `x / y`, that is, the greatest +`z` such that `z * y <= x`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> + +#### Returns + +[`UInt`](UInt.md)\<`32`\> + +#### Inherited from + +[`UInt`](UInt.md).[`div`](UInt.md#div) + +*** + +### divMod() + +> **divMod**(`divisor`): `object` + +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) + +Integer division with remainder. + +`x.divMod(y)` returns the quotient and the remainder. + +#### Parameters + +##### divisor + +`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`32`\> + +#### Returns + +`object` + +##### quotient + +> **quotient**: [`UInt`](UInt.md)\<`32`\> + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`32`\> + +#### Inherited from + +[`UInt`](UInt.md).[`divMod`](UInt.md#divmod) + +*** + +### equals() + +> **equals**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) + +Checks if a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`equals`](UInt.md#equals) + +*** + +### greaterThan() + +> **greaterThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) + +Checks if a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`32`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`greaterThan`](UInt.md#greaterthan) + +*** + +### greaterThanOrEqual() + +> **greaterThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) + +Checks if a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`32`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`greaterThanOrEqual`](UInt.md#greaterthanorequal) + +*** + +### lessThan() + +> **lessThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) + +Checks if a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`32`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`lessThan`](UInt.md#lessthan) + +*** + +### lessThanOrEqual() + +> **lessThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) + +Checks if a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`32`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`lessThanOrEqual`](UInt.md#lessthanorequal) + +*** + +### mod() + +> **mod**(`y`): [`UInt`](UInt.md)\<`32`\> + +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) + +Integer remainder. + +`x.mod(y)` returns the value `z` such that `0 <= z < y` and +`x - z` is divisble by `y`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> + +#### Returns + +[`UInt`](UInt.md)\<`32`\> + +#### Inherited from + +[`UInt`](UInt.md).[`mod`](UInt.md#mod) + +*** + +### mul() + +> **mul**(`y`): [`UInt`](UInt.md)\<`32`\> + +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) + +Multiplication with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> + +#### Returns + +[`UInt`](UInt.md)\<`32`\> + +#### Inherited from + +[`UInt`](UInt.md).[`mul`](UInt.md#mul) + +*** + +### numBits() + +> **numBits**(): `32` + +Defined in: [packages/library/src/math/UInt32.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L44) + +#### Returns + +`32` + +#### Overrides + +[`UInt`](UInt.md).[`numBits`](UInt.md#numbits) + +*** + +### sqrtFloor() + +> **sqrtFloor**(): [`UInt`](UInt.md)\<`32`\> + +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) + +Wraps sqrtMod() by only returning the sqrt and omitting the rest field. + +#### Returns + +[`UInt`](UInt.md)\<`32`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sqrtFloor`](UInt.md#sqrtfloor) + +*** + +### sqrtMod() + +> **sqrtMod**(): `object` + +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) + +Implements a non-overflowing square-root with rest. +Normal Field.sqrt() provides the sqrt as it is defined by the finite +field operations. This implementation however mimics the natural-numbers +style of sqrt to be used inside applications with the tradeoff that it +also returns a "rest" that indicates the amount the actual result is off +(since we floor the result to stay inside the ff). + +Some assertions are hard-failing, because they represent malicious +witness values + +#### Returns + +`object` + +sqrt: The non-overflowing sqrt + +rest: The remainder indicating how far off the result +is from the "real" sqrt + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`32`\> + +##### sqrt + +> **sqrt**: [`UInt`](UInt.md)\<`32`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sqrtMod`](UInt.md#sqrtmod) + +*** + +### sub() + +> **sub**(`y`): [`UInt`](UInt.md)\<`32`\> + +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) + +Subtraction with underflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> + +#### Returns + +[`UInt`](UInt.md)\<`32`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sub`](UInt.md#sub) + +*** + +### toBigInt() + +> **toBigInt**(): `bigint` + +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) + +Turns the [UInt](UInt.md) into a BigInt. + +#### Returns + +`bigint` + +#### Inherited from + +[`UInt`](UInt.md).[`toBigInt`](UInt.md#tobigint) + +*** + +### toO1UInt64() + +> **toO1UInt64**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. + +#### Returns + +`UInt64` + +#### Inherited from + +[`UInt`](UInt.md).[`toO1UInt64`](UInt.md#too1uint64) + +*** + +### toO1UInt64Clamped() + +> **toO1UInt64Clamped**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), +clamping to the 64 bits range if it's too large. + +#### Returns + +`UInt64` + +#### Inherited from + +[`UInt`](UInt.md).[`toO1UInt64Clamped`](UInt.md#too1uint64clamped) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) + +Turns the [UInt](UInt.md) into a string. + +#### Returns + +`string` + +#### Inherited from + +[`UInt`](UInt.md).[`toString`](UInt.md#tostring) + +*** + +### toUInt64() + +> **toUInt64**(): [`UInt64`](UInt64.md) + +Defined in: [packages/library/src/math/UInt32.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L48) + +#### Returns + +[`UInt64`](UInt64.md) + +*** + +### check() + +> `static` **check**(`x`): `void` + +Defined in: [packages/library/src/math/UInt32.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L21) + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### x + +###### value + +`Field` + +#### Returns + +`void` + +#### Overrides + +`UInt.check` + +*** + +### checkConstant() + +> `static` **checkConstant**(`x`, `numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) + +#### Parameters + +##### x + +`Field` + +##### numBits + +`number` + +#### Returns + +`Field` + +#### Inherited from + +[`UInt`](UInt.md).[`checkConstant`](UInt.md#checkconstant) + +*** + +### from() + +> `static` **from**(`x`): [`UInt32`](UInt32.md) + +Defined in: [packages/library/src/math/UInt32.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L25) + +#### Parameters + +##### x + +`string` | `number` | `bigint` | [`UInt32`](UInt32.md) + +#### Returns + +[`UInt32`](UInt32.md) + +*** + +### maxIntField() + +> `static` **maxIntField**(`numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) + +Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. + +#### Parameters + +##### numBits + +`number` + +#### Returns + +`Field` + +#### Inherited from + +[`UInt`](UInt.md).[`maxIntField`](UInt.md#maxintfield) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +[`UInt`](UInt.md).[`sizeInFields`](UInt.md#sizeinfields) diff --git a/src/pages/docs/reference/library/classes/UInt64.md b/src/pages/docs/reference/library/classes/UInt64.md new file mode 100644 index 0000000..71f6946 --- /dev/null +++ b/src/pages/docs/reference/library/classes/UInt64.md @@ -0,0 +1,1109 @@ +--- +title: UInt64 +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UInt64 + +# Class: UInt64 + +Defined in: [packages/library/src/math/UInt64.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L5) + +UInt is a base class for all soft-failing UInt* implementations. +It has to be overridden for every bitlength that should be available. + +For this, the developer has to create a subclass of UInt implementing the +static methods from interface UIntConstructor + +## Extends + +- [`UInt`](UInt.md)\<`64`\> + +## Extended by + +- [`Balance`](Balance.md) + +## Constructors + +### new UInt64() + +> **new UInt64**(`value`): [`UInt64`](UInt64.md) + +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) + +#### Parameters + +##### value + +###### value + +`Field` + +#### Returns + +[`UInt64`](UInt64.md) + +#### Inherited from + +[`UInt`](UInt.md).[`constructor`](UInt.md#constructors) + +## Properties + +### value + +> **value**: `Field` = `Field` + +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) + +#### Inherited from + +[`UInt`](UInt.md).[`value`](UInt.md#value-2) + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +[`UInt`](UInt.md).[`_isStruct`](UInt.md#_isstruct) + +*** + +### assertionFunction() + +> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` + +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) + +#### Parameters + +##### bool + +`Bool` + +##### msg? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertionFunction`](UInt.md#assertionfunction) + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`empty`](UInt.md#empty) + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`fromFields`](UInt.md#fromfields) + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### value + +`string` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`fromJSON`](UInt.md#fromjson) + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +[`UInt`](UInt.md).[`fromValue`](UInt.md#fromvalue) + +*** + +### Safe + +> `static` **Safe**: `object` + +Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L12) + +#### fromField() + +##### Parameters + +###### value + +`Field` + +##### Returns + +[`UInt64`](UInt64.md) + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### value + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +[`UInt`](UInt.md).[`toAuxiliary`](UInt.md#toauxiliary) + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### value + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +[`UInt`](UInt.md).[`toFields`](UInt.md#tofields) + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +[`UInt`](UInt.md).[`toInput`](UInt.md#toinput) + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `string` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`toJSON`](UInt.md#tojson) + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### value + +> **value**: `bigint` = `Field` + +#### Inherited from + +[`UInt`](UInt.md).[`toValue`](UInt.md#tovalue) + +*** + +### Unsafe + +> `static` **Unsafe**: `object` + +Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L6) + +#### fromField() + +##### Parameters + +###### value + +`Field` + +##### Returns + +[`UInt64`](UInt64.md) + +## Accessors + +### max + +#### Get Signature + +> **get** `static` **max**(): [`UInt64`](UInt64.md) + +Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L35) + +##### Returns + +[`UInt64`](UInt64.md) + +*** + +### zero + +#### Get Signature + +> **get** `static` **zero**(): [`UInt64`](UInt64.md) + +Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L31) + +##### Returns + +[`UInt64`](UInt64.md) + +## Methods + +### add() + +> **add**(`y`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) + +Addition with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt`](UInt.md).[`add`](UInt.md#add) + +*** + +### assertEquals() + +> **assertEquals**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) + +Asserts that a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertEquals`](UInt.md#assertequals) + +*** + +### assertGreaterThan() + +> **assertGreaterThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) + +Asserts that a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertGreaterThan`](UInt.md#assertgreaterthan) + +*** + +### assertGreaterThanOrEqual() + +> **assertGreaterThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) + +Asserts that a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertGreaterThanOrEqual`](UInt.md#assertgreaterthanorequal) + +*** + +### assertLessThan() + +> **assertLessThan**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) + +Asserts that a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertLessThan`](UInt.md#assertlessthan) + +*** + +### assertLessThanOrEqual() + +> **assertLessThanOrEqual**(`y`, `message`?): `void` + +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) + +Asserts that a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +##### message? + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`UInt`](UInt.md).[`assertLessThanOrEqual`](UInt.md#assertlessthanorequal) + +*** + +### constructorReference() + +> **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L39) + +#### Returns + +[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> + +#### Overrides + +[`UInt`](UInt.md).[`constructorReference`](UInt.md#constructorreference) + +*** + +### div() + +> **div**(`y`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) + +Integer division. + +`x.div(y)` returns the floor of `x / y`, that is, the greatest +`z` such that `z * y <= x`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt`](UInt.md).[`div`](UInt.md#div) + +*** + +### divMod() + +> **divMod**(`divisor`): `object` + +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) + +Integer division with remainder. + +`x.divMod(y)` returns the quotient and the remainder. + +#### Parameters + +##### divisor + +`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +`object` + +##### quotient + +> **quotient**: [`UInt`](UInt.md)\<`64`\> + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt`](UInt.md).[`divMod`](UInt.md#divmod) + +*** + +### equals() + +> **equals**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) + +Checks if a [UInt](UInt.md) is equal to another one. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`equals`](UInt.md#equals) + +*** + +### greaterThan() + +> **greaterThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) + +Checks if a [UInt](UInt.md) is greater than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`greaterThan`](UInt.md#greaterthan) + +*** + +### greaterThanOrEqual() + +> **greaterThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) + +Checks if a [UInt](UInt.md) is greater than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`greaterThanOrEqual`](UInt.md#greaterthanorequal) + +*** + +### lessThan() + +> **lessThan**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) + +Checks if a [UInt](UInt.md) is less than another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`lessThan`](UInt.md#lessthan) + +*** + +### lessThanOrEqual() + +> **lessThanOrEqual**(`y`): `Bool` + +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) + +Checks if a [UInt](UInt.md) is less than or equal to another one. + +#### Parameters + +##### y + +[`UInt`](UInt.md)\<`64`\> + +#### Returns + +`Bool` + +#### Inherited from + +[`UInt`](UInt.md).[`lessThanOrEqual`](UInt.md#lessthanorequal) + +*** + +### mod() + +> **mod**(`y`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) + +Integer remainder. + +`x.mod(y)` returns the value `z` such that `0 <= z < y` and +`x - z` is divisble by `y`. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt`](UInt.md).[`mod`](UInt.md#mod) + +*** + +### mul() + +> **mul**(`y`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) + +Multiplication with overflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt`](UInt.md).[`mul`](UInt.md#mul) + +*** + +### numBits() + +> **numBits**(): `64` + +Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L43) + +#### Returns + +`64` + +#### Overrides + +[`UInt`](UInt.md).[`numBits`](UInt.md#numbits) + +*** + +### sqrtFloor() + +> **sqrtFloor**(): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) + +Wraps sqrtMod() by only returning the sqrt and omitting the rest field. + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sqrtFloor`](UInt.md#sqrtfloor) + +*** + +### sqrtMod() + +> **sqrtMod**(): `object` + +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) + +Implements a non-overflowing square-root with rest. +Normal Field.sqrt() provides the sqrt as it is defined by the finite +field operations. This implementation however mimics the natural-numbers +style of sqrt to be used inside applications with the tradeoff that it +also returns a "rest" that indicates the amount the actual result is off +(since we floor the result to stay inside the ff). + +Some assertions are hard-failing, because they represent malicious +witness values + +#### Returns + +`object` + +sqrt: The non-overflowing sqrt + +rest: The remainder indicating how far off the result +is from the "real" sqrt + +##### rest + +> **rest**: [`UInt`](UInt.md)\<`64`\> + +##### sqrt + +> **sqrt**: [`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sqrtMod`](UInt.md#sqrtmod) + +*** + +### sub() + +> **sub**(`y`): [`UInt`](UInt.md)\<`64`\> + +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) + +Subtraction with underflow checking. + +#### Parameters + +##### y + +`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> + +#### Returns + +[`UInt`](UInt.md)\<`64`\> + +#### Inherited from + +[`UInt`](UInt.md).[`sub`](UInt.md#sub) + +*** + +### toBigInt() + +> **toBigInt**(): `bigint` + +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) + +Turns the [UInt](UInt.md) into a BigInt. + +#### Returns + +`bigint` + +#### Inherited from + +[`UInt`](UInt.md).[`toBigInt`](UInt.md#tobigint) + +*** + +### toO1UInt64() + +> **toO1UInt64**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. + +#### Returns + +`UInt64` + +#### Inherited from + +[`UInt`](UInt.md).[`toO1UInt64`](UInt.md#too1uint64) + +*** + +### toO1UInt64Clamped() + +> **toO1UInt64Clamped**(): `UInt64` + +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) + +Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), +clamping to the 64 bits range if it's too large. + +#### Returns + +`UInt64` + +#### Inherited from + +[`UInt`](UInt.md).[`toO1UInt64Clamped`](UInt.md#too1uint64clamped) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) + +Turns the [UInt](UInt.md) into a string. + +#### Returns + +`string` + +#### Inherited from + +[`UInt`](UInt.md).[`toString`](UInt.md#tostring) + +*** + +### check() + +> `static` **check**(`x`): `void` + +Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L20) + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### x + +###### value + +`Field` + +#### Returns + +`void` + +#### Overrides + +`UInt.check` + +*** + +### checkConstant() + +> `static` **checkConstant**(`x`, `numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) + +#### Parameters + +##### x + +`Field` + +##### numBits + +`number` + +#### Returns + +`Field` + +#### Inherited from + +[`UInt`](UInt.md).[`checkConstant`](UInt.md#checkconstant) + +*** + +### from() + +> `static` **from**(`x`): [`UInt64`](UInt64.md) + +Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L24) + +#### Parameters + +##### x + +`string` | `number` | `bigint` | [`UInt64`](UInt64.md) + +#### Returns + +[`UInt64`](UInt64.md) + +*** + +### maxIntField() + +> `static` **maxIntField**(`numBits`): `Field` + +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) + +Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. + +#### Parameters + +##### numBits + +`number` + +#### Returns + +`Field` + +#### Inherited from + +[`UInt`](UInt.md).[`maxIntField`](UInt.md#maxintfield) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +[`UInt`](UInt.md).[`sizeInFields`](UInt.md#sizeinfields) diff --git a/src/pages/docs/reference/library/classes/VanillaProtocolModules.md b/src/pages/docs/reference/library/classes/VanillaProtocolModules.md new file mode 100644 index 0000000..86c6407 --- /dev/null +++ b/src/pages/docs/reference/library/classes/VanillaProtocolModules.md @@ -0,0 +1,155 @@ +--- +title: VanillaProtocolModules +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / VanillaProtocolModules + +# Class: VanillaProtocolModules + +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L18) + +## Constructors + +### new VanillaProtocolModules() + +> **new VanillaProtocolModules**(): [`VanillaProtocolModules`](VanillaProtocolModules.md) + +#### Returns + +[`VanillaProtocolModules`](VanillaProtocolModules.md) + +## Methods + +### defaultConfig() + +> `static` **defaultConfig**(): `object` + +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L51) + +#### Returns + +`object` + +##### AccountState + +> **AccountState**: `object` = `{}` + +##### BlockHeight + +> **BlockHeight**: `object` = `{}` + +##### BlockProver + +> **BlockProver**: `object` = `{}` + +##### LastStateRoot + +> **LastStateRoot**: `object` = `{}` + +##### StateTransitionProver + +> **StateTransitionProver**: `object` = `{}` + +##### TransactionFee + +> **TransactionFee**: `object` + +###### TransactionFee.baseFee + +> **TransactionFee.baseFee**: `bigint` = `0n` + +###### TransactionFee.feeRecipient + +> **TransactionFee.feeRecipient**: `string` + +###### TransactionFee.methods + +> **TransactionFee.methods**: `object` = `{}` + +###### TransactionFee.perWeightUnitFee + +> **TransactionFee.perWeightUnitFee**: `bigint` = `0n` + +###### TransactionFee.tokenId + +> **TransactionFee.tokenId**: `bigint` = `0n` + +*** + +### mandatoryConfig() + +> `static` **mandatoryConfig**(): `object` + +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L41) + +#### Returns + +`object` + +##### AccountState + +> **AccountState**: `object` = `{}` + +##### BlockHeight + +> **BlockHeight**: `object` = `{}` + +##### BlockProver + +> **BlockProver**: `object` = `{}` + +##### LastStateRoot + +> **LastStateRoot**: `object` = `{}` + +##### StateTransitionProver + +> **StateTransitionProver**: `object` = `{}` + +*** + +### mandatoryModules() + +> `static` **mandatoryModules**\<`ProtocolModules`\>(`additionalModules`): [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `ProtocolModules` + +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L19) + +#### Type Parameters + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) + +#### Parameters + +##### additionalModules + +`ProtocolModules` + +#### Returns + +[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `ProtocolModules` + +*** + +### with() + +> `static` **with**\<`ProtocolModules`\>(`additionalModules`): [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object` & `ProtocolModules` + +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L32) + +#### Type Parameters + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) + +#### Parameters + +##### additionalModules + +`ProtocolModules` + +#### Returns + +[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object` & `ProtocolModules` diff --git a/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md b/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md new file mode 100644 index 0000000..ebede92 --- /dev/null +++ b/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md @@ -0,0 +1,61 @@ +--- +title: VanillaRuntimeModules +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / VanillaRuntimeModules + +# Class: VanillaRuntimeModules + +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/VanillaRuntimeModules.ts#L10) + +## Constructors + +### new VanillaRuntimeModules() + +> **new VanillaRuntimeModules**(): [`VanillaRuntimeModules`](VanillaRuntimeModules.md) + +#### Returns + +[`VanillaRuntimeModules`](VanillaRuntimeModules.md) + +## Methods + +### defaultConfig() + +> `static` **defaultConfig**(): `object` + +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/VanillaRuntimeModules.ts#L20) + +#### Returns + +`object` + +##### Balances + +> **Balances**: `object` = `{}` + +*** + +### with() + +> `static` **with**\<`RuntimeModules`\>(`additionalModules`): `object` & `RuntimeModules` + +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/VanillaRuntimeModules.ts#L11) + +#### Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +#### Parameters + +##### additionalModules + +`RuntimeModules` + +#### Returns + +`object` & `RuntimeModules` diff --git a/src/pages/docs/reference/library/classes/WithdrawalEvent.md b/src/pages/docs/reference/library/classes/WithdrawalEvent.md new file mode 100644 index 0000000..766e336 --- /dev/null +++ b/src/pages/docs/reference/library/classes/WithdrawalEvent.md @@ -0,0 +1,489 @@ +--- +title: WithdrawalEvent +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / WithdrawalEvent + +# Class: WithdrawalEvent + +Defined in: [packages/library/src/runtime/Withdrawals.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L20) + +## Extends + +- `object` + +## Constructors + +### new WithdrawalEvent() + +> **new WithdrawalEvent**(`value`): [`WithdrawalEvent`](WithdrawalEvent.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +[`WithdrawalEvent`](WithdrawalEvent.md) + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).constructor` + +## Properties + +### key + +> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +Defined in: [packages/library/src/runtime/Withdrawals.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L21) + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).key` + +*** + +### value + +> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +Defined in: [packages/library/src/runtime/Withdrawals.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L22) + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).value` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### key + +> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +##### value + +> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### key + +> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +##### value + +> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### key + +\{ `index`: `string`; `tokenId`: `string`; \} = `WithdrawalKey` + +###### key.index + +`string` = `Field` + +###### key.tokenId + +`string` = `Field` + +###### value + +\{ `address`: `string`; `amount`: `string`; `tokenId`: `string`; \} = `Withdrawal` + +###### value.address + +`string` + +###### value.amount + +`string` + +###### value.tokenId + +`string` + +#### Returns + +`object` + +##### key + +> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +##### value + +> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`object` + +##### key + +> **key**: `object` = `WithdrawalKey` + +###### key.index + +> **key.index**: `string` = `Field` + +###### key.tokenId + +> **key.tokenId**: `string` = `Field` + +##### value + +> **value**: `object` = `Withdrawal` + +###### value.address + +> **value.address**: `string` + +###### value.amount + +> **value.amount**: `string` + +###### value.tokenId + +> **value.tokenId**: `string` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`object` + +##### key + +> **key**: `object` = `WithdrawalKey` + +###### key.index + +> **key.index**: `bigint` = `Field` + +###### key.tokenId + +> **key.tokenId**: `bigint` = `Field` + +##### value + +> **value**: `object` = `Withdrawal` + +###### value.address + +> **value.address**: `object` + +###### value.address.isOdd + +> **value.address.isOdd**: `boolean` + +###### value.address.x + +> **value.address.x**: `bigint` + +###### value.amount + +> **value.amount**: `bigint` + +###### value.tokenId + +> **value.tokenId**: `bigint` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).sizeInFields` diff --git a/src/pages/docs/reference/library/classes/WithdrawalKey.md b/src/pages/docs/reference/library/classes/WithdrawalKey.md new file mode 100644 index 0000000..3dbbf2a --- /dev/null +++ b/src/pages/docs/reference/library/classes/WithdrawalKey.md @@ -0,0 +1,421 @@ +--- +title: WithdrawalKey +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / WithdrawalKey + +# Class: WithdrawalKey + +Defined in: [packages/library/src/runtime/Withdrawals.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L15) + +## Extends + +- `object` + +## Constructors + +### new WithdrawalKey() + +> **new WithdrawalKey**(`value`): [`WithdrawalKey`](WithdrawalKey.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +[`WithdrawalKey`](WithdrawalKey.md) + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).constructor` + +## Properties + +### index + +> **index**: `Field` = `Field` + +Defined in: [packages/library/src/runtime/Withdrawals.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L16) + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).index` + +*** + +### tokenId + +> **tokenId**: `Field` = `Field` + +Defined in: [packages/library/src/runtime/Withdrawals.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L17) + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).tokenId` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### index + +`string` = `Field` + +###### tokenId + +`string` = `Field` + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### index + +> **index**: `string` = `Field` + +##### tokenId + +> **tokenId**: `string` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### index + +> **index**: `bigint` = `Field` + +##### tokenId + +> **tokenId**: `bigint` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/library/classes/Withdrawals.md b/src/pages/docs/reference/library/classes/Withdrawals.md new file mode 100644 index 0000000..f407e0f --- /dev/null +++ b/src/pages/docs/reference/library/classes/Withdrawals.md @@ -0,0 +1,302 @@ +--- +title: Withdrawals +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / Withdrawals + +# Class: Withdrawals + +Defined in: [packages/library/src/runtime/Withdrawals.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L26) + +Base class for runtime modules providing the necessary utilities. + +## Extends + +- [`RuntimeModule`](../../module/classes/RuntimeModule.md) + +## Constructors + +### new Withdrawals() + +> **new Withdrawals**(`balances`): [`Withdrawals`](Withdrawals.md) + +Defined in: [packages/library/src/runtime/Withdrawals.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L38) + +#### Parameters + +##### balances + +[`Balances`](Balances.md) + +#### Returns + +[`Withdrawals`](Withdrawals.md) + +#### Overrides + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`constructor`](../../module/classes/RuntimeModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`currentConfig`](../../module/classes/RuntimeModule.md#currentconfig) + +*** + +### events + +> **events**: [`RuntimeEvents`](../../module/classes/RuntimeEvents.md)\<\{ `withdrawal`: *typeof* [`WithdrawalEvent`](WithdrawalEvent.md); \}\> + +Defined in: [packages/library/src/runtime/Withdrawals.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L27) + +#### Overrides + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`events`](../../module/classes/RuntimeModule.md#events) + +*** + +### isRuntimeModule + +> **isRuntimeModule**: `boolean` + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:27 + +This property exists only to typecheck that the RuntimeModule +was extended correctly in e.g. a decorator. We need at least +one non-optional property in this class to make the typechecking work. + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`isRuntimeModule`](../../module/classes/RuntimeModule.md#isruntimemodule) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:28 + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`name`](../../module/classes/RuntimeModule.md#name) + +*** + +### runtime? + +> `optional` **runtime**: [`RuntimeEnvironment`](../../module/interfaces/RuntimeEnvironment.md) + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:29 + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`runtime`](../../module/classes/RuntimeModule.md#runtime) + +*** + +### runtimeMethodNames + +> `readonly` **runtimeMethodNames**: `string`[] + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:21 + +Holds all method names that are callable throw transactions + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`runtimeMethodNames`](../../module/classes/RuntimeModule.md#runtimemethodnames) + +*** + +### withdrawalCounters + +> **withdrawalCounters**: [`StateMap`](../../protocol/classes/StateMap.md)\<`Field`, `Field`\> + +Defined in: [packages/library/src/runtime/Withdrawals.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L31) + +*** + +### withdrawals + +> **withdrawals**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`WithdrawalKey`](WithdrawalKey.md), [`Withdrawal`](../../protocol/classes/Withdrawal.md)\> + +Defined in: [packages/library/src/runtime/Withdrawals.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L33) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:17 + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`presets`](../../module/classes/RuntimeModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`config`](../../module/classes/RuntimeModule.md#config) + +*** + +### network + +#### Get Signature + +> **get** **network**(): [`NetworkState`](../../protocol/classes/NetworkState.md) + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:34 + +##### Returns + +[`NetworkState`](../../protocol/classes/NetworkState.md) + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`network`](../../module/classes/RuntimeModule.md#network) + +*** + +### transaction + +#### Get Signature + +> **get** **transaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:33 + +##### Returns + +[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`transaction`](../../module/classes/RuntimeModule.md#transaction) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`create`](../../module/classes/RuntimeModule.md#create) + +*** + +### getInputs() + +> **getInputs**(): [`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) + +Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:32 + +#### Returns + +[`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) + +#### Inherited from + +[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`getInputs`](../../module/classes/RuntimeModule.md#getinputs) + +*** + +### queueWithdrawal() + +> `protected` **queueWithdrawal**(`withdrawal`): `Promise`\<`void`\> + +Defined in: [packages/library/src/runtime/Withdrawals.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L42) + +#### Parameters + +##### withdrawal + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### withdraw() + +> **withdraw**(`address`, `amount`, `tokenId`): `Promise`\<`void`\> + +Defined in: [packages/library/src/runtime/Withdrawals.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L59) + +#### Parameters + +##### address + +`PublicKey` + +##### amount + +[`UInt64`](UInt64.md) + +##### tokenId + +`Field` + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/library/interfaces/BalancesEvents.md b/src/pages/docs/reference/library/interfaces/BalancesEvents.md new file mode 100644 index 0000000..cf75a52 --- /dev/null +++ b/src/pages/docs/reference/library/interfaces/BalancesEvents.md @@ -0,0 +1,29 @@ +--- +title: BalancesEvents +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / BalancesEvents + +# Interface: BalancesEvents + +Defined in: [packages/library/src/runtime/Balances.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L30) + +## Extends + +- [`EventsRecord`](../../common/type-aliases/EventsRecord.md) + +## Indexable + +\[`key`: `string`\]: `unknown`[] + +## Properties + +### setBalance + +> **setBalance**: \[[`BalancesKey`](../classes/BalancesKey.md), [`Balance`](../classes/Balance.md)\] + +Defined in: [packages/library/src/runtime/Balances.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L31) diff --git a/src/pages/docs/reference/library/interfaces/FeeIndexes.md b/src/pages/docs/reference/library/interfaces/FeeIndexes.md new file mode 100644 index 0000000..c2b544c --- /dev/null +++ b/src/pages/docs/reference/library/interfaces/FeeIndexes.md @@ -0,0 +1,17 @@ +--- +title: FeeIndexes +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / FeeIndexes + +# Interface: FeeIndexes + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L28) + +## Indexable + +\[`methodId`: `string`\]: `bigint` diff --git a/src/pages/docs/reference/library/interfaces/FeeTreeValues.md b/src/pages/docs/reference/library/interfaces/FeeTreeValues.md new file mode 100644 index 0000000..d2e4814 --- /dev/null +++ b/src/pages/docs/reference/library/interfaces/FeeTreeValues.md @@ -0,0 +1,17 @@ +--- +title: FeeTreeValues +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / FeeTreeValues + +# Interface: FeeTreeValues + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L24) + +## Indexable + +\[`methodId`: `string`\]: [`MethodFeeConfig`](MethodFeeConfig.md) diff --git a/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md b/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md new file mode 100644 index 0000000..4294b16 --- /dev/null +++ b/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md @@ -0,0 +1,45 @@ +--- +title: MethodFeeConfig +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / MethodFeeConfig + +# Interface: MethodFeeConfig + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L17) + +## Properties + +### baseFee + +> **baseFee**: `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L19) + +*** + +### methodId + +> **methodId**: `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L18) + +*** + +### perWeightUnitFee + +> **perWeightUnitFee**: `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L20) + +*** + +### weight + +> **weight**: `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L21) diff --git a/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md b/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md new file mode 100644 index 0000000..214406b --- /dev/null +++ b/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md @@ -0,0 +1,61 @@ +--- +title: RuntimeFeeAnalyzerServiceConfig +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / RuntimeFeeAnalyzerServiceConfig + +# Interface: RuntimeFeeAnalyzerServiceConfig + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L46) + +## Extended by + +- [`TransactionFeeHookConfig`](TransactionFeeHookConfig.md) + +## Properties + +### baseFee + +> **baseFee**: `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) + +*** + +### feeRecipient + +> **feeRecipient**: `string` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) + +*** + +### methods + +> **methods**: `object` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) + +#### Index Signature + +\[`methodId`: `string`\]: `Partial`\<[`MethodFeeConfig`](MethodFeeConfig.md)\> + +*** + +### perWeightUnitFee + +> **perWeightUnitFee**: `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) + +*** + +### tokenId + +> **tokenId**: `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) diff --git a/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md b/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md new file mode 100644 index 0000000..00ba2a2 --- /dev/null +++ b/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md @@ -0,0 +1,81 @@ +--- +title: TransactionFeeHookConfig +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / TransactionFeeHookConfig + +# Interface: TransactionFeeHookConfig + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L33) + +## Extends + +- [`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md) + +## Properties + +### baseFee + +> **baseFee**: `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) + +#### Inherited from + +[`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md).[`baseFee`](RuntimeFeeAnalyzerServiceConfig.md#basefee) + +*** + +### feeRecipient + +> **feeRecipient**: `string` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) + +#### Inherited from + +[`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md).[`feeRecipient`](RuntimeFeeAnalyzerServiceConfig.md#feerecipient) + +*** + +### methods + +> **methods**: `object` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) + +#### Index Signature + +\[`methodId`: `string`\]: `Partial`\<[`MethodFeeConfig`](MethodFeeConfig.md)\> + +#### Inherited from + +[`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md).[`methods`](RuntimeFeeAnalyzerServiceConfig.md#methods) + +*** + +### perWeightUnitFee + +> **perWeightUnitFee**: `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) + +#### Inherited from + +[`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md).[`perWeightUnitFee`](RuntimeFeeAnalyzerServiceConfig.md#perweightunitfee) + +*** + +### tokenId + +> **tokenId**: `bigint` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) + +#### Inherited from + +[`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md).[`tokenId`](RuntimeFeeAnalyzerServiceConfig.md#tokenid) diff --git a/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md b/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md new file mode 100644 index 0000000..53707bf --- /dev/null +++ b/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md @@ -0,0 +1,15 @@ +--- +title: AdditionalSequencerModules +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / AdditionalSequencerModules + +# Type Alias: AdditionalSequencerModules + +> **AdditionalSequencerModules**: [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) & [`MinimumAdditionalSequencerModules`](MinimumAdditionalSequencerModules.md) + +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L36) diff --git a/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md new file mode 100644 index 0000000..ed462c6 --- /dev/null +++ b/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md @@ -0,0 +1,49 @@ +--- +title: InMemorySequencerModulesRecord +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / InMemorySequencerModulesRecord + +# Type Alias: InMemorySequencerModulesRecord + +> **InMemorySequencerModulesRecord**: `object` + +Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/InMemorySequencerModules.ts#L16) + +## Type declaration + +### BaseLayer + +> **BaseLayer**: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md) + +### BatchProducerModule + +> **BatchProducerModule**: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md) + +### BlockProducerModule + +> **BlockProducerModule**: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md) + +### BlockTrigger + +> **BlockTrigger**: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md) + +### Database + +> **Database**: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md) + +### LocalTaskWorkerModule + +> **LocalTaskWorkerModule**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<[`TaskWorkerModulesWithoutSettlement`](../../sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md)\>\> + +### Mempool + +> **Mempool**: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md) + +### TaskQueue + +> **TaskQueue**: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md) diff --git a/src/pages/docs/reference/library/type-aliases/MinimalBalances.md b/src/pages/docs/reference/library/type-aliases/MinimalBalances.md new file mode 100644 index 0000000..a4828a5 --- /dev/null +++ b/src/pages/docs/reference/library/type-aliases/MinimalBalances.md @@ -0,0 +1,47 @@ +--- +title: MinimalBalances +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / MinimalBalances + +# Type Alias: MinimalBalances + +> **MinimalBalances**: `object` + +Defined in: [packages/library/src/runtime/Balances.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L34) + +## Type declaration + +### balances + +> **balances**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`BalancesKey`](../classes/BalancesKey.md), [`Balance`](../classes/Balance.md)\> + +### transfer() + +> **transfer**: (`tokenId`, `from`, `to`, `amount`) => `void` + +#### Parameters + +##### tokenId + +[`TokenId`](../classes/TokenId.md) + +##### from + +`PublicKey` + +##### to + +`PublicKey` + +##### amount + +[`Balance`](../classes/Balance.md) + +#### Returns + +`void` diff --git a/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md b/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md new file mode 100644 index 0000000..bccdb16 --- /dev/null +++ b/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md @@ -0,0 +1,33 @@ +--- +title: MinimumAdditionalSequencerModules +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / MinimumAdditionalSequencerModules + +# Type Alias: MinimumAdditionalSequencerModules + +> **MinimumAdditionalSequencerModules**: `object` + +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L26) + +## Type declaration + +### BaseLayer + +> **BaseLayer**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BaseLayer`](../../sequencer/interfaces/BaseLayer.md) & [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`unknown`\>\> + +### BlockTrigger + +> **BlockTrigger**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BlockTrigger`](../../sequencer/interfaces/BlockTrigger.md) & [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`unknown`\>\> + +### Database + +> **Database**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Database`](../../sequencer/interfaces/Database.md) & [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`unknown`\>\> + +### TaskQueue + +> **TaskQueue**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) & [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`unknown`\>\> diff --git a/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md new file mode 100644 index 0000000..6baccd1 --- /dev/null +++ b/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md @@ -0,0 +1,15 @@ +--- +title: SimpleSequencerModulesRecord +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / SimpleSequencerModulesRecord + +# Type Alias: SimpleSequencerModulesRecord + +> **SimpleSequencerModulesRecord**: [`MinimumAdditionalSequencerModules`](MinimumAdditionalSequencerModules.md) & `PreconfiguredSimpleSequencerModulesRecord` + +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L33) diff --git a/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md new file mode 100644 index 0000000..c6f78c6 --- /dev/null +++ b/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md @@ -0,0 +1,25 @@ +--- +title: SimpleSequencerWorkerModulesRecord +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / SimpleSequencerWorkerModulesRecord + +# Type Alias: SimpleSequencerWorkerModulesRecord + +> **SimpleSequencerWorkerModulesRecord**: `object` + +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L39) + +## Type declaration + +### LocalTaskWorkerModule + +> **LocalTaskWorkerModule**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<`ReturnType`\<*typeof* [`allTasks`](../../sequencer/classes/VanillaTaskWorkerModules.md#alltasks)\>\>\> + +### TaskQueue + +> **TaskQueue**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`TaskQueue`](../../sequencer/interfaces/TaskQueue.md)\> diff --git a/src/pages/docs/reference/library/type-aliases/UIntConstructor.md b/src/pages/docs/reference/library/type-aliases/UIntConstructor.md new file mode 100644 index 0000000..7304d42 --- /dev/null +++ b/src/pages/docs/reference/library/type-aliases/UIntConstructor.md @@ -0,0 +1,99 @@ +--- +title: UIntConstructor +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UIntConstructor + +# Type Alias: UIntConstructor\ + +> **UIntConstructor**\<`BITS`\>: `object` + +Defined in: [packages/library/src/math/UInt.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L24) + +## Type Parameters + +• **BITS** *extends* `number` + +## Type declaration + +### Safe + +> **Safe**: `object` + +#### Safe.fromField() + +##### Parameters + +###### x + +`Field` + +##### Returns + +[`UInt`](../classes/UInt.md)\<`BITS`\> + +### Unsafe + +> **Unsafe**: `object` + +#### Unsafe.fromField() + +##### Parameters + +###### x + +`Field` + +##### Returns + +[`UInt`](../classes/UInt.md)\<`BITS`\> + +### max + +#### Get Signature + +> **get** **max**(): [`UInt`](../classes/UInt.md)\<`BITS`\> + +##### Returns + +[`UInt`](../classes/UInt.md)\<`BITS`\> + +### zero + +#### Get Signature + +> **get** **zero**(): [`UInt`](../classes/UInt.md)\<`BITS`\> + +##### Returns + +[`UInt`](../classes/UInt.md)\<`BITS`\> + +### check() + +#### Parameters + +##### x + +###### value + +`Field` + +#### Returns + +`void` + +### from() + +#### Parameters + +##### x + +`string` | `number` | `bigint` | [`UInt`](../classes/UInt.md)\<`BITS`\> + +#### Returns + +[`UInt`](../classes/UInt.md)\<`BITS`\> diff --git a/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md b/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md new file mode 100644 index 0000000..dbb06ba --- /dev/null +++ b/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md @@ -0,0 +1,21 @@ +--- +title: VanillaProtocolModulesRecord +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / VanillaProtocolModulesRecord + +# Type Alias: VanillaProtocolModulesRecord + +> **VanillaProtocolModulesRecord**: [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object` + +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L14) + +## Type declaration + +### TransactionFee + +> **TransactionFee**: *typeof* [`TransactionFeeHook`](../classes/TransactionFeeHook.md) diff --git a/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md b/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md new file mode 100644 index 0000000..7b57cda --- /dev/null +++ b/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md @@ -0,0 +1,21 @@ +--- +title: VanillaRuntimeModulesRecord +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / VanillaRuntimeModulesRecord + +# Type Alias: VanillaRuntimeModulesRecord + +> **VanillaRuntimeModulesRecord**: `object` + +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/VanillaRuntimeModules.ts#L6) + +## Type declaration + +### Balances + +> **Balances**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`MinimalBalances`](MinimalBalances.md) & [`RuntimeModule`](../../module/classes/RuntimeModule.md)\> diff --git a/src/pages/docs/reference/library/variables/errors.md b/src/pages/docs/reference/library/variables/errors.md new file mode 100644 index 0000000..d140016 --- /dev/null +++ b/src/pages/docs/reference/library/variables/errors.md @@ -0,0 +1,33 @@ +--- +title: errors +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / errors + +# Variable: errors + +> `const` **errors**: `object` + +Defined in: [packages/library/src/runtime/Balances.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L13) + +## Type declaration + +### fromBalanceInsufficient() + +> **fromBalanceInsufficient**: () => `string` + +#### Returns + +`string` + +### senderNotFrom() + +> **senderNotFrom**: () => `string` + +#### Returns + +`string` diff --git a/src/pages/docs/reference/library/variables/treeFeeHeight.md b/src/pages/docs/reference/library/variables/treeFeeHeight.md new file mode 100644 index 0000000..76a28dc --- /dev/null +++ b/src/pages/docs/reference/library/variables/treeFeeHeight.md @@ -0,0 +1,15 @@ +--- +title: treeFeeHeight +--- + +[**@proto-kit/library**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / treeFeeHeight + +# Variable: treeFeeHeight + +> `const` **treeFeeHeight**: `10` = `10` + +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L43) diff --git a/src/pages/docs/reference/module/README.md b/src/pages/docs/reference/module/README.md new file mode 100644 index 0000000..99e640e --- /dev/null +++ b/src/pages/docs/reference/module/README.md @@ -0,0 +1,124 @@ +--- +title: "@proto-kit/module" +--- + +**@proto-kit/module** + +*** + +[Documentation](../../README.md) / @proto-kit/module + +# YAB: Module + +Set of APIs to define YAB runtime modules and application chains. + +**Application chain** consists of multiple _runtime modules_. Runtime modules can be either implemented as part of the chain directly, or imported from 3rd parties. Here's an example of how a chain with two runtime modules can be defined: + +```typescript +const chain = Chain.from({ + state: new InMemoryStateService(), + // specify which modules should the chain consist of + modules: { + Balances, + Admin, + }, +}); + +// compile the chain into a verification key +const { verificationKey } = await chain.compile(); +``` + +Chain works as a wrapper for all circuit logic contained by the runtime module methods. Compilation produces a _wrap circuit_ including all known methods of the configured runtime modules. + +Here's an example `Balances` runtime module: + +```typescript +@runtimeModule() +export class Balances extends RuntimeModule { + @state() public totalSupply = State.from(UInt64); + + @state() public balances = StateMap.from( + PublicKey, + UInt64 + ); + + public constructor(public admin: Admin) { + super(); + } + + @runtimeMethod() + public getTotalSupply() { + this.totalSupply.get(); + } + + @runtimeMethod() + public setTotalSupply() { + this.totalSupply.set(UInt64.from(20)); + this.admin.isAdmin(); + } + + @runtimeMethod() + public getBalance(address: PublicKey): Option { + return this.balances.get(address); + } +} +``` + +The Balances runtime module shows how the YAB runtime module API can be used: + +- `runtimeModule()` - marks the class as a runtime module +- `class Balance extends RuntimeModule` - introduces runtime module APIs into the runtime module +- `@state() public totalSupply = State.from(UInt64)` - defines a runtime module state of type `UInt64`, which can be either get or set +- `@state() public balances = StateMap.from(PublicKey, UInt64)` - defines a runtime module map state, which allows values to be stored under keys, respective of the given key & value types. +- `public constructor(public admin: Admin)` - injects a runtime module dependency to another runtime module `Admin`, which is a standalone runtime module +- `@runtimeMethod() public getTotalSupply()` - defines a runtime module method containing circuit logic for a runtime state transition. Methods define how the chain state is transformed from the initial state to the resulting state. +- `this.admin.isAdmin()` - shows how runtime module interoperability works, a configured runtime module is injected in the constructor, and can be used within the existing methods. Code of the called runtime module becomes part of the original method circuit (setTotalSupply in this case). + +## Method wrapper circuit + +Every runtime module method gets wrapped into an extra outter circuit, which allows the underlying runtime to make assertions about the results of the method execution, such as: + +- State transitions +- Execution status +- Transaction hash (method invocation arguments) +- Network state (TODO) + +The good thing is, the YAB runtime module API does this for you automatically, but it pays off to keep this in mind when debugging your runtime modules. Due to the nature of the underlying ZK method lifecycle, methods cannot produce any side effects beyond the state transitions, which are implicitly generated using the `State` API. Again due to method lifecycle implications, your method code will run multiple times at different stages of its lifecycle, such as: + +- Compilation +- Simulation +- Proving + +> Please be careful about keeping your runtime module methods side-effect free, since it may introduce inconsistencies in the method lifecycle which may lead to the inability to generate an execution proof. + +## Testing + +Runtime module methods can be ran or tested in two different modes: + +- Simulation +- Proving + +Simulation mode means that only the method javascript code will run, and no proving will be done. This is the fastest way of testing your module methods. + +Provnig mode means that the whole chain needs to be compiled, and then every method execution can be additionally proven by accessing the provers generated during method simulation. + +Here's an example of how a runtime module method execution proof can be generated, but please keep in mind you also need to enable proofs and compile the chain. More detailed examples can be found in `test/modules`: + +```typescript +const chain = Chain.from({ + state, + + modules: { + Balances, + Admin, + }, +}); + +const balances = chain.resolve("Balances"); +balances.getTotalSupply(); + +const { + result: { prove }, +} = container.resolve(MethodExecutionContext); +const proof = await prove(); +``` diff --git a/src/pages/docs/reference/module/_meta.tsx b/src/pages/docs/reference/module/_meta.tsx new file mode 100644 index 0000000..4d63940 --- /dev/null +++ b/src/pages/docs/reference/module/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/module/classes/InMemoryStateService.md b/src/pages/docs/reference/module/classes/InMemoryStateService.md new file mode 100644 index 0000000..86fc3b4 --- /dev/null +++ b/src/pages/docs/reference/module/classes/InMemoryStateService.md @@ -0,0 +1,93 @@ +--- +title: InMemoryStateService +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / InMemoryStateService + +# Class: InMemoryStateService + +Defined in: [module/src/state/InMemoryStateService.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/state/InMemoryStateService.ts#L7) + +Naive implementation of an in-memory variant of the StateService interface + +## Extended by + +- [`CachedStateService`](../../sequencer/classes/CachedStateService.md) +- [`PreFilledStateService`](../../sequencer/classes/PreFilledStateService.md) + +## Implements + +- [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) + +## Constructors + +### new InMemoryStateService() + +> **new InMemoryStateService**(): [`InMemoryStateService`](InMemoryStateService.md) + +#### Returns + +[`InMemoryStateService`](InMemoryStateService.md) + +## Properties + +### values + +> **values**: `Record`\<`string`, `null` \| `Field`[]\> = `{}` + +Defined in: [module/src/state/InMemoryStateService.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/state/InMemoryStateService.ts#L12) + +This mapping container null values if the specific entry has been deleted. +This is used by the CachedState service to keep track of deletions + +## Methods + +### get() + +> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> + +Defined in: [module/src/state/InMemoryStateService.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/state/InMemoryStateService.ts#L14) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| `Field`[]\> + +#### Implementation of + +[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`get`](../../protocol/interfaces/SimpleAsyncStateService.md#get) + +*** + +### set() + +> **set**(`key`, `value`): `Promise`\<`void`\> + +Defined in: [module/src/state/InMemoryStateService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/state/InMemoryStateService.ts#L18) + +#### Parameters + +##### key + +`Field` + +##### value + +`undefined` | `Field`[] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`set`](../../protocol/interfaces/SimpleAsyncStateService.md#set) diff --git a/src/pages/docs/reference/module/classes/MethodIdFactory.md b/src/pages/docs/reference/module/classes/MethodIdFactory.md new file mode 100644 index 0000000..28dda82 --- /dev/null +++ b/src/pages/docs/reference/module/classes/MethodIdFactory.md @@ -0,0 +1,62 @@ +--- +title: MethodIdFactory +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / MethodIdFactory + +# Class: MethodIdFactory + +Defined in: [module/src/factories/MethodIdFactory.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/factories/MethodIdFactory.ts#L5) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Implements + +- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) + +## Constructors + +### new MethodIdFactory() + +> **new MethodIdFactory**(): [`MethodIdFactory`](MethodIdFactory.md) + +#### Returns + +[`MethodIdFactory`](MethodIdFactory.md) + +## Methods + +### dependencies() + +> **dependencies**(): `object` + +Defined in: [module/src/factories/MethodIdFactory.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/factories/MethodIdFactory.ts#L6) + +#### Returns + +`object` + +##### methodIdResolver + +> **methodIdResolver**: `object` + +###### methodIdResolver.useClass + +> **methodIdResolver.useClass**: *typeof* [`MethodIdResolver`](MethodIdResolver.md) = `MethodIdResolver` + +#### Implementation of + +[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) diff --git a/src/pages/docs/reference/module/classes/MethodIdResolver.md b/src/pages/docs/reference/module/classes/MethodIdResolver.md new file mode 100644 index 0000000..b1f3ebf --- /dev/null +++ b/src/pages/docs/reference/module/classes/MethodIdResolver.md @@ -0,0 +1,90 @@ +--- +title: MethodIdResolver +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / MethodIdResolver + +# Class: MethodIdResolver + +Defined in: [module/src/runtime/MethodIdResolver.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/MethodIdResolver.ts#L18) + +Please see `getMethodId` to learn more about +methodId encoding + +## Constructors + +### new MethodIdResolver() + +> **new MethodIdResolver**(`runtime`): [`MethodIdResolver`](MethodIdResolver.md) + +Defined in: [module/src/runtime/MethodIdResolver.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/MethodIdResolver.ts#L23) + +#### Parameters + +##### runtime + +[`Runtime`](Runtime.md)\<[`RuntimeModulesRecord`](../type-aliases/RuntimeModulesRecord.md)\> + +#### Returns + +[`MethodIdResolver`](MethodIdResolver.md) + +## Methods + +### getMethodId() + +> **getMethodId**(`moduleName`, `methodName`): `bigint` + +Defined in: [module/src/runtime/MethodIdResolver.ts:100](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/MethodIdResolver.ts#L100) + +#### Parameters + +##### moduleName + +`string` + +##### methodName + +`string` + +#### Returns + +`bigint` + +*** + +### getMethodNameFromId() + +> **getMethodNameFromId**(`methodId`): `undefined` \| \[`string`, `string`\] + +Defined in: [module/src/runtime/MethodIdResolver.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/MethodIdResolver.ts#L86) + +#### Parameters + +##### methodId + +`bigint` + +#### Returns + +`undefined` \| \[`string`, `string`\] + +*** + +### methodIdMap() + +> **methodIdMap**(): [`RuntimeMethodIdMapping`](../../protocol/type-aliases/RuntimeMethodIdMapping.md) + +Defined in: [module/src/runtime/MethodIdResolver.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/MethodIdResolver.ts#L47) + +The purpose of this method is to provide a dictionary where +we can look up properties like methodId and invocationType +for each runtimeMethod using their module name and method name + +#### Returns + +[`RuntimeMethodIdMapping`](../../protocol/type-aliases/RuntimeMethodIdMapping.md) diff --git a/src/pages/docs/reference/module/classes/MethodParameterEncoder.md b/src/pages/docs/reference/module/classes/MethodParameterEncoder.md new file mode 100644 index 0000000..fca384a --- /dev/null +++ b/src/pages/docs/reference/module/classes/MethodParameterEncoder.md @@ -0,0 +1,134 @@ +--- +title: MethodParameterEncoder +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / MethodParameterEncoder + +# Class: MethodParameterEncoder + +Defined in: [module/src/method/MethodParameterEncoder.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L76) + +## Constructors + +### new MethodParameterEncoder() + +> **new MethodParameterEncoder**(`types`): [`MethodParameterEncoder`](MethodParameterEncoder.md) + +Defined in: [module/src/method/MethodParameterEncoder.ts:120](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L120) + +#### Parameters + +##### types + +`ArgTypeArray` + +#### Returns + +[`MethodParameterEncoder`](MethodParameterEncoder.md) + +## Methods + +### decode() + +> **decode**(`fields`, `auxiliary`): `Promise`\<`ArgArray`\> + +Defined in: [module/src/method/MethodParameterEncoder.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L122) + +#### Parameters + +##### fields + +`Field`[] + +##### auxiliary + +`string`[] + +#### Returns + +`Promise`\<`ArgArray`\> + +*** + +### encode() + +> **encode**(`args`): `object` + +Defined in: [module/src/method/MethodParameterEncoder.ts:184](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L184) + +Variant of encode() for provable code that skips the unprovable +json encoding + +#### Parameters + +##### args + +[`ArgumentTypes`](../../common/type-aliases/ArgumentTypes.md) + +#### Returns + +`object` + +##### auxiliary + +> **auxiliary**: `string`[] + +##### fields + +> **fields**: `Field`[] + +*** + +### fieldSize() + +> **fieldSize**(): `number` + +Defined in: [module/src/method/MethodParameterEncoder.ts:246](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L246) + +#### Returns + +`number` + +*** + +### fieldSize() + +> `static` **fieldSize**(`type`): `undefined` \| `number` + +Defined in: [module/src/method/MethodParameterEncoder.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L109) + +#### Parameters + +##### type + +`ArgumentType` + +#### Returns + +`undefined` \| `number` + +*** + +### fromMethod() + +> `static` **fromMethod**(`target`, `methodName`): [`MethodParameterEncoder`](MethodParameterEncoder.md) + +Defined in: [module/src/method/MethodParameterEncoder.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L77) + +#### Parameters + +##### target + +[`RuntimeModule`](RuntimeModule.md)\<`unknown`\> + +##### methodName + +`string` + +#### Returns + +[`MethodParameterEncoder`](MethodParameterEncoder.md) diff --git a/src/pages/docs/reference/module/classes/Runtime.md b/src/pages/docs/reference/module/classes/Runtime.md new file mode 100644 index 0000000..0c37ba6 --- /dev/null +++ b/src/pages/docs/reference/module/classes/Runtime.md @@ -0,0 +1,782 @@ +--- +title: Runtime +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / Runtime + +# Class: Runtime\ + +Defined in: [module/src/runtime/Runtime.ts:270](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L270) + +Wrapper for an application specific runtime, which helps orchestrate +runtime modules into an interoperable runtime. + +## Extends + +- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Modules`\> + +## Type Parameters + +• **Modules** *extends* [`RuntimeModulesRecord`](../type-aliases/RuntimeModulesRecord.md) + +## Implements + +- [`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md) +- [`CompilableModule`](../../common/interfaces/CompilableModule.md) + +## Constructors + +### new Runtime() + +> **new Runtime**\<`Modules`\>(`definition`): [`Runtime`](Runtime.md)\<`Modules`\> + +Defined in: [module/src/runtime/Runtime.ts:296](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L296) + +Creates a new Runtime from the provided config + +#### Parameters + +##### definition + +[`RuntimeDefinition`](../interfaces/RuntimeDefinition.md)\<`Modules`\> + +#### Returns + +[`Runtime`](Runtime.md)\<`Modules`\> + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) + +*** + +### definition + +> **definition**: [`RuntimeDefinition`](../interfaces/RuntimeDefinition.md)\<`Modules`\> + +Defined in: [module/src/runtime/Runtime.ts:287](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L287) + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) + +*** + +### program? + +> `optional` **program**: `any` + +Defined in: [module/src/runtime/Runtime.ts:285](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L285) + +*** + +### zkProgrammable + +> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> + +Defined in: [module/src/runtime/Runtime.ts:289](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L289) + +#### Implementation of + +[`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md).[`zkProgrammable`](../interfaces/RuntimeEnvironment.md#zkprogrammable) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [module/src/runtime/Runtime.ts:309](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L309) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Implementation of + +[`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md).[`areProofsEnabled`](../interfaces/RuntimeEnvironment.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) + +*** + +### dependencyContainer + +#### Get Signature + +> **get** **dependencyContainer**(): `DependencyContainer` + +Defined in: [module/src/runtime/Runtime.ts:330](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L330) + +##### Returns + +`DependencyContainer` + +The dependency injection container of this runtime + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) + +*** + +### methodIdResolver + +#### Get Signature + +> **get** **methodIdResolver**(): [`MethodIdResolver`](MethodIdResolver.md) + +Defined in: [module/src/runtime/Runtime.ts:323](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L323) + +##### Returns + +[`MethodIdResolver`](MethodIdResolver.md) + +#### Implementation of + +[`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md).[`methodIdResolver`](../interfaces/RuntimeEnvironment.md#methodidresolver) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) + +*** + +### runtimeModuleNames + +#### Get Signature + +> **get** **runtimeModuleNames**(): `string`[] + +Defined in: [module/src/runtime/Runtime.ts:382](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L382) + +##### Returns + +`string`[] + +A list of names of all the registered module names + +*** + +### stateService + +#### Get Signature + +> **get** **stateService**(): [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) + +Defined in: [module/src/runtime/Runtime.ts:319](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L319) + +##### Returns + +[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) + +#### Implementation of + +[`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md).[`stateService`](../interfaces/RuntimeEnvironment.md#stateservice) + +*** + +### stateServiceProvider + +#### Get Signature + +> **get** **stateServiceProvider**(): [`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) + +Defined in: [module/src/runtime/Runtime.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L313) + +##### Returns + +[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) + +#### Implementation of + +[`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md).[`stateServiceProvider`](../interfaces/RuntimeEnvironment.md#stateserviceprovider) + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` + +Defined in: common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) + +*** + +### compile() + +> **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> + +Defined in: [module/src/runtime/Runtime.ts:386](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L386) + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> + +#### Implementation of + +[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [module/src/runtime/Runtime.ts:303](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L303) + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) + +*** + +### decorateModule() + +> **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: [module/src/runtime/Runtime.ts:369](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L369) + +Add a name and other respective properties required by RuntimeModules, +that come from the current Runtime + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +Name of the runtime module to decorate + +##### containedModule + +`InstanceType`\<`Modules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>\]\> + +#### Returns + +`void` + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) + +*** + +### getMethodById() + +> **getMethodById**(`methodId`): `undefined` \| (...`args`) => `Promise`\<`unknown`\> + +Defined in: [module/src/runtime/Runtime.ts:338](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L338) + +#### Parameters + +##### methodId + +`bigint` + +The encoded name of the method to call. +Encoding: "stringToField(module.name) << 128 + stringToField(method-name)" + +#### Returns + +`undefined` \| (...`args`) => `Promise`\<`unknown`\> + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>[] + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` + +Defined in: common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +`Modules` + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +`Modules` + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +Defined in: common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`Modules`\>(`definition`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](Runtime.md)\<`Modules`\>\> + +Defined in: [module/src/runtime/Runtime.ts:274](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L274) + +#### Type Parameters + +• **Modules** *extends* [`RuntimeModulesRecord`](../type-aliases/RuntimeModulesRecord.md) + +#### Parameters + +##### definition + +[`RuntimeDefinition`](../interfaces/RuntimeDefinition.md)\<`Modules`\> + +#### Returns + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](Runtime.md)\<`Modules`\>\> diff --git a/src/pages/docs/reference/module/classes/RuntimeEvents.md b/src/pages/docs/reference/module/classes/RuntimeEvents.md new file mode 100644 index 0000000..967891b --- /dev/null +++ b/src/pages/docs/reference/module/classes/RuntimeEvents.md @@ -0,0 +1,91 @@ +--- +title: RuntimeEvents +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeEvents + +# Class: RuntimeEvents\ + +Defined in: [module/src/runtime/RuntimeModule.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L25) + +## Type Parameters + +• **Events** *extends* `EventRecord` + +## Constructors + +### new RuntimeEvents() + +> **new RuntimeEvents**\<`Events`\>(`events`): [`RuntimeEvents`](RuntimeEvents.md)\<`Events`\> + +Defined in: [module/src/runtime/RuntimeModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L26) + +#### Parameters + +##### events + +`Events` + +#### Returns + +[`RuntimeEvents`](RuntimeEvents.md)\<`Events`\> + +## Methods + +### emit() + +> **emit**\<`Key`\>(`eventName`, `event`): `void` + +Defined in: [module/src/runtime/RuntimeModule.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L47) + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### eventName + +`Key` + +##### event + +`InferProvable`\<`Events`\[`Key`\]\> + +#### Returns + +`void` + +*** + +### emitIf() + +> **emitIf**\<`Key`\>(`condition`, `eventName`, `event`): `void` + +Defined in: [module/src/runtime/RuntimeModule.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L28) + +#### Type Parameters + +• **Key** *extends* `string` \| `number` \| `symbol` + +#### Parameters + +##### condition + +`Bool` + +##### eventName + +`Key` + +##### event + +`InferProvable`\<`Events`\[`Key`\]\> + +#### Returns + +`void` diff --git a/src/pages/docs/reference/module/classes/RuntimeModule.md b/src/pages/docs/reference/module/classes/RuntimeModule.md new file mode 100644 index 0000000..1f35921 --- /dev/null +++ b/src/pages/docs/reference/module/classes/RuntimeModule.md @@ -0,0 +1,209 @@ +--- +title: RuntimeModule +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeModule + +# Class: RuntimeModule\ + +Defined in: [module/src/runtime/RuntimeModule.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L59) + +Base class for runtime modules providing the necessary utilities. + +## Extends + +- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> + +## Extended by + +- [`Balances`](../../library/classes/Balances.md) +- [`Withdrawals`](../../library/classes/Withdrawals.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +## Constructors + +### new RuntimeModule() + +> **new RuntimeModule**\<`Config`\>(): [`RuntimeModule`](RuntimeModule.md)\<`Config`\> + +Defined in: [module/src/runtime/RuntimeModule.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L82) + +#### Returns + +[`RuntimeModule`](RuntimeModule.md)\<`Config`\> + +#### Overrides + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) + +*** + +### events? + +> `optional` **events**: [`RuntimeEvents`](RuntimeEvents.md)\<`any`\> = `undefined` + +Defined in: [module/src/runtime/RuntimeModule.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L80) + +*** + +### isRuntimeModule + +> **isRuntimeModule**: `boolean` = `true` + +Defined in: [module/src/runtime/RuntimeModule.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L74) + +This property exists only to typecheck that the RuntimeModule +was extended correctly in e.g. a decorator. We need at least +one non-optional property in this class to make the typechecking work. + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [module/src/runtime/RuntimeModule.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L76) + +*** + +### runtime? + +> `optional` **runtime**: [`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md) + +Defined in: [module/src/runtime/RuntimeModule.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L78) + +*** + +### runtimeMethodNames + +> `readonly` **runtimeMethodNames**: `string`[] = `[]` + +Defined in: [module/src/runtime/RuntimeModule.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L67) + +Holds all method names that are callable throw transactions + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [module/src/runtime/RuntimeModule.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L62) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) + +*** + +### network + +#### Get Signature + +> **get** **network**(): [`NetworkState`](../../protocol/classes/NetworkState.md) + +Defined in: [module/src/runtime/RuntimeModule.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L109) + +##### Returns + +[`NetworkState`](../../protocol/classes/NetworkState.md) + +*** + +### transaction + +#### Get Signature + +> **get** **transaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +Defined in: [module/src/runtime/RuntimeModule.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L105) + +##### Returns + +[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) + +*** + +### getInputs() + +> **getInputs**(): [`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) + +Defined in: [module/src/runtime/RuntimeModule.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L92) + +#### Returns + +[`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) diff --git a/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md b/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md new file mode 100644 index 0000000..65d8bc9 --- /dev/null +++ b/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md @@ -0,0 +1,125 @@ +--- +title: RuntimeZkProgrammable +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeZkProgrammable + +# Class: RuntimeZkProgrammable\ + +Defined in: [module/src/runtime/Runtime.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L77) + +## Extends + +- [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<`undefined`, [`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> + +## Type Parameters + +• **Modules** *extends* [`RuntimeModulesRecord`](../type-aliases/RuntimeModulesRecord.md) + +## Constructors + +### new RuntimeZkProgrammable() + +> **new RuntimeZkProgrammable**\<`Modules`\>(`runtime`): [`RuntimeZkProgrammable`](RuntimeZkProgrammable.md)\<`Modules`\> + +Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L80) + +#### Parameters + +##### runtime + +[`Runtime`](Runtime.md)\<`Modules`\> + +#### Returns + +[`RuntimeZkProgrammable`](RuntimeZkProgrammable.md)\<`Modules`\> + +#### Overrides + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`constructor`](../../common/classes/ZkProgrammable.md#constructors) + +## Properties + +### runtime + +> **runtime**: [`Runtime`](Runtime.md)\<`Modules`\> + +Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L80) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [module/src/runtime/Runtime.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L84) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Overrides + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`areProofsEnabled`](../../common/classes/ZkProgrammable.md#areproofsenabled) + +*** + +### zkProgram + +#### Get Signature + +> **get** **zkProgram**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] + +Defined in: common/dist/zkProgrammable/ZkProgrammable.d.ts:34 + +##### Returns + +[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] + +#### Inherited from + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgram`](../../common/classes/ZkProgrammable.md#zkprogram) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> + +Defined in: common/dist/zkProgrammable/ZkProgrammable.d.ts:35 + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> + +#### Inherited from + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`compile`](../../common/classes/ZkProgrammable.md#compile) + +*** + +### zkProgramFactory() + +> **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\>[] + +Defined in: [module/src/runtime/Runtime.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L88) + +#### Returns + +[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\>[] + +#### Overrides + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgramFactory`](../../common/classes/ZkProgrammable.md#zkprogramfactory) diff --git a/src/pages/docs/reference/module/functions/combineMethodName.md b/src/pages/docs/reference/module/functions/combineMethodName.md new file mode 100644 index 0000000..ab40125 --- /dev/null +++ b/src/pages/docs/reference/module/functions/combineMethodName.md @@ -0,0 +1,29 @@ +--- +title: combineMethodName +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / combineMethodName + +# Function: combineMethodName() + +> **combineMethodName**(`runtimeModuleName`, `methodName`): `string` + +Defined in: [module/src/method/runtimeMethod.ts:163](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L163) + +## Parameters + +### runtimeModuleName + +`string` + +### methodName + +`string` + +## Returns + +`string` diff --git a/src/pages/docs/reference/module/functions/getAllPropertyNames.md b/src/pages/docs/reference/module/functions/getAllPropertyNames.md new file mode 100644 index 0000000..182e77b --- /dev/null +++ b/src/pages/docs/reference/module/functions/getAllPropertyNames.md @@ -0,0 +1,25 @@ +--- +title: getAllPropertyNames +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / getAllPropertyNames + +# Function: getAllPropertyNames() + +> **getAllPropertyNames**(`obj`): (`string` \| `symbol`)[] + +Defined in: [module/src/runtime/Runtime.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L39) + +## Parameters + +### obj + +`any` + +## Returns + +(`string` \| `symbol`)[] diff --git a/src/pages/docs/reference/module/functions/isRuntimeMethod.md b/src/pages/docs/reference/module/functions/isRuntimeMethod.md new file mode 100644 index 0000000..14f8525 --- /dev/null +++ b/src/pages/docs/reference/module/functions/isRuntimeMethod.md @@ -0,0 +1,38 @@ +--- +title: isRuntimeMethod +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / isRuntimeMethod + +# Function: isRuntimeMethod() + +> **isRuntimeMethod**(`target`, `propertyKey`): `boolean` + +Defined in: [module/src/method/runtimeMethod.ts:182](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L182) + +Checks the metadata of the provided runtime module and its method, +to see if it has been decorated with @runtimeMethod() + +## Parameters + +### target + +[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\> + +Runtime module to check + +### propertyKey + +`string` + +Name of the method to check in the prior runtime module + +## Returns + +`boolean` + +- If the provided method name is a runtime method or not diff --git a/src/pages/docs/reference/module/functions/runtimeMessage.md b/src/pages/docs/reference/module/functions/runtimeMessage.md new file mode 100644 index 0000000..911ae89 --- /dev/null +++ b/src/pages/docs/reference/module/functions/runtimeMessage.md @@ -0,0 +1,37 @@ +--- +title: runtimeMessage +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeMessage + +# Function: runtimeMessage() + +> **runtimeMessage**(): (`target`, `methodName`, `descriptor`) => `void` + +Defined in: [module/src/method/runtimeMethod.ts:297](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L297) + +## Returns + +`Function` + +### Parameters + +#### target + +[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\> + +#### methodName + +`string` + +#### descriptor + +`TypedPropertyDescriptor`\<(...`args`) => `Promise`\<`any`\>\> + +### Returns + +`void` diff --git a/src/pages/docs/reference/module/functions/runtimeMethod.md b/src/pages/docs/reference/module/functions/runtimeMethod.md new file mode 100644 index 0000000..fc85080 --- /dev/null +++ b/src/pages/docs/reference/module/functions/runtimeMethod.md @@ -0,0 +1,37 @@ +--- +title: runtimeMethod +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeMethod + +# Function: runtimeMethod() + +> **runtimeMethod**(): (`target`, `methodName`, `descriptor`) => `void` + +Defined in: [module/src/method/runtimeMethod.ts:303](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L303) + +## Returns + +`Function` + +### Parameters + +#### target + +[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\> + +#### methodName + +`string` + +#### descriptor + +`TypedPropertyDescriptor`\<(...`args`) => `Promise`\<`any`\>\> + +### Returns + +`void` diff --git a/src/pages/docs/reference/module/functions/runtimeModule.md b/src/pages/docs/reference/module/functions/runtimeModule.md new file mode 100644 index 0000000..76d869f --- /dev/null +++ b/src/pages/docs/reference/module/functions/runtimeModule.md @@ -0,0 +1,35 @@ +--- +title: runtimeModule +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeModule + +# Function: runtimeModule() + +> **runtimeModule**(): (`target`) => `void` + +Defined in: [module/src/module/decorator.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/module/decorator.ts#L10) + +Marks the decorated class as a runtime module, while also +making it injectable with our dependency injection solution. + +## Returns + +`Function` + +### Parameters + +#### target + +[`StaticConfigurableModule`](../../common/interfaces/StaticConfigurableModule.md)\<`unknown`\> & [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\>\> + +Check if the target class extends RuntimeModule, while +also providing static config presets + +### Returns + +`void` diff --git a/src/pages/docs/reference/module/functions/state.md b/src/pages/docs/reference/module/functions/state.md new file mode 100644 index 0000000..84c7701 --- /dev/null +++ b/src/pages/docs/reference/module/functions/state.md @@ -0,0 +1,40 @@ +--- +title: state +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / state + +# Function: state() + +> **state**(): \<`TargetRuntimeModule`\>(`target`, `propertyKey`) => `void` + +Defined in: [module/src/state/decorator.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/state/decorator.ts#L23) + +Decorates a runtime module property as state, passing down some +underlying values to improve developer experience. + +## Returns + +`Function` + +### Type Parameters + +• **TargetRuntimeModule** *extends* [`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\> + +### Parameters + +#### target + +`TargetRuntimeModule` + +#### propertyKey + +`string` + +### Returns + +`void` diff --git a/src/pages/docs/reference/module/functions/toEventsHash.md b/src/pages/docs/reference/module/functions/toEventsHash.md new file mode 100644 index 0000000..ee595d9 --- /dev/null +++ b/src/pages/docs/reference/module/functions/toEventsHash.md @@ -0,0 +1,25 @@ +--- +title: toEventsHash +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / toEventsHash + +# Function: toEventsHash() + +> **toEventsHash**(`events`): `Field` + +Defined in: [module/src/method/runtimeMethod.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L56) + +## Parameters + +### events + +`object`[] + +## Returns + +`Field` diff --git a/src/pages/docs/reference/module/functions/toStateTransitionsHash.md b/src/pages/docs/reference/module/functions/toStateTransitionsHash.md new file mode 100644 index 0000000..981440f --- /dev/null +++ b/src/pages/docs/reference/module/functions/toStateTransitionsHash.md @@ -0,0 +1,25 @@ +--- +title: toStateTransitionsHash +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / toStateTransitionsHash + +# Function: toStateTransitionsHash() + +> **toStateTransitionsHash**(`stateTransitions`): `Field` + +Defined in: [module/src/method/runtimeMethod.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L39) + +## Parameters + +### stateTransitions + +[`StateTransition`](../../protocol/classes/StateTransition.md)\<`any`\>[] + +## Returns + +`Field` diff --git a/src/pages/docs/reference/module/functions/toWrappedMethod.md b/src/pages/docs/reference/module/functions/toWrappedMethod.md new file mode 100644 index 0000000..575bd31 --- /dev/null +++ b/src/pages/docs/reference/module/functions/toWrappedMethod.md @@ -0,0 +1,39 @@ +--- +title: toWrappedMethod +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / toWrappedMethod + +# Function: toWrappedMethod() + +> **toWrappedMethod**(`this`, `methodName`, `moduleMethod`, `options`): [`AsyncWrappedMethod`](../type-aliases/AsyncWrappedMethod.md) + +Defined in: [module/src/method/runtimeMethod.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L76) + +## Parameters + +### this + +[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\> + +### methodName + +`string` + +### moduleMethod + +(...`args`) => `Promise`\<`any`\> + +### options + +#### invocationType + +[`RuntimeMethodInvocationType`](../type-aliases/RuntimeMethodInvocationType.md) + +## Returns + +[`AsyncWrappedMethod`](../type-aliases/AsyncWrappedMethod.md) diff --git a/src/pages/docs/reference/module/globals.md b/src/pages/docs/reference/module/globals.md new file mode 100644 index 0000000..f295080 --- /dev/null +++ b/src/pages/docs/reference/module/globals.md @@ -0,0 +1,53 @@ +--- +title: "@proto-kit/module" +--- + +[**@proto-kit/module**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/module + +# @proto-kit/module + +## Classes + +- [InMemoryStateService](classes/InMemoryStateService.md) +- [MethodIdFactory](classes/MethodIdFactory.md) +- [MethodIdResolver](classes/MethodIdResolver.md) +- [MethodParameterEncoder](classes/MethodParameterEncoder.md) +- [Runtime](classes/Runtime.md) +- [RuntimeEvents](classes/RuntimeEvents.md) +- [RuntimeModule](classes/RuntimeModule.md) +- [RuntimeZkProgrammable](classes/RuntimeZkProgrammable.md) + +## Interfaces + +- [RuntimeDefinition](interfaces/RuntimeDefinition.md) +- [RuntimeEnvironment](interfaces/RuntimeEnvironment.md) + +## Type Aliases + +- [AsyncWrappedMethod](type-aliases/AsyncWrappedMethod.md) +- [RuntimeMethodInvocationType](type-aliases/RuntimeMethodInvocationType.md) +- [RuntimeModulesRecord](type-aliases/RuntimeModulesRecord.md) +- [WrappedMethod](type-aliases/WrappedMethod.md) + +## Variables + +- [runtimeMethodMetadataKey](variables/runtimeMethodMetadataKey.md) +- [runtimeMethodNamesMetadataKey](variables/runtimeMethodNamesMetadataKey.md) +- [runtimeMethodTypeMetadataKey](variables/runtimeMethodTypeMetadataKey.md) + +## Functions + +- [combineMethodName](functions/combineMethodName.md) +- [getAllPropertyNames](functions/getAllPropertyNames.md) +- [isRuntimeMethod](functions/isRuntimeMethod.md) +- [runtimeMessage](functions/runtimeMessage.md) +- [runtimeMethod](functions/runtimeMethod.md) +- [runtimeModule](functions/runtimeModule.md) +- [state](functions/state.md) +- [toEventsHash](functions/toEventsHash.md) +- [toStateTransitionsHash](functions/toStateTransitionsHash.md) +- [toWrappedMethod](functions/toWrappedMethod.md) diff --git a/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md b/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md new file mode 100644 index 0000000..ced5107 --- /dev/null +++ b/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md @@ -0,0 +1,35 @@ +--- +title: RuntimeDefinition +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeDefinition + +# Interface: RuntimeDefinition\ + +Defined in: [module/src/runtime/Runtime.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L72) + +Definition / required arguments for the Runtime class + +## Type Parameters + +• **Modules** *extends* [`RuntimeModulesRecord`](../type-aliases/RuntimeModulesRecord.md) + +## Properties + +### config? + +> `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: [module/src/runtime/Runtime.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L74) + +*** + +### modules + +> **modules**: `Modules` + +Defined in: [module/src/runtime/Runtime.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L73) diff --git a/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md b/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md new file mode 100644 index 0000000..c6d1ea7 --- /dev/null +++ b/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md @@ -0,0 +1,85 @@ +--- +title: RuntimeEnvironment +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeEnvironment + +# Interface: RuntimeEnvironment + +Defined in: [module/src/runtime/RuntimeEnvironment.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeEnvironment.ts#L10) + +## Extends + +- [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<`undefined`, [`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> + +## Properties + +### zkProgrammable + +> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> + +Defined in: common/dist/zkProgrammable/ZkProgrammable.d.ts:38 + +#### Inherited from + +[`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md).[`zkProgrammable`](../../common/interfaces/WithZkProgrammable.md#zkprogrammable) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [module/src/runtime/RuntimeEnvironment.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeEnvironment.ts#L12) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +*** + +### methodIdResolver + +#### Get Signature + +> **get** **methodIdResolver**(): [`MethodIdResolver`](../classes/MethodIdResolver.md) + +Defined in: [module/src/runtime/RuntimeEnvironment.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeEnvironment.ts#L15) + +##### Returns + +[`MethodIdResolver`](../classes/MethodIdResolver.md) + +*** + +### stateService + +#### Get Signature + +> **get** **stateService**(): [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) + +Defined in: [module/src/runtime/RuntimeEnvironment.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeEnvironment.ts#L13) + +##### Returns + +[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) + +*** + +### stateServiceProvider + +#### Get Signature + +> **get** **stateServiceProvider**(): [`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) + +Defined in: [module/src/runtime/RuntimeEnvironment.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeEnvironment.ts#L14) + +##### Returns + +[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) diff --git a/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md b/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md new file mode 100644 index 0000000..9eff9d2 --- /dev/null +++ b/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md @@ -0,0 +1,25 @@ +--- +title: AsyncWrappedMethod +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / AsyncWrappedMethod + +# Type Alias: AsyncWrappedMethod() + +> **AsyncWrappedMethod**: (...`args`) => `Promise`\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> + +Defined in: [module/src/method/runtimeMethod.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L72) + +## Parameters + +### args + +...[`ArgumentTypes`](../../common/type-aliases/ArgumentTypes.md) + +## Returns + +`Promise`\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> diff --git a/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md b/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md new file mode 100644 index 0000000..7301540 --- /dev/null +++ b/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md @@ -0,0 +1,15 @@ +--- +title: RuntimeMethodInvocationType +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeMethodInvocationType + +# Type Alias: RuntimeMethodInvocationType + +> **RuntimeMethodInvocationType**: `"SIGNATURE"` \| `"INCOMING_MESSAGE"` + +Defined in: [module/src/method/runtimeMethod.ts:191](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L191) diff --git a/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md b/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md new file mode 100644 index 0000000..3a34196 --- /dev/null +++ b/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md @@ -0,0 +1,20 @@ +--- +title: RuntimeModulesRecord +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeModulesRecord + +# Type Alias: RuntimeModulesRecord + +> **RuntimeModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\>\>\> + +Defined in: [module/src/runtime/Runtime.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L60) + +Record of modules accepted by the Runtime module container. + +We have to use TypedClass since RuntimeModule +is an abstract class diff --git a/src/pages/docs/reference/module/type-aliases/WrappedMethod.md b/src/pages/docs/reference/module/type-aliases/WrappedMethod.md new file mode 100644 index 0000000..27f3869 --- /dev/null +++ b/src/pages/docs/reference/module/type-aliases/WrappedMethod.md @@ -0,0 +1,25 @@ +--- +title: WrappedMethod +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / WrappedMethod + +# Type Alias: WrappedMethod() + +> **WrappedMethod**: (...`args`) => [`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md) + +Defined in: [module/src/method/runtimeMethod.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L71) + +## Parameters + +### args + +...[`ArgumentTypes`](../../common/type-aliases/ArgumentTypes.md) + +## Returns + +[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md) diff --git a/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md new file mode 100644 index 0000000..e348bba --- /dev/null +++ b/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md @@ -0,0 +1,15 @@ +--- +title: runtimeMethodMetadataKey +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeMethodMetadataKey + +# Variable: runtimeMethodMetadataKey + +> `const` **runtimeMethodMetadataKey**: `"yab-method"` = `"yab-method"` + +Defined in: [module/src/method/runtimeMethod.ts:170](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L170) diff --git a/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md new file mode 100644 index 0000000..f2dff12 --- /dev/null +++ b/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md @@ -0,0 +1,15 @@ +--- +title: runtimeMethodNamesMetadataKey +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeMethodNamesMetadataKey + +# Variable: runtimeMethodNamesMetadataKey + +> `const` **runtimeMethodNamesMetadataKey**: `"proto-kit-runtime-methods"` = `"proto-kit-runtime-methods"` + +Defined in: [module/src/method/runtimeMethod.ts:171](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L171) diff --git a/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md new file mode 100644 index 0000000..7c0fa82 --- /dev/null +++ b/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md @@ -0,0 +1,15 @@ +--- +title: runtimeMethodTypeMetadataKey +--- + +[**@proto-kit/module**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeMethodTypeMetadataKey + +# Variable: runtimeMethodTypeMetadataKey + +> `const` **runtimeMethodTypeMetadataKey**: `"proto-kit-runtime-method-type"` = `"proto-kit-runtime-method-type"` + +Defined in: [module/src/method/runtimeMethod.ts:172](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L172) diff --git a/src/pages/docs/reference/persistance/README.md b/src/pages/docs/reference/persistance/README.md new file mode 100644 index 0000000..f196fff --- /dev/null +++ b/src/pages/docs/reference/persistance/README.md @@ -0,0 +1,45 @@ +--- +title: "@proto-kit/persistance" +--- + +**@proto-kit/persistance** + +*** + +[Documentation](../../README.md) / @proto-kit/persistance + +# @proto-kit/persistance + +## Classes + +- [BatchMapper](classes/BatchMapper.md) +- [BlockMapper](classes/BlockMapper.md) +- [BlockResultMapper](classes/BlockResultMapper.md) +- [FieldMapper](classes/FieldMapper.md) +- [PrismaBatchStore](classes/PrismaBatchStore.md) +- [PrismaBlockStorage](classes/PrismaBlockStorage.md) +- [PrismaDatabaseConnection](classes/PrismaDatabaseConnection.md) +- [PrismaMessageStorage](classes/PrismaMessageStorage.md) +- [PrismaRedisDatabase](classes/PrismaRedisDatabase.md) +- [PrismaSettlementStorage](classes/PrismaSettlementStorage.md) +- [PrismaStateService](classes/PrismaStateService.md) +- [PrismaTransactionStorage](classes/PrismaTransactionStorage.md) +- [RedisConnectionModule](classes/RedisConnectionModule.md) +- [RedisMerkleTreeStore](classes/RedisMerkleTreeStore.md) +- [SettlementMapper](classes/SettlementMapper.md) +- [StateTransitionArrayMapper](classes/StateTransitionArrayMapper.md) +- [StateTransitionMapper](classes/StateTransitionMapper.md) +- [TransactionExecutionResultMapper](classes/TransactionExecutionResultMapper.md) +- [TransactionMapper](classes/TransactionMapper.md) + +## Interfaces + +- [PrismaConnection](interfaces/PrismaConnection.md) +- [PrismaDatabaseConfig](interfaces/PrismaDatabaseConfig.md) +- [PrismaRedisCombinedConfig](interfaces/PrismaRedisCombinedConfig.md) +- [RedisConnection](interfaces/RedisConnection.md) +- [RedisConnectionConfig](interfaces/RedisConnectionConfig.md) + +## Type Aliases + +- [RedisTransaction](type-aliases/RedisTransaction.md) diff --git a/src/pages/docs/reference/persistance/_meta.tsx b/src/pages/docs/reference/persistance/_meta.tsx new file mode 100644 index 0000000..62983bf --- /dev/null +++ b/src/pages/docs/reference/persistance/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","interfaces": "Interfaces","type-aliases": "Type Aliases" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/persistance/classes/BatchMapper.md b/src/pages/docs/reference/persistance/classes/BatchMapper.md new file mode 100644 index 0000000..ae0b039 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/BatchMapper.md @@ -0,0 +1,71 @@ +--- +title: BatchMapper +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / BatchMapper + +# Class: BatchMapper + +Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L9) + +## Implements + +- `ObjectMapper`\<[`Batch`](../../sequencer/interfaces/Batch.md), \[`PrismaBatch`, `string`[]\]\> + +## Constructors + +### new BatchMapper() + +> **new BatchMapper**(): [`BatchMapper`](BatchMapper.md) + +#### Returns + +[`BatchMapper`](BatchMapper.md) + +## Methods + +### mapIn() + +> **mapIn**(`input`): [`Batch`](../../sequencer/interfaces/Batch.md) + +Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L12) + +#### Parameters + +##### input + +\[\{ `height`: `number`; `proof`: `JsonValue`; `settlementTransactionHash`: `null` \| `string`; \}, `string`[]\] + +#### Returns + +[`Batch`](../../sequencer/interfaces/Batch.md) + +#### Implementation of + +`ObjectMapper.mapIn` + +*** + +### mapOut() + +> **mapOut**(`input`): \[\{ `height`: `number`; `proof`: `JsonValue`; `settlementTransactionHash`: `null` \| `string`; \}, `string`[]\] + +Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L20) + +#### Parameters + +##### input + +[`Batch`](../../sequencer/interfaces/Batch.md) + +#### Returns + +\[\{ `height`: `number`; `proof`: `JsonValue`; `settlementTransactionHash`: `null` \| `string`; \}, `string`[]\] + +#### Implementation of + +`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/BlockMapper.md b/src/pages/docs/reference/persistance/classes/BlockMapper.md new file mode 100644 index 0000000..16f65f1 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/BlockMapper.md @@ -0,0 +1,165 @@ +--- +title: BlockMapper +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / BlockMapper + +# Class: BlockMapper + +Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L10) + +## Implements + +- `ObjectMapper`\<[`Block`](../../sequencer/interfaces/Block.md), `PrismaBlock`\> + +## Constructors + +### new BlockMapper() + +> **new BlockMapper**(): [`BlockMapper`](BlockMapper.md) + +#### Returns + +[`BlockMapper`](BlockMapper.md) + +## Methods + +### mapIn() + +> **mapIn**(`input`): [`Block`](../../sequencer/interfaces/Block.md) + +Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L11) + +#### Parameters + +##### input + +###### batchHeight + +`null` \| `number` + +###### beforeNetworkState + +`JsonValue` + +###### duringNetworkState + +`JsonValue` + +###### fromBlockHashRoot + +`string` + +###### fromEternalTransactionsHash + +`string` + +###### fromMessagesHash + +`string` + +###### hash + +`string` + +###### height + +`number` + +###### parentHash + +`null` \| `string` + +###### toEternalTransactionsHash + +`string` + +###### toMessagesHash + +`string` + +###### transactionsHash + +`string` + +#### Returns + +[`Block`](../../sequencer/interfaces/Block.md) + +#### Implementation of + +`ObjectMapper.mapIn` + +*** + +### mapOut() + +> **mapOut**(`input`): `object` + +Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L40) + +#### Parameters + +##### input + +[`Block`](../../sequencer/interfaces/Block.md) + +#### Returns + +`object` + +##### batchHeight + +> **batchHeight**: `null` \| `number` + +##### beforeNetworkState + +> **beforeNetworkState**: `JsonValue` + +##### duringNetworkState + +> **duringNetworkState**: `JsonValue` + +##### fromBlockHashRoot + +> **fromBlockHashRoot**: `string` + +##### fromEternalTransactionsHash + +> **fromEternalTransactionsHash**: `string` + +##### fromMessagesHash + +> **fromMessagesHash**: `string` + +##### hash + +> **hash**: `string` + +##### height + +> **height**: `number` + +##### parentHash + +> **parentHash**: `null` \| `string` + +##### toEternalTransactionsHash + +> **toEternalTransactionsHash**: `string` + +##### toMessagesHash + +> **toMessagesHash**: `string` + +##### transactionsHash + +> **transactionsHash**: `string` + +#### Implementation of + +`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/BlockResultMapper.md b/src/pages/docs/reference/persistance/classes/BlockResultMapper.md new file mode 100644 index 0000000..c091900 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/BlockResultMapper.md @@ -0,0 +1,125 @@ +--- +title: BlockResultMapper +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / BlockResultMapper + +# Class: BlockResultMapper + +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L11) + +## Implements + +- `ObjectMapper`\<[`BlockResult`](../../sequencer/interfaces/BlockResult.md), `DBBlockResult`\> + +## Constructors + +### new BlockResultMapper() + +> **new BlockResultMapper**(`stArrayMapper`): [`BlockResultMapper`](BlockResultMapper.md) + +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L14) + +#### Parameters + +##### stArrayMapper + +[`StateTransitionArrayMapper`](StateTransitionArrayMapper.md) + +#### Returns + +[`BlockResultMapper`](BlockResultMapper.md) + +## Methods + +### mapIn() + +> **mapIn**(`input`): [`BlockResult`](../../sequencer/interfaces/BlockResult.md) + +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L18) + +#### Parameters + +##### input + +###### afterNetworkState + +`JsonValue` + +###### blockHash + +`string` + +###### blockHashRoot + +`string` + +###### blockHashWitness + +`JsonValue` + +###### blockStateTransitions + +`JsonValue` + +###### stateRoot + +`string` + +#### Returns + +[`BlockResult`](../../sequencer/interfaces/BlockResult.md) + +#### Implementation of + +`ObjectMapper.mapIn` + +*** + +### mapOut() + +> **mapOut**(`input`): `object` + +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L38) + +#### Parameters + +##### input + +[`BlockResult`](../../sequencer/interfaces/BlockResult.md) + +#### Returns + +`object` + +##### afterNetworkState + +> **afterNetworkState**: `JsonValue` + +##### blockHash + +> **blockHash**: `string` + +##### blockHashRoot + +> **blockHashRoot**: `string` + +##### blockHashWitness + +> **blockHashWitness**: `JsonValue` + +##### blockStateTransitions + +> **blockStateTransitions**: `JsonValue` + +##### stateRoot + +> **stateRoot**: `string` + +#### Implementation of + +`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/FieldMapper.md b/src/pages/docs/reference/persistance/classes/FieldMapper.md new file mode 100644 index 0000000..cb36416 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/FieldMapper.md @@ -0,0 +1,71 @@ +--- +title: FieldMapper +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / FieldMapper + +# Class: FieldMapper + +Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L7) + +## Implements + +- `ObjectMapper`\<`Field`[], `string`\> + +## Constructors + +### new FieldMapper() + +> **new FieldMapper**(): [`FieldMapper`](FieldMapper.md) + +#### Returns + +[`FieldMapper`](FieldMapper.md) + +## Methods + +### mapIn() + +> **mapIn**(`input`): `Field`[] + +Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L8) + +#### Parameters + +##### input + +`string` + +#### Returns + +`Field`[] + +#### Implementation of + +`ObjectMapper.mapIn` + +*** + +### mapOut() + +> **mapOut**(`input`): `string` + +Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L12) + +#### Parameters + +##### input + +`Field`[] + +#### Returns + +`string` + +#### Implementation of + +`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md b/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md new file mode 100644 index 0000000..b325cae --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md @@ -0,0 +1,116 @@ +--- +title: PrismaBatchStore +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaBatchStore + +# Class: PrismaBatchStore + +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L14) + +## Implements + +- [`BatchStorage`](../../sequencer/interfaces/BatchStorage.md) +- [`HistoricalBatchStorage`](../../sequencer/interfaces/HistoricalBatchStorage.md) + +## Constructors + +### new PrismaBatchStore() + +> **new PrismaBatchStore**(`connection`, `batchMapper`): [`PrismaBatchStore`](PrismaBatchStore.md) + +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L15) + +#### Parameters + +##### connection + +[`PrismaConnection`](../interfaces/PrismaConnection.md) + +##### batchMapper + +[`BatchMapper`](BatchMapper.md) + +#### Returns + +[`PrismaBatchStore`](PrismaBatchStore.md) + +## Methods + +### getBatchAt() + +> **getBatchAt**(`height`): `Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L20) + +#### Parameters + +##### height + +`number` + +#### Returns + +`Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> + +#### Implementation of + +[`HistoricalBatchStorage`](../../sequencer/interfaces/HistoricalBatchStorage.md).[`getBatchAt`](../../sequencer/interfaces/HistoricalBatchStorage.md#getbatchat) + +*** + +### getCurrentBatchHeight() + +> **getCurrentBatchHeight**(): `Promise`\<`number`\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L42) + +#### Returns + +`Promise`\<`number`\> + +#### Implementation of + +[`BatchStorage`](../../sequencer/interfaces/BatchStorage.md).[`getCurrentBatchHeight`](../../sequencer/interfaces/BatchStorage.md#getcurrentbatchheight) + +*** + +### getLatestBatch() + +> **getLatestBatch**(): `Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L71) + +#### Returns + +`Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> + +#### Implementation of + +[`BatchStorage`](../../sequencer/interfaces/BatchStorage.md).[`getLatestBatch`](../../sequencer/interfaces/BatchStorage.md#getlatestbatch) + +*** + +### pushBatch() + +> **pushBatch**(`batch`): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L51) + +#### Parameters + +##### batch + +[`Batch`](../../sequencer/interfaces/Batch.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`BatchStorage`](../../sequencer/interfaces/BatchStorage.md).[`pushBatch`](../../sequencer/interfaces/BatchStorage.md#pushbatch) diff --git a/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md b/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md new file mode 100644 index 0000000..203f5e6 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md @@ -0,0 +1,205 @@ +--- +title: PrismaBlockStorage +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaBlockStorage + +# Class: PrismaBlockStorage + +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L30) + +## Implements + +- [`BlockQueue`](../../sequencer/interfaces/BlockQueue.md) +- [`BlockStorage`](../../sequencer/interfaces/BlockStorage.md) +- [`HistoricalBlockStorage`](../../sequencer/interfaces/HistoricalBlockStorage.md) + +## Constructors + +### new PrismaBlockStorage() + +> **new PrismaBlockStorage**(`connection`, `transactionResultMapper`, `transactionMapper`, `blockResultMapper`, `blockMapper`): [`PrismaBlockStorage`](PrismaBlockStorage.md) + +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L33) + +#### Parameters + +##### connection + +[`PrismaConnection`](../interfaces/PrismaConnection.md) + +##### transactionResultMapper + +[`TransactionExecutionResultMapper`](TransactionExecutionResultMapper.md) + +##### transactionMapper + +[`TransactionMapper`](TransactionMapper.md) + +##### blockResultMapper + +[`BlockResultMapper`](BlockResultMapper.md) + +##### blockMapper + +[`BlockMapper`](BlockMapper.md) + +#### Returns + +[`PrismaBlockStorage`](PrismaBlockStorage.md) + +## Methods + +### getBlock() + +> **getBlock**(`hash`): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L77) + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> + +#### Implementation of + +[`HistoricalBlockStorage`](../../sequencer/interfaces/HistoricalBlockStorage.md).[`getBlock`](../../sequencer/interfaces/HistoricalBlockStorage.md#getblock) + +*** + +### getBlockAt() + +> **getBlockAt**(`height`): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L73) + +#### Parameters + +##### height + +`number` + +#### Returns + +`Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> + +#### Implementation of + +[`HistoricalBlockStorage`](../../sequencer/interfaces/HistoricalBlockStorage.md).[`getBlockAt`](../../sequencer/interfaces/HistoricalBlockStorage.md#getblockat) + +*** + +### getCurrentBlockHeight() + +> **getCurrentBlockHeight**(): `Promise`\<`number`\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:157](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L157) + +#### Returns + +`Promise`\<`number`\> + +#### Implementation of + +[`BlockStorage`](../../sequencer/interfaces/BlockStorage.md).[`getCurrentBlockHeight`](../../sequencer/interfaces/BlockStorage.md#getcurrentblockheight) + +*** + +### getLatestBlock() + +> **getLatestBlock**(): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:185](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L185) + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> + +#### Implementation of + +[`BlockStorage`](../../sequencer/interfaces/BlockStorage.md).[`getLatestBlock`](../../sequencer/interfaces/BlockStorage.md#getlatestblock) + +*** + +### getLatestBlockAndResult() + +> **getLatestBlockAndResult**(): `Promise`\<`undefined` \| [`BlockWithMaybeResult`](../../sequencer/interfaces/BlockWithMaybeResult.md)\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:167](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L167) + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithMaybeResult`](../../sequencer/interfaces/BlockWithMaybeResult.md)\> + +#### Implementation of + +[`BlockQueue`](../../sequencer/interfaces/BlockQueue.md).[`getLatestBlockAndResult`](../../sequencer/interfaces/BlockQueue.md#getlatestblockandresult) + +*** + +### getNewBlocks() + +> **getNewBlocks**(): `Promise`\<[`BlockWithPreviousResult`](../../sequencer/interfaces/BlockWithPreviousResult.md)[]\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:201](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L201) + +#### Returns + +`Promise`\<[`BlockWithPreviousResult`](../../sequencer/interfaces/BlockWithPreviousResult.md)[]\> + +#### Implementation of + +[`BlockQueue`](../../sequencer/interfaces/BlockQueue.md).[`getNewBlocks`](../../sequencer/interfaces/BlockQueue.md#getnewblocks) + +*** + +### pushBlock() + +> **pushBlock**(`block`): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L81) + +#### Parameters + +##### block + +[`Block`](../../sequencer/interfaces/Block.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`BlockStorage`](../../sequencer/interfaces/BlockStorage.md).[`pushBlock`](../../sequencer/interfaces/BlockStorage.md#pushblock) + +*** + +### pushResult() + +> **pushResult**(`result`): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:139](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L139) + +#### Parameters + +##### result + +[`BlockResult`](../../sequencer/interfaces/BlockResult.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`BlockQueue`](../../sequencer/interfaces/BlockQueue.md).[`pushResult`](../../sequencer/interfaces/BlockQueue.md#pushresult) diff --git a/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md b/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md new file mode 100644 index 0000000..e7886ac --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md @@ -0,0 +1,227 @@ +--- +title: PrismaDatabaseConnection +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaDatabaseConnection + +# Class: PrismaDatabaseConnection + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L37) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Extends + +- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<[`PrismaDatabaseConfig`](../interfaces/PrismaDatabaseConfig.md)\> + +## Implements + +- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) +- [`PrismaConnection`](../interfaces/PrismaConnection.md) + +## Constructors + +### new PrismaDatabaseConnection() + +> **new PrismaDatabaseConnection**(): [`PrismaDatabaseConnection`](PrismaDatabaseConnection.md) + +#### Returns + +[`PrismaDatabaseConnection`](PrismaDatabaseConnection.md) + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`constructor`](../../sequencer/classes/SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`PrismaDatabaseConfig`](../interfaces/PrismaDatabaseConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> + +Defined in: packages/sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`presets`](../../sequencer/classes/SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) + +*** + +### prismaClient + +#### Get Signature + +> **get** **prismaClient**(): `PrismaClient`\<`never`\> + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L43) + +##### Returns + +`PrismaClient`\<`never`\> + +#### Implementation of + +[`PrismaConnection`](../interfaces/PrismaConnection.md).[`prismaClient`](../interfaces/PrismaConnection.md#prismaclient) + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:137](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L137) + +#### Returns + +`Promise`\<`void`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) + +*** + +### dependencies() + +> **dependencies**(): [`OmitKeys`](../../common/type-aliases/OmitKeys.md)\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L50) + +#### Returns + +[`OmitKeys`](../../common/type-aliases/OmitKeys.md)\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> + +#### Implementation of + +[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) + +*** + +### executeInTransaction() + +> **executeInTransaction**(`f`): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:141](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L141) + +#### Parameters + +##### f + +() => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### pruneDatabase() + +> **pruneDatabase**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L82) + +#### Returns + +`Promise`\<`void`\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:117](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L117) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) diff --git a/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md b/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md new file mode 100644 index 0000000..79fd0b9 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md @@ -0,0 +1,93 @@ +--- +title: PrismaMessageStorage +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaMessageStorage + +# Class: PrismaMessageStorage + +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L9) + +Interface to store Messages previously fetched by a IncomingMessageadapter + +## Implements + +- [`MessageStorage`](../../sequencer/interfaces/MessageStorage.md) + +## Constructors + +### new PrismaMessageStorage() + +> **new PrismaMessageStorage**(`connection`, `transactionMapper`): [`PrismaMessageStorage`](PrismaMessageStorage.md) + +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L10) + +#### Parameters + +##### connection + +[`PrismaConnection`](../interfaces/PrismaConnection.md) + +##### transactionMapper + +[`TransactionMapper`](TransactionMapper.md) + +#### Returns + +[`PrismaMessageStorage`](PrismaMessageStorage.md) + +## Methods + +### getMessages() + +> **getMessages**(`fromMessageHash`): `Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> + +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L15) + +#### Parameters + +##### fromMessageHash + +`string` + +#### Returns + +`Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> + +#### Implementation of + +[`MessageStorage`](../../sequencer/interfaces/MessageStorage.md).[`getMessages`](../../sequencer/interfaces/MessageStorage.md#getmessages) + +*** + +### pushMessages() + +> **pushMessages**(`fromMessageHash`, `toMessageHash`, `messages`): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L44) + +#### Parameters + +##### fromMessageHash + +`string` + +##### toMessageHash + +`string` + +##### messages + +[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`MessageStorage`](../../sequencer/interfaces/MessageStorage.md).[`pushMessages`](../../sequencer/interfaces/MessageStorage.md#pushmessages) diff --git a/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md b/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md new file mode 100644 index 0000000..6cdaff8 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md @@ -0,0 +1,298 @@ +--- +title: PrismaRedisDatabase +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaRedisDatabase + +# Class: PrismaRedisDatabase + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L31) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Extends + +- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<[`PrismaRedisCombinedConfig`](../interfaces/PrismaRedisCombinedConfig.md)\> + +## Implements + +- [`PrismaConnection`](../interfaces/PrismaConnection.md) +- [`RedisConnection`](../interfaces/RedisConnection.md) +- [`Database`](../../sequencer/interfaces/Database.md) + +## Constructors + +### new PrismaRedisDatabase() + +> **new PrismaRedisDatabase**(): [`PrismaRedisDatabase`](PrismaRedisDatabase.md) + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L39) + +#### Returns + +[`PrismaRedisDatabase`](PrismaRedisDatabase.md) + +#### Overrides + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`constructor`](../../sequencer/classes/SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`PrismaRedisCombinedConfig`](../interfaces/PrismaRedisCombinedConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) + +*** + +### prisma + +> **prisma**: [`PrismaDatabaseConnection`](PrismaDatabaseConnection.md) + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L35) + +*** + +### redis + +> **redis**: [`RedisConnectionModule`](RedisConnectionModule.md) + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L37) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> + +Defined in: packages/sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`presets`](../../sequencer/classes/SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) + +*** + +### currentMulti + +#### Get Signature + +> **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L53) + +##### Returns + +`RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> + +#### Implementation of + +[`RedisConnection`](../interfaces/RedisConnection.md).[`currentMulti`](../interfaces/RedisConnection.md#currentmulti) + +*** + +### prismaClient + +#### Get Signature + +> **get** **prismaClient**(): `PrismaClient`\<`never`\> + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L45) + +##### Returns + +`PrismaClient`\<`never`\> + +#### Implementation of + +[`PrismaConnection`](../interfaces/PrismaConnection.md).[`prismaClient`](../interfaces/PrismaConnection.md#prismaclient) + +*** + +### redisClient + +#### Get Signature + +> **get** **redisClient**(): `RedisClientType` + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L49) + +##### Returns + +`RedisClientType` + +#### Implementation of + +[`RedisConnection`](../interfaces/RedisConnection.md).[`redisClient`](../interfaces/RedisConnection.md#redisclient) + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L78) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Database`](../../sequencer/interfaces/Database.md).[`close`](../../sequencer/interfaces/Database.md#close) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L57) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Overrides + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) + +*** + +### dependencies() + +> **dependencies**(): [`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md) + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L63) + +#### Returns + +[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md) + +#### Implementation of + +[`Database`](../../sequencer/interfaces/Database.md).[`dependencies`](../../sequencer/interfaces/Database.md#dependencies) + +*** + +### executeInTransaction() + +> **executeInTransaction**(`f`): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L88) + +#### Parameters + +##### f + +() => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Database`](../../sequencer/interfaces/Database.md).[`executeInTransaction`](../../sequencer/interfaces/Database.md#executeintransaction) + +*** + +### pruneDatabase() + +> **pruneDatabase**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L83) + +Prunes all data from the database connection. +Note: This function should only be called immediately at startup, +everything else will lead to unexpected behaviour and errors + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Database`](../../sequencer/interfaces/Database.md).[`pruneDatabase`](../../sequencer/interfaces/Database.md#prunedatabase) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L70) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) diff --git a/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md b/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md new file mode 100644 index 0000000..0f1c2d6 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md @@ -0,0 +1,61 @@ +--- +title: PrismaSettlementStorage +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaSettlementStorage + +# Class: PrismaSettlementStorage + +Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L9) + +## Implements + +- [`SettlementStorage`](../../sequencer/interfaces/SettlementStorage.md) + +## Constructors + +### new PrismaSettlementStorage() + +> **new PrismaSettlementStorage**(`connection`, `settlementMapper`): [`PrismaSettlementStorage`](PrismaSettlementStorage.md) + +Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L10) + +#### Parameters + +##### connection + +[`PrismaConnection`](../interfaces/PrismaConnection.md) + +##### settlementMapper + +[`SettlementMapper`](SettlementMapper.md) + +#### Returns + +[`PrismaSettlementStorage`](PrismaSettlementStorage.md) + +## Methods + +### pushSettlement() + +> **pushSettlement**(`settlement`): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L15) + +#### Parameters + +##### settlement + +[`Settlement`](../../sequencer/interfaces/Settlement.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`SettlementStorage`](../../sequencer/interfaces/SettlementStorage.md).[`pushSettlement`](../../sequencer/interfaces/SettlementStorage.md#pushsettlement) diff --git a/src/pages/docs/reference/persistance/classes/PrismaStateService.md b/src/pages/docs/reference/persistance/classes/PrismaStateService.md new file mode 100644 index 0000000..fa6e1c4 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/PrismaStateService.md @@ -0,0 +1,143 @@ +--- +title: PrismaStateService +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaStateService + +# Class: PrismaStateService + +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L16) + +This Interface should be implemented for services that store the state +in an external storage (like a DB). This can be used in conjunction with +CachedStateService to preload keys for In-Circuit usage. + +## Implements + +- [`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md) + +## Constructors + +### new PrismaStateService() + +> **new PrismaStateService**(`connection`, `mask`): [`PrismaStateService`](PrismaStateService.md) + +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L23) + +#### Parameters + +##### connection + +[`PrismaConnection`](../interfaces/PrismaConnection.md) + +##### mask + +`string` + +A indicator to which masking level the values belong + +#### Returns + +[`PrismaStateService`](PrismaStateService.md) + +## Methods + +### commit() + +> **commit**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L28) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md).[`commit`](../../sequencer/interfaces/AsyncStateService.md#commit) + +*** + +### get() + +> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> + +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L79) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| `Field`[]\> + +#### Implementation of + +[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md).[`get`](../../sequencer/interfaces/AsyncStateService.md#get) + +*** + +### getMany() + +> **getMany**(`keys`): `Promise`\<[`StateEntry`](../../sequencer/interfaces/StateEntry.md)[]\> + +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L54) + +#### Parameters + +##### keys + +`Field`[] + +#### Returns + +`Promise`\<[`StateEntry`](../../sequencer/interfaces/StateEntry.md)[]\> + +#### Implementation of + +[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md).[`getMany`](../../sequencer/interfaces/AsyncStateService.md#getmany) + +*** + +### openTransaction() + +> **openTransaction**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L75) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md).[`openTransaction`](../../sequencer/interfaces/AsyncStateService.md#opentransaction) + +*** + +### writeStates() + +> **writeStates**(`entries`): `void` + +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L84) + +#### Parameters + +##### entries + +[`StateEntry`](../../sequencer/interfaces/StateEntry.md)[] + +#### Returns + +`void` + +#### Implementation of + +[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md).[`writeStates`](../../sequencer/interfaces/AsyncStateService.md#writestates) diff --git a/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md b/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md new file mode 100644 index 0000000..03fee94 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md @@ -0,0 +1,104 @@ +--- +title: PrismaTransactionStorage +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaTransactionStorage + +# Class: PrismaTransactionStorage + +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L9) + +## Implements + +- [`TransactionStorage`](../../sequencer/interfaces/TransactionStorage.md) + +## Constructors + +### new PrismaTransactionStorage() + +> **new PrismaTransactionStorage**(`connection`, `transactionMapper`): [`PrismaTransactionStorage`](PrismaTransactionStorage.md) + +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L10) + +#### Parameters + +##### connection + +[`PrismaConnection`](../interfaces/PrismaConnection.md) + +##### transactionMapper + +[`TransactionMapper`](TransactionMapper.md) + +#### Returns + +[`PrismaTransactionStorage`](PrismaTransactionStorage.md) + +## Methods + +### findTransaction() + +> **findTransaction**(`hash`): `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md); \}\> + +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L42) + +Finds a transaction by its hash. +It returns both pending transaction and already included transactions +In case the transaction has been included, it also returns the block hash +and batch number where applicable. + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md); \}\> + +#### Implementation of + +[`TransactionStorage`](../../sequencer/interfaces/TransactionStorage.md).[`findTransaction`](../../sequencer/interfaces/TransactionStorage.md#findtransaction) + +*** + +### getPendingUserTransactions() + +> **getPendingUserTransactions**(): `Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> + +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L15) + +#### Returns + +`Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> + +#### Implementation of + +[`TransactionStorage`](../../sequencer/interfaces/TransactionStorage.md).[`getPendingUserTransactions`](../../sequencer/interfaces/TransactionStorage.md#getpendingusertransactions) + +*** + +### pushUserTransaction() + +> **pushUserTransaction**(`tx`): `Promise`\<`boolean`\> + +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L31) + +#### Parameters + +##### tx + +[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[`TransactionStorage`](../../sequencer/interfaces/TransactionStorage.md).[`pushUserTransaction`](../../sequencer/interfaces/TransactionStorage.md#pushusertransaction) diff --git a/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md b/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md new file mode 100644 index 0000000..d81305e --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md @@ -0,0 +1,269 @@ +--- +title: RedisConnectionModule +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / RedisConnectionModule + +# Class: RedisConnectionModule + +Defined in: [packages/persistance/src/RedisConnection.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L24) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Extends + +- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<[`RedisConnectionConfig`](../interfaces/RedisConnectionConfig.md)\> + +## Implements + +- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) +- [`RedisConnection`](../interfaces/RedisConnection.md) + +## Constructors + +### new RedisConnectionModule() + +> **new RedisConnectionModule**(): [`RedisConnectionModule`](RedisConnectionModule.md) + +#### Returns + +[`RedisConnectionModule`](RedisConnectionModule.md) + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`constructor`](../../sequencer/classes/SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`RedisConnectionConfig`](../interfaces/RedisConnectionConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> + +Defined in: packages/sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`presets`](../../sequencer/classes/SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) + +*** + +### currentMulti + +#### Get Signature + +> **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> + +Defined in: [packages/persistance/src/RedisConnection.ts:91](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L91) + +##### Returns + +`RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> + +#### Implementation of + +[`RedisConnection`](../interfaces/RedisConnection.md).[`currentMulti`](../interfaces/RedisConnection.md#currentmulti) + +*** + +### redisClient + +#### Get Signature + +> **get** **redisClient**(): `RedisClientType` + +Defined in: [packages/persistance/src/RedisConnection.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L30) + +##### Returns + +`RedisClientType` + +#### Implementation of + +[`RedisConnection`](../interfaces/RedisConnection.md).[`redisClient`](../interfaces/RedisConnection.md#redisclient) + +## Methods + +### clearDatabase() + +> **clearDatabase**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/RedisConnection.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L56) + +#### Returns + +`Promise`\<`void`\> + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/RedisConnection.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L81) + +#### Returns + +`Promise`\<`void`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) + +*** + +### dependencies() + +> **dependencies**(): `Pick`\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> + +Defined in: [packages/persistance/src/RedisConnection.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L39) + +#### Returns + +`Pick`\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> + +#### Implementation of + +[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) + +*** + +### executeInTransaction() + +> **executeInTransaction**(`f`): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/RedisConnection.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L98) + +#### Parameters + +##### f + +() => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### init() + +> **init**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/RedisConnection.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L60) + +#### Returns + +`Promise`\<`void`\> + +*** + +### pruneDatabase() + +> **pruneDatabase**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/RedisConnection.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L85) + +#### Returns + +`Promise`\<`void`\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/RedisConnection.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L77) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) diff --git a/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md b/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md new file mode 100644 index 0000000..57a3abf --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md @@ -0,0 +1,115 @@ +--- +title: RedisMerkleTreeStore +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / RedisMerkleTreeStore + +# Class: RedisMerkleTreeStore + +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L10) + +## Implements + +- [`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md) + +## Constructors + +### new RedisMerkleTreeStore() + +> **new RedisMerkleTreeStore**(`connection`, `mask`): [`RedisMerkleTreeStore`](RedisMerkleTreeStore.md) + +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L13) + +#### Parameters + +##### connection + +[`RedisConnection`](../interfaces/RedisConnection.md) + +##### mask + +`string` = `"base"` + +#### Returns + +[`RedisMerkleTreeStore`](RedisMerkleTreeStore.md) + +## Methods + +### commit() + +> **commit**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L26) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md).[`commit`](../../sequencer/interfaces/AsyncMerkleTreeStore.md#commit) + +*** + +### getNodesAsync() + +> **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> + +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L48) + +#### Parameters + +##### nodes + +[`MerkleTreeNodeQuery`](../../sequencer/interfaces/MerkleTreeNodeQuery.md)[] + +#### Returns + +`Promise`\<(`undefined` \| `bigint`)[]\> + +#### Implementation of + +[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md).[`getNodesAsync`](../../sequencer/interfaces/AsyncMerkleTreeStore.md#getnodesasync) + +*** + +### openTransaction() + +> **openTransaction**(): `Promise`\<`void`\> + +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L22) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md).[`openTransaction`](../../sequencer/interfaces/AsyncMerkleTreeStore.md#opentransaction) + +*** + +### writeNodes() + +> **writeNodes**(`nodes`): `void` + +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L62) + +#### Parameters + +##### nodes + +[`MerkleTreeNode`](../../sequencer/interfaces/MerkleTreeNode.md)[] + +#### Returns + +`void` + +#### Implementation of + +[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md).[`writeNodes`](../../sequencer/interfaces/AsyncMerkleTreeStore.md#writenodes) diff --git a/src/pages/docs/reference/persistance/classes/SettlementMapper.md b/src/pages/docs/reference/persistance/classes/SettlementMapper.md new file mode 100644 index 0000000..8208860 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/SettlementMapper.md @@ -0,0 +1,71 @@ +--- +title: SettlementMapper +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / SettlementMapper + +# Class: SettlementMapper + +Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L8) + +## Implements + +- `ObjectMapper`\<[`Settlement`](../../sequencer/interfaces/Settlement.md), \[`DBSettlement`, `number`[]\]\> + +## Constructors + +### new SettlementMapper() + +> **new SettlementMapper**(): [`SettlementMapper`](SettlementMapper.md) + +#### Returns + +[`SettlementMapper`](SettlementMapper.md) + +## Methods + +### mapIn() + +> **mapIn**(`input`): [`Settlement`](../../sequencer/interfaces/Settlement.md) + +Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L11) + +#### Parameters + +##### input + +\[\{ `promisedMessagesHash`: `string`; `transactionHash`: `string`; \}, `number`[]\] + +#### Returns + +[`Settlement`](../../sequencer/interfaces/Settlement.md) + +#### Implementation of + +`ObjectMapper.mapIn` + +*** + +### mapOut() + +> **mapOut**(`input`): \[\{ `promisedMessagesHash`: `string`; `transactionHash`: `string`; \}, `number`[]\] + +Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L21) + +#### Parameters + +##### input + +[`Settlement`](../../sequencer/interfaces/Settlement.md) + +#### Returns + +\[\{ `promisedMessagesHash`: `string`; `transactionHash`: `string`; \}, `number`[]\] + +#### Implementation of + +`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md b/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md new file mode 100644 index 0000000..9d65ed5 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md @@ -0,0 +1,79 @@ +--- +title: StateTransitionArrayMapper +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / StateTransitionArrayMapper + +# Class: StateTransitionArrayMapper + +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L22) + +## Implements + +- `ObjectMapper`\<[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md)[], `Prisma.JsonValue` \| `undefined`\> + +## Constructors + +### new StateTransitionArrayMapper() + +> **new StateTransitionArrayMapper**(`stMapper`): [`StateTransitionArrayMapper`](StateTransitionArrayMapper.md) + +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L26) + +#### Parameters + +##### stMapper + +[`StateTransitionMapper`](StateTransitionMapper.md) + +#### Returns + +[`StateTransitionArrayMapper`](StateTransitionArrayMapper.md) + +## Methods + +### mapIn() + +> **mapIn**(`input`): [`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md)[] + +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L28) + +#### Parameters + +##### input + +`undefined` | `JsonValue` + +#### Returns + +[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md)[] + +#### Implementation of + +`ObjectMapper.mapIn` + +*** + +### mapOut() + +> **mapOut**(`input`): `JsonValue` + +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L39) + +#### Parameters + +##### input + +[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md)[] + +#### Returns + +`JsonValue` + +#### Implementation of + +`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md b/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md new file mode 100644 index 0000000..e2951d0 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md @@ -0,0 +1,71 @@ +--- +title: StateTransitionMapper +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / StateTransitionMapper + +# Class: StateTransitionMapper + +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L8) + +## Implements + +- `ObjectMapper`\<[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md), `Prisma.JsonObject`\> + +## Constructors + +### new StateTransitionMapper() + +> **new StateTransitionMapper**(): [`StateTransitionMapper`](StateTransitionMapper.md) + +#### Returns + +[`StateTransitionMapper`](StateTransitionMapper.md) + +## Methods + +### mapIn() + +> **mapIn**(`input`): [`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md) + +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L11) + +#### Parameters + +##### input + +`JsonObject` + +#### Returns + +[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md) + +#### Implementation of + +`ObjectMapper.mapIn` + +*** + +### mapOut() + +> **mapOut**(`input`): `JsonObject` + +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L16) + +#### Parameters + +##### input + +[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md) + +#### Returns + +`JsonObject` + +#### Implementation of + +`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md b/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md new file mode 100644 index 0000000..7647b77 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md @@ -0,0 +1,87 @@ +--- +title: TransactionExecutionResultMapper +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / TransactionExecutionResultMapper + +# Class: TransactionExecutionResultMapper + +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L49) + +## Implements + +- `ObjectMapper`\<[`TransactionExecutionResult`](../../sequencer/interfaces/TransactionExecutionResult.md), \[`Omit`\<`DBTransactionExecutionResult`, `"blockHash"`\>, `DBTransaction`\]\> + +## Constructors + +### new TransactionExecutionResultMapper() + +> **new TransactionExecutionResultMapper**(`transactionMapper`, `stArrayMapper`, `eventArrayMapper`): [`TransactionExecutionResultMapper`](TransactionExecutionResultMapper.md) + +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L56) + +#### Parameters + +##### transactionMapper + +[`TransactionMapper`](TransactionMapper.md) + +##### stArrayMapper + +[`StateTransitionArrayMapper`](StateTransitionArrayMapper.md) + +##### eventArrayMapper + +`EventArrayMapper` + +#### Returns + +[`TransactionExecutionResultMapper`](TransactionExecutionResultMapper.md) + +## Methods + +### mapIn() + +> **mapIn**(`input`): [`TransactionExecutionResult`](../../sequencer/interfaces/TransactionExecutionResult.md) + +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L62) + +#### Parameters + +##### input + +\[`Omit`\<\{ `blockHash`: `string`; `events`: `JsonValue`; `protocolTransitions`: `JsonValue`; `stateTransitions`: `JsonValue`; `status`: `boolean`; `statusMessage`: `null` \| `string`; `txHash`: `string`; \}, `"blockHash"`\>, \{ `argsFields`: `string`[]; `auxiliaryData`: `string`[]; `hash`: `string`; `isMessage`: `boolean`; `methodId`: `string`; `nonce`: `string`; `sender`: `string`; `signature_r`: `string`; `signature_s`: `string`; \}\] + +#### Returns + +[`TransactionExecutionResult`](../../sequencer/interfaces/TransactionExecutionResult.md) + +#### Implementation of + +`ObjectMapper.mapIn` + +*** + +### mapOut() + +> **mapOut**(`input`): \[`Omit`\<\{ `blockHash`: `string`; `events`: `JsonValue`; `protocolTransitions`: `JsonValue`; `stateTransitions`: `JsonValue`; `status`: `boolean`; `statusMessage`: `null` \| `string`; `txHash`: `string`; \}, `"blockHash"`\>, \{ `argsFields`: `string`[]; `auxiliaryData`: `string`[]; `hash`: `string`; `isMessage`: `boolean`; `methodId`: `string`; `nonce`: `string`; `sender`: `string`; `signature_r`: `string`; `signature_s`: `string`; \}\] + +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L80) + +#### Parameters + +##### input + +[`TransactionExecutionResult`](../../sequencer/interfaces/TransactionExecutionResult.md) + +#### Returns + +\[`Omit`\<\{ `blockHash`: `string`; `events`: `JsonValue`; `protocolTransitions`: `JsonValue`; `stateTransitions`: `JsonValue`; `status`: `boolean`; `statusMessage`: `null` \| `string`; `txHash`: `string`; \}, `"blockHash"`\>, \{ `argsFields`: `string`[]; `auxiliaryData`: `string`[]; `hash`: `string`; `isMessage`: `boolean`; `methodId`: `string`; `nonce`: `string`; `sender`: `string`; `signature_r`: `string`; `signature_s`: `string`; \}\] + +#### Implementation of + +`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/TransactionMapper.md b/src/pages/docs/reference/persistance/classes/TransactionMapper.md new file mode 100644 index 0000000..b41e066 --- /dev/null +++ b/src/pages/docs/reference/persistance/classes/TransactionMapper.md @@ -0,0 +1,141 @@ +--- +title: TransactionMapper +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / TransactionMapper + +# Class: TransactionMapper + +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L19) + +## Implements + +- `ObjectMapper`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md), `DBTransaction`\> + +## Constructors + +### new TransactionMapper() + +> **new TransactionMapper**(): [`TransactionMapper`](TransactionMapper.md) + +#### Returns + +[`TransactionMapper`](TransactionMapper.md) + +## Methods + +### mapIn() + +> **mapIn**(`input`): [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) + +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L22) + +#### Parameters + +##### input + +###### argsFields + +`string`[] + +###### auxiliaryData + +`string`[] + +###### hash + +`string` + +###### isMessage + +`boolean` + +###### methodId + +`string` + +###### nonce + +`string` + +###### sender + +`string` + +###### signature_r + +`string` + +###### signature_s + +`string` + +#### Returns + +[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) + +#### Implementation of + +`ObjectMapper.mapIn` + +*** + +### mapOut() + +> **mapOut**(`input`): `object` + +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L32) + +#### Parameters + +##### input + +[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) + +#### Returns + +`object` + +##### argsFields + +> **argsFields**: `string`[] + +##### auxiliaryData + +> **auxiliaryData**: `string`[] + +##### hash + +> **hash**: `string` + +##### isMessage + +> **isMessage**: `boolean` + +##### methodId + +> **methodId**: `string` + +##### nonce + +> **nonce**: `string` + +##### sender + +> **sender**: `string` + +##### signature\_r + +> **signature\_r**: `string` + +##### signature\_s + +> **signature\_s**: `string` + +#### Implementation of + +`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md b/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md new file mode 100644 index 0000000..3e0e16e --- /dev/null +++ b/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md @@ -0,0 +1,27 @@ +--- +title: PrismaConnection +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaConnection + +# Interface: PrismaConnection + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L32) + +## Accessors + +### prismaClient + +#### Get Signature + +> **get** **prismaClient**(): `PrismaClient`\<`never`\> + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L33) + +##### Returns + +`PrismaClient`\<`never`\> diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md b/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md new file mode 100644 index 0000000..5fb4f1d --- /dev/null +++ b/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md @@ -0,0 +1,21 @@ +--- +title: PrismaDatabaseConfig +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaDatabaseConfig + +# Interface: PrismaDatabaseConfig + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L16) + +## Properties + +### connection? + +> `optional` **connection**: `string` \| \{ `db`: \{ `name`: `string`; `schema`: `string`; \}; `host`: `string`; `password`: `string`; `port`: `number`; `username`: `string`; \} + +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L18) diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md b/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md new file mode 100644 index 0000000..3b98b43 --- /dev/null +++ b/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md @@ -0,0 +1,29 @@ +--- +title: PrismaRedisCombinedConfig +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaRedisCombinedConfig + +# Interface: PrismaRedisCombinedConfig + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L24) + +## Properties + +### prisma + +> **prisma**: [`PrismaDatabaseConfig`](PrismaDatabaseConfig.md) + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L25) + +*** + +### redis + +> **redis**: [`RedisConnectionConfig`](RedisConnectionConfig.md) + +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L26) diff --git a/src/pages/docs/reference/persistance/interfaces/RedisConnection.md b/src/pages/docs/reference/persistance/interfaces/RedisConnection.md new file mode 100644 index 0000000..8200174 --- /dev/null +++ b/src/pages/docs/reference/persistance/interfaces/RedisConnection.md @@ -0,0 +1,41 @@ +--- +title: RedisConnection +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / RedisConnection + +# Interface: RedisConnection + +Defined in: [packages/persistance/src/RedisConnection.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L19) + +## Accessors + +### currentMulti + +#### Get Signature + +> **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> + +Defined in: [packages/persistance/src/RedisConnection.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L21) + +##### Returns + +`RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> + +*** + +### redisClient + +#### Get Signature + +> **get** **redisClient**(): `RedisClientType` + +Defined in: [packages/persistance/src/RedisConnection.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L20) + +##### Returns + +`RedisClientType` diff --git a/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md b/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md new file mode 100644 index 0000000..85e03b9 --- /dev/null +++ b/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md @@ -0,0 +1,45 @@ +--- +title: RedisConnectionConfig +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / RedisConnectionConfig + +# Interface: RedisConnectionConfig + +Defined in: [packages/persistance/src/RedisConnection.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L10) + +## Properties + +### host + +> **host**: `string` + +Defined in: [packages/persistance/src/RedisConnection.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L11) + +*** + +### password? + +> `optional` **password**: `string` + +Defined in: [packages/persistance/src/RedisConnection.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L12) + +*** + +### port? + +> `optional` **port**: `number` + +Defined in: [packages/persistance/src/RedisConnection.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L13) + +*** + +### username? + +> `optional` **username**: `string` + +Defined in: [packages/persistance/src/RedisConnection.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L14) diff --git a/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md b/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md new file mode 100644 index 0000000..2c45671 --- /dev/null +++ b/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md @@ -0,0 +1,15 @@ +--- +title: RedisTransaction +--- + +[**@proto-kit/persistance**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / RedisTransaction + +# Type Alias: RedisTransaction + +> **RedisTransaction**: `ReturnType`\<`RedisClientType`\[`"multi"`\]\> + +Defined in: [packages/persistance/src/RedisConnection.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L17) diff --git a/src/pages/docs/reference/processor/README.md b/src/pages/docs/reference/processor/README.md new file mode 100644 index 0000000..944d4c4 --- /dev/null +++ b/src/pages/docs/reference/processor/README.md @@ -0,0 +1,42 @@ +--- +title: "@proto-kit/processor" +--- + +**@proto-kit/processor** + +*** + +[Documentation](../../README.md) / @proto-kit/processor + +# @proto-kit/processor + +## Classes + +- [BlockFetching](classes/BlockFetching.md) +- [Database](classes/Database.md) +- [DatabasePruneModule](classes/DatabasePruneModule.md) +- [HandlersExecutor](classes/HandlersExecutor.md) +- [Processor](classes/Processor.md) +- [ProcessorModule](classes/ProcessorModule.md) +- [ResolverFactoryGraphqlModule](classes/ResolverFactoryGraphqlModule.md) +- [TimedProcessorTrigger](classes/TimedProcessorTrigger.md) + +## Interfaces + +- [BlockFetchingConfig](interfaces/BlockFetchingConfig.md) +- [BlockResponse](interfaces/BlockResponse.md) +- [DatabasePruneModuleConfig](interfaces/DatabasePruneModuleConfig.md) +- [HandlersExecutorConfig](interfaces/HandlersExecutorConfig.md) +- [HandlersRecord](interfaces/HandlersRecord.md) +- [TimedProcessorTriggerConfig](interfaces/TimedProcessorTriggerConfig.md) + +## Type Aliases + +- [BlockHandler](type-aliases/BlockHandler.md) +- [ClientTransaction](type-aliases/ClientTransaction.md) +- [ProcessorModulesRecord](type-aliases/ProcessorModulesRecord.md) + +## Functions + +- [cleanResolvers](functions/cleanResolvers.md) +- [ValidateTakeArg](functions/ValidateTakeArg.md) diff --git a/src/pages/docs/reference/processor/_meta.tsx b/src/pages/docs/reference/processor/_meta.tsx new file mode 100644 index 0000000..a31554d --- /dev/null +++ b/src/pages/docs/reference/processor/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/processor/classes/BlockFetching.md b/src/pages/docs/reference/processor/classes/BlockFetching.md new file mode 100644 index 0000000..2e536e1 --- /dev/null +++ b/src/pages/docs/reference/processor/classes/BlockFetching.md @@ -0,0 +1,178 @@ +--- +title: BlockFetching +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / BlockFetching + +# Class: BlockFetching + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L36) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ProcessorModule`](ProcessorModule.md)\<[`BlockFetchingConfig`](../interfaces/BlockFetchingConfig.md)\> + +## Constructors + +### new BlockFetching() + +> **new BlockFetching**(`blockMapper`, `blockResultMapper`, `transactionResultMapper`): [`BlockFetching`](BlockFetching.md) + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L37) + +#### Parameters + +##### blockMapper + +[`BlockMapper`](../../persistance/classes/BlockMapper.md) + +##### blockResultMapper + +[`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) + +##### transactionResultMapper + +[`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) + +#### Returns + +[`BlockFetching`](BlockFetching.md) + +#### Overrides + +[`ProcessorModule`](ProcessorModule.md).[`constructor`](ProcessorModule.md#constructors) + +## Properties + +### blockMapper + +> **blockMapper**: [`BlockMapper`](../../persistance/classes/BlockMapper.md) + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L38) + +*** + +### blockResultMapper + +> **blockResultMapper**: [`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L39) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`BlockFetchingConfig`](../interfaces/BlockFetchingConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`currentConfig`](ProcessorModule.md#currentconfig) + +*** + +### transactionResultMapper + +> **transactionResultMapper**: [`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L40) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`config`](ProcessorModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`create`](ProcessorModule.md#create) + +*** + +### fetchBlock() + +> **fetchBlock**(`height`): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L45) + +#### Parameters + +##### height + +`number` + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:146](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L146) + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`ProcessorModule`](ProcessorModule.md).[`start`](ProcessorModule.md#start) diff --git a/src/pages/docs/reference/processor/classes/Database.md b/src/pages/docs/reference/processor/classes/Database.md new file mode 100644 index 0000000..7dbfb99 --- /dev/null +++ b/src/pages/docs/reference/processor/classes/Database.md @@ -0,0 +1,216 @@ +--- +title: Database +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / Database + +# Class: Database\ + +Defined in: [packages/processor/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L11) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Extends + +- [`ProcessorModule`](ProcessorModule.md)\<[`NoConfig`](../../common/type-aliases/NoConfig.md)\> + +## Type Parameters + +• **PrismaClient** *extends* `BasePrismaClient` + +## Implements + +- `PrismaDatabaseConnection`\<`PrismaClient`\> +- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) + +## Constructors + +### new Database() + +> **new Database**\<`PrismaClient`\>(`prismaClient`): [`Database`](Database.md)\<`PrismaClient`\> + +Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L15) + +#### Parameters + +##### prismaClient + +`PrismaClient` + +#### Returns + +[`Database`](Database.md)\<`PrismaClient`\> + +#### Overrides + +[`ProcessorModule`](ProcessorModule.md).[`constructor`](ProcessorModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`currentConfig`](ProcessorModule.md#currentconfig) + +*** + +### prismaClient + +> **prismaClient**: `PrismaClient` + +Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L15) + +#### Implementation of + +`PrismaDatabaseConnection.prismaClient` + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`config`](ProcessorModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`create`](ProcessorModule.md#create) + +*** + +### dependencies() + +> **dependencies**(): `object` + +Defined in: [packages/processor/src/storage/Database.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L29) + +#### Returns + +`object` + +##### BlockStorage + +> **BlockStorage**: `object` + +###### BlockStorage.useClass + +> **BlockStorage.useClass**: *typeof* `BlockStorage` = `BlockStorage` + +#### Implementation of + +[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) + +*** + +### pruneDatabase() + +> **pruneDatabase**(): `Promise`\<`void`\> + +Defined in: [packages/processor/src/storage/Database.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L37) + +#### Returns + +`Promise`\<`void`\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/processor/src/storage/Database.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L50) + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`ProcessorModule`](ProcessorModule.md).[`start`](ProcessorModule.md#start) + +*** + +### from() + +> `static` **from**\<`PrismaClient`\>(`prismaClient`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Database`](Database.md)\<`PrismaClient`\>\> + +Defined in: [packages/processor/src/storage/Database.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L19) + +#### Type Parameters + +• **PrismaClient** *extends* `BasePrismaClient` + +#### Parameters + +##### prismaClient + +`PrismaClient` + +#### Returns + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Database`](Database.md)\<`PrismaClient`\>\> diff --git a/src/pages/docs/reference/processor/classes/DatabasePruneModule.md b/src/pages/docs/reference/processor/classes/DatabasePruneModule.md new file mode 100644 index 0000000..1a0adf6 --- /dev/null +++ b/src/pages/docs/reference/processor/classes/DatabasePruneModule.md @@ -0,0 +1,128 @@ +--- +title: DatabasePruneModule +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / DatabasePruneModule + +# Class: DatabasePruneModule + +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/DatabasePruneModule.ts#L14) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ProcessorModule`](ProcessorModule.md)\<[`DatabasePruneModuleConfig`](../interfaces/DatabasePruneModuleConfig.md)\> + +## Constructors + +### new DatabasePruneModule() + +> **new DatabasePruneModule**(`database`): [`DatabasePruneModule`](DatabasePruneModule.md) + +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/DatabasePruneModule.ts#L15) + +#### Parameters + +##### database + +[`Database`](Database.md)\<`BasePrismaClient`\> + +#### Returns + +[`DatabasePruneModule`](DatabasePruneModule.md) + +#### Overrides + +[`ProcessorModule`](ProcessorModule.md).[`constructor`](ProcessorModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`DatabasePruneModuleConfig`](../interfaces/DatabasePruneModuleConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`currentConfig`](ProcessorModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`config`](ProcessorModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`create`](ProcessorModule.md#create) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/DatabasePruneModule.ts#L21) + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`ProcessorModule`](ProcessorModule.md).[`start`](ProcessorModule.md#start) diff --git a/src/pages/docs/reference/processor/classes/HandlersExecutor.md b/src/pages/docs/reference/processor/classes/HandlersExecutor.md new file mode 100644 index 0000000..f09f090 --- /dev/null +++ b/src/pages/docs/reference/processor/classes/HandlersExecutor.md @@ -0,0 +1,236 @@ +--- +title: HandlersExecutor +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / HandlersExecutor + +# Class: HandlersExecutor\ + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L28) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ProcessorModule`](ProcessorModule.md)\<[`HandlersExecutorConfig`](../interfaces/HandlersExecutorConfig.md)\> + +## Type Parameters + +• **PrismaClient** *extends* `BasePrismaClient` + +• **Handlers** *extends* [`HandlersRecord`](../interfaces/HandlersRecord.md)\<`PrismaClient`\> + +## Constructors + +### new HandlersExecutor() + +> **new HandlersExecutor**\<`PrismaClient`, `Handlers`\>(): [`HandlersExecutor`](HandlersExecutor.md)\<`PrismaClient`, `Handlers`\> + +#### Returns + +[`HandlersExecutor`](HandlersExecutor.md)\<`PrismaClient`, `Handlers`\> + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`constructor`](ProcessorModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`HandlersExecutorConfig`](../interfaces/HandlersExecutorConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`currentConfig`](ProcessorModule.md#currentconfig) + +*** + +### database + +> **database**: `undefined` \| `PrismaDatabaseConnection`\<`PrismaClient`\> + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L36) + +*** + +### handlers + +> **handlers**: `undefined` \| `Handlers` + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L34) + +*** + +### isExecuting + +> **isExecuting**: `boolean` = `false` + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L32) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`config`](ProcessorModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L38) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Overrides + +[`ProcessorModule`](ProcessorModule.md).[`create`](ProcessorModule.md#create) + +*** + +### execute() + +> **execute**(`block`): `Promise`\<`void`\> + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L83) + +#### Parameters + +##### block + +[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### onAfterHandlers() + +> **onAfterHandlers**(`client`, `block`): `Promise`\<`void`\> + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L72) + +#### Parameters + +##### client + +[`ClientTransaction`](../type-aliases/ClientTransaction.md)\<`PrismaClient`\> + +##### block + +[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### onBlock() + +> **onBlock**(`client`, `block`): `Promise`\<`void`\> + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L60) + +#### Parameters + +##### client + +[`ClientTransaction`](../type-aliases/ClientTransaction.md)\<`PrismaClient`\> + +##### block + +[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L46) + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`ProcessorModule`](ProcessorModule.md).[`start`](ProcessorModule.md#start) + +*** + +### from() + +> `static` **from**\<`PrismaClient`, `Handlers`\>(`handlers`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`HandlersExecutor`](HandlersExecutor.md)\<`PrismaClient`, `Handlers`\>\> + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L48) + +#### Type Parameters + +• **PrismaClient** *extends* `BasePrismaClient` + +• **Handlers** *extends* [`HandlersRecord`](../interfaces/HandlersRecord.md)\<`PrismaClient`\> + +#### Parameters + +##### handlers + +`Handlers` + +#### Returns + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`HandlersExecutor`](HandlersExecutor.md)\<`PrismaClient`, `Handlers`\>\> diff --git a/src/pages/docs/reference/processor/classes/Processor.md b/src/pages/docs/reference/processor/classes/Processor.md new file mode 100644 index 0000000..ab1bd7f --- /dev/null +++ b/src/pages/docs/reference/processor/classes/Processor.md @@ -0,0 +1,618 @@ +--- +title: Processor +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / Processor + +# Class: Processor\ + +Defined in: [packages/processor/src/Processor.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/Processor.ts#L15) + +Reusable module container facilitating registration, resolution +configuration, decoration and validation of modules + +## Extends + +- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Modules`\> + +## Type Parameters + +• **Modules** *extends* [`ProcessorModulesRecord`](../type-aliases/ProcessorModulesRecord.md) + +## Constructors + +### new Processor() + +> **new Processor**\<`Modules`\>(`definition`): [`Processor`](Processor.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:68 + +#### Parameters + +##### definition + +[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +#### Returns + +[`Processor`](Processor.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) + +*** + +### definition + +> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:160 + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) + +*** + +### decorateModule() + +> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:134 + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +`InstanceType`\<`Modules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>\]\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>[] + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +`Modules` + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +`Modules` + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/processor/src/Processor.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/Processor.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`Modules`\>(`definition`): [`Processor`](Processor.md)\<`Modules`\> + +Defined in: [packages/processor/src/Processor.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/Processor.ts#L18) + +#### Type Parameters + +• **Modules** *extends* [`ProcessorModulesRecord`](../type-aliases/ProcessorModulesRecord.md) + +#### Parameters + +##### definition + +[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +#### Returns + +[`Processor`](Processor.md)\<`Modules`\> diff --git a/src/pages/docs/reference/processor/classes/ProcessorModule.md b/src/pages/docs/reference/processor/classes/ProcessorModule.md new file mode 100644 index 0000000..fbe9783 --- /dev/null +++ b/src/pages/docs/reference/processor/classes/ProcessorModule.md @@ -0,0 +1,128 @@ +--- +title: ProcessorModule +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / ProcessorModule + +# Class: `abstract` ProcessorModule\ + +Defined in: [packages/processor/src/ProcessorModule.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/ProcessorModule.ts#L3) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> + +## Extended by + +- [`HandlersExecutor`](HandlersExecutor.md) +- [`Database`](Database.md) +- [`TimedProcessorTrigger`](TimedProcessorTrigger.md) +- [`BlockFetching`](BlockFetching.md) +- [`DatabasePruneModule`](DatabasePruneModule.md) + +## Type Parameters + +• **Config** + +## Constructors + +### new ProcessorModule() + +> **new ProcessorModule**\<`Config`\>(): [`ProcessorModule`](ProcessorModule.md)\<`Config`\> + +#### Returns + +[`ProcessorModule`](ProcessorModule.md)\<`Config`\> + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) + +*** + +### start() + +> `abstract` **start**(): `Promise`\<`void`\> + +Defined in: [packages/processor/src/ProcessorModule.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/ProcessorModule.ts#L6) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md b/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md new file mode 100644 index 0000000..9c6e0ae --- /dev/null +++ b/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md @@ -0,0 +1,170 @@ +--- +title: ResolverFactoryGraphqlModule +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / ResolverFactoryGraphqlModule + +# Class: ResolverFactoryGraphqlModule\ + +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L49) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md) + +## Type Parameters + +• **PrismaClient** *extends* `BasePrismaClient` + +## Constructors + +### new ResolverFactoryGraphqlModule() + +> **new ResolverFactoryGraphqlModule**\<`PrismaClient`\>(`graphqlServer`): [`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\> + +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) + +#### Parameters + +##### graphqlServer + +[`GraphqlServer`](../../api/classes/GraphqlServer.md) + +#### Returns + +[`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\> + +#### Overrides + +[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`constructor`](../../api/classes/ResolverFactoryGraphqlModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`currentConfig`](../../api/classes/ResolverFactoryGraphqlModule.md#currentconfig) + +*** + +### database + +> **database**: `undefined` \| `PrismaDatabaseConnection`\<`PrismaClient`\> + +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L62) + +*** + +### graphqlServer + +> **graphqlServer**: [`GraphqlServer`](../../api/classes/GraphqlServer.md) + +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`config`](../../api/classes/ResolverFactoryGraphqlModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L68) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Overrides + +[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`create`](../../api/classes/ResolverFactoryGraphqlModule.md#create) + +*** + +### resolvers() + +> **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> + +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L77) + +#### Returns + +`Promise`\<`NonEmptyArray`\<`Function`\>\> + +#### Overrides + +[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`resolvers`](../../api/classes/ResolverFactoryGraphqlModule.md#resolvers) + +*** + +### from() + +> `static` **from**\<`PrismaClient`\>(`resolvers`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\>\> + +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L52) + +#### Type Parameters + +• **PrismaClient** *extends* `BasePrismaClient` + +#### Parameters + +##### resolvers + +`NonEmptyArray`\<`Function`\> + +#### Returns + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\>\> diff --git a/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md b/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md new file mode 100644 index 0000000..ea7037a --- /dev/null +++ b/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md @@ -0,0 +1,192 @@ +--- +title: TimedProcessorTrigger +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / TimedProcessorTrigger + +# Class: TimedProcessorTrigger + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L15) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ProcessorModule`](ProcessorModule.md)\<[`TimedProcessorTriggerConfig`](../interfaces/TimedProcessorTriggerConfig.md)\> + +## Constructors + +### new TimedProcessorTrigger() + +> **new TimedProcessorTrigger**(`blockStorage`, `blockFetching`, `handlersExecutor`): [`TimedProcessorTrigger`](TimedProcessorTrigger.md) + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L18) + +#### Parameters + +##### blockStorage + +`BlockStorage` + +##### blockFetching + +[`BlockFetching`](BlockFetching.md) + +##### handlersExecutor + +[`HandlersExecutor`](HandlersExecutor.md)\<`BasePrismaClient`, [`HandlersRecord`](../interfaces/HandlersRecord.md)\<`BasePrismaClient`\>\> + +#### Returns + +[`TimedProcessorTrigger`](TimedProcessorTrigger.md) + +#### Overrides + +[`ProcessorModule`](ProcessorModule.md).[`constructor`](ProcessorModule.md#constructors) + +## Properties + +### blockFetching + +> **blockFetching**: [`BlockFetching`](BlockFetching.md) + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L20) + +*** + +### blockStorage + +> **blockStorage**: `BlockStorage` + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L19) + +*** + +### catchingUp + +> **catchingUp**: `boolean` = `false` + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L16) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`TimedProcessorTriggerConfig`](../interfaces/TimedProcessorTriggerConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`currentConfig`](ProcessorModule.md#currentconfig) + +*** + +### handlersExecutor + +> **handlersExecutor**: [`HandlersExecutor`](HandlersExecutor.md)\<`BasePrismaClient`, [`HandlersRecord`](../interfaces/HandlersRecord.md)\<`BasePrismaClient`\>\> + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L22) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`config`](ProcessorModule.md#config) + +## Methods + +### catchUp() + +> **catchUp**(): `Promise`\<`void`\> + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L61) + +#### Returns + +`Promise`\<`void`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProcessorModule`](ProcessorModule.md).[`create`](ProcessorModule.md#create) + +*** + +### processNextBlock() + +> **processNextBlock**(): `Promise`\<`boolean`\> + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L30) + +#### Returns + +`Promise`\<`boolean`\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L77) + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`ProcessorModule`](ProcessorModule.md).[`start`](ProcessorModule.md#start) diff --git a/src/pages/docs/reference/processor/functions/ValidateTakeArg.md b/src/pages/docs/reference/processor/functions/ValidateTakeArg.md new file mode 100644 index 0000000..f42c3db --- /dev/null +++ b/src/pages/docs/reference/processor/functions/ValidateTakeArg.md @@ -0,0 +1,19 @@ +--- +title: ValidateTakeArg +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / ValidateTakeArg + +# Function: ValidateTakeArg() + +> **ValidateTakeArg**(): `MethodDecorator` + +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L34) + +## Returns + +`MethodDecorator` diff --git a/src/pages/docs/reference/processor/functions/cleanResolvers.md b/src/pages/docs/reference/processor/functions/cleanResolvers.md new file mode 100644 index 0000000..9cdc70c --- /dev/null +++ b/src/pages/docs/reference/processor/functions/cleanResolvers.md @@ -0,0 +1,25 @@ +--- +title: cleanResolvers +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / cleanResolvers + +# Function: cleanResolvers() + +> **cleanResolvers**(`resolvers`): `NonEmptyArray`\<`Function`\> + +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L12) + +## Parameters + +### resolvers + +`NonEmptyArray`\<`Function`\> + +## Returns + +`NonEmptyArray`\<`Function`\> diff --git a/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md b/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md new file mode 100644 index 0000000..fe36add --- /dev/null +++ b/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md @@ -0,0 +1,21 @@ +--- +title: BlockFetchingConfig +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / BlockFetchingConfig + +# Interface: BlockFetchingConfig + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L19) + +## Properties + +### url + +> **url**: `string` + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L20) diff --git a/src/pages/docs/reference/processor/interfaces/BlockResponse.md b/src/pages/docs/reference/processor/interfaces/BlockResponse.md new file mode 100644 index 0000000..a5ab58d --- /dev/null +++ b/src/pages/docs/reference/processor/interfaces/BlockResponse.md @@ -0,0 +1,111 @@ +--- +title: BlockResponse +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / BlockResponse + +# Interface: BlockResponse + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L23) + +## Properties + +### data + +> **data**: `object` + +Defined in: [packages/processor/src/indexer/BlockFetching.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L24) + +#### findFirstBlock + +> **findFirstBlock**: `object` & `object` & `object` + +##### Type declaration + +###### batchHeight + +> **batchHeight**: `null` \| `number` + +###### beforeNetworkState + +> **beforeNetworkState**: `JsonValue` + +###### duringNetworkState + +> **duringNetworkState**: `JsonValue` + +###### fromBlockHashRoot + +> **fromBlockHashRoot**: `string` + +###### fromEternalTransactionsHash + +> **fromEternalTransactionsHash**: `string` + +###### fromMessagesHash + +> **fromMessagesHash**: `string` + +###### hash + +> **hash**: `string` + +###### height + +> **height**: `number` + +###### parentHash + +> **parentHash**: `null` \| `string` + +###### toEternalTransactionsHash + +> **toEternalTransactionsHash**: `string` + +###### toMessagesHash + +> **toMessagesHash**: `string` + +###### transactionsHash + +> **transactionsHash**: `string` + +##### Type declaration + +###### result + +> **result**: `object` + +###### result.afterNetworkState + +> **result.afterNetworkState**: `JsonValue` + +###### result.blockHash + +> **result.blockHash**: `string` + +###### result.blockHashRoot + +> **result.blockHashRoot**: `string` + +###### result.blockHashWitness + +> **result.blockHashWitness**: `JsonValue` + +###### result.blockStateTransitions + +> **result.blockStateTransitions**: `JsonValue` + +###### result.stateRoot + +> **result.stateRoot**: `string` + +##### Type declaration + +###### transactions + +> **transactions**: `object` & `object`[] diff --git a/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md b/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md new file mode 100644 index 0000000..2071577 --- /dev/null +++ b/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md @@ -0,0 +1,21 @@ +--- +title: DatabasePruneModuleConfig +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / DatabasePruneModuleConfig + +# Interface: DatabasePruneModuleConfig + +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/DatabasePruneModule.ts#L9) + +## Properties + +### pruneOnStartup? + +> `optional` **pruneOnStartup**: `boolean` + +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/DatabasePruneModule.ts#L10) diff --git a/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md b/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md new file mode 100644 index 0000000..5af3aa3 --- /dev/null +++ b/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md @@ -0,0 +1,29 @@ +--- +title: HandlersExecutorConfig +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / HandlersExecutorConfig + +# Interface: HandlersExecutorConfig + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L22) + +## Properties + +### maxWait? + +> `optional` **maxWait**: `number` + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L23) + +*** + +### timeout? + +> `optional` **timeout**: `number` + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L24) diff --git a/src/pages/docs/reference/processor/interfaces/HandlersRecord.md b/src/pages/docs/reference/processor/interfaces/HandlersRecord.md new file mode 100644 index 0000000..67c6d5d --- /dev/null +++ b/src/pages/docs/reference/processor/interfaces/HandlersRecord.md @@ -0,0 +1,25 @@ +--- +title: HandlersRecord +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / HandlersRecord + +# Interface: HandlersRecord\ + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L18) + +## Type Parameters + +• **PrismaClient** *extends* `BasePrismaClient` + +## Properties + +### onBlock + +> **onBlock**: [`BlockHandler`](../type-aliases/BlockHandler.md)\<`PrismaClient`\>[] + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L19) diff --git a/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md b/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md new file mode 100644 index 0000000..9ecae67 --- /dev/null +++ b/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md @@ -0,0 +1,21 @@ +--- +title: TimedProcessorTriggerConfig +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / TimedProcessorTriggerConfig + +# Interface: TimedProcessorTriggerConfig + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L10) + +## Properties + +### interval? + +> `optional` **interval**: `number` + +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L11) diff --git a/src/pages/docs/reference/processor/type-aliases/BlockHandler.md b/src/pages/docs/reference/processor/type-aliases/BlockHandler.md new file mode 100644 index 0000000..b505093 --- /dev/null +++ b/src/pages/docs/reference/processor/type-aliases/BlockHandler.md @@ -0,0 +1,33 @@ +--- +title: BlockHandler +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / BlockHandler + +# Type Alias: BlockHandler()\ + +> **BlockHandler**\<`PrismaClient`\>: (`client`, `block`) => `Promise`\<`void`\> + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L13) + +## Type Parameters + +• **PrismaClient** *extends* `BasePrismaClient` + +## Parameters + +### client + +[`ClientTransaction`](ClientTransaction.md)\<`PrismaClient`\> + +### block + +[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md) + +## Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md b/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md new file mode 100644 index 0000000..5c0549d --- /dev/null +++ b/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md @@ -0,0 +1,19 @@ +--- +title: ClientTransaction +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / ClientTransaction + +# Type Alias: ClientTransaction\ + +> **ClientTransaction**\<`PrismaClient`\>: `Parameters`\<`Parameters`\<`PrismaClient`\[`"$transaction"`\]\>\[`0`\]\>\[`0`\] + +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L10) + +## Type Parameters + +• **PrismaClient** *extends* `BasePrismaClient` diff --git a/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md b/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md new file mode 100644 index 0000000..1124685 --- /dev/null +++ b/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md @@ -0,0 +1,15 @@ +--- +title: ProcessorModulesRecord +--- + +[**@proto-kit/processor**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / ProcessorModulesRecord + +# Type Alias: ProcessorModulesRecord + +> **ProcessorModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ProcessorModule`](../classes/ProcessorModule.md)\<`unknown`\>\>\> + +Defined in: [packages/processor/src/Processor.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/Processor.ts#L11) diff --git a/src/pages/docs/reference/protocol/README.md b/src/pages/docs/reference/protocol/README.md new file mode 100644 index 0000000..10f39a7 --- /dev/null +++ b/src/pages/docs/reference/protocol/README.md @@ -0,0 +1,55 @@ +--- +title: "@proto-kit/protocol" +--- + +**@proto-kit/protocol** + +*** + +[Documentation](../../README.md) / @proto-kit/protocol + +# YAB: Protocol + +Protocol contains to all circuit-aware data types and provers + +### StateTransitionProver + +The StateTransitionProver takes a list of StateTransitions, checks and proves their precondition and update to the respective merkletree represented by the state root public input. + +In the public input, the prover transitions from two fields: + +- state root +- transitions hash + +The transitions hash is the commitment to a hash list where every state transition gets appended one-by-one. + +The StateTransitionsProver batches the application of multiple state transitions together. +If the amount of state transitions if greater than the batch size, the seperate proofs can be merged together. + +In the end, the publicInput of the StateTransitionProof should contain the following content: + +- `fromTransitionsHash: 0` To prove that all STs have been applied, the transitionsHash must start at zero (i.e. a empty hash list) +- `toTransitionsHash` This value must be the same as the transitionsHash in the AppChainProof to guarantee that all (and same) statetransitions that have been outputted by the AppChain have been applied +- `from- and toStateRoot` These values represent the root of the state tree and will later be stitched together to arrive at the final stateroot for a bundle + +### BlockProver + +The BlockProver's responsibility is to verify and put together the AppChainProof and StateTransitionProof. +It verifies that the transitionsHash is the same across both proofs and then takes the new state root proved by the STProof. + +In the end, the BlockProof proofs that: + +- the AppChain has been executed correctly +- the resulting state changes have been applied correctly and fully to the state root + +Multiple BlockProofs will then be merged together, signed by the sequencer and published to the base layer. + +### RollupMerkleTree + +The RollupMerkleTree is a custom merkle tree implementation that supports the injection of a storage adapter. +The interface for that adapter can be found as the interface `MerkleTreeStorage`. + +Adapters can implement any storage backend, like In-Memory and Database, and supports a process called "virtualization". +Virtualization is the process of layering different Adapters on top of each other. +For example if I want to simulate some transactions to a merkle tree, I can virtualize a database adapter into a MemoryAdapter. +If I am happy with the result, I can merge the results into the database or, if not, discard them without writing the changes to the database. diff --git a/src/pages/docs/reference/protocol/_meta.tsx b/src/pages/docs/reference/protocol/_meta.tsx new file mode 100644 index 0000000..4d63940 --- /dev/null +++ b/src/pages/docs/reference/protocol/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/protocol/classes/AccountState.md b/src/pages/docs/reference/protocol/classes/AccountState.md new file mode 100644 index 0000000..241ee41 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/AccountState.md @@ -0,0 +1,357 @@ +--- +title: AccountState +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / AccountState + +# Class: AccountState + +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/AccountStateHook.ts#L10) + +## Extends + +- `object` + +## Constructors + +### new AccountState() + +> **new AccountState**(`value`): [`AccountState`](AccountState.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### nonce + +`UInt64` = `UInt64` + +#### Returns + +[`AccountState`](AccountState.md) + +#### Inherited from + +`Struct({ nonce: UInt64, }).constructor` + +## Properties + +### nonce + +> **nonce**: `UInt64` = `UInt64` + +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/AccountStateHook.ts#L11) + +#### Inherited from + +`Struct({ nonce: UInt64, }).nonce` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ nonce: UInt64, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### nonce + +`UInt64` = `UInt64` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ nonce: UInt64, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### nonce + +> **nonce**: `UInt64` = `UInt64` + +#### Inherited from + +`Struct({ nonce: UInt64, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### nonce + +> **nonce**: `UInt64` = `UInt64` + +#### Inherited from + +`Struct({ nonce: UInt64, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### nonce + +`string` = `UInt64` + +#### Returns + +`object` + +##### nonce + +> **nonce**: `UInt64` = `UInt64` + +#### Inherited from + +`Struct({ nonce: UInt64, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ nonce: UInt64, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### nonce + +`UInt64` = `UInt64` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ nonce: UInt64, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### nonce + +`UInt64` = `UInt64` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ nonce: UInt64, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### nonce + +`UInt64` = `UInt64` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ nonce: UInt64, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### nonce + +`UInt64` = `UInt64` + +#### Returns + +`object` + +##### nonce + +> **nonce**: `string` = `UInt64` + +#### Inherited from + +`Struct({ nonce: UInt64, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### nonce + +`UInt64` = `UInt64` + +#### Returns + +`object` + +##### nonce + +> **nonce**: `bigint` = `UInt64` + +#### Inherited from + +`Struct({ nonce: UInt64, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ nonce: UInt64, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/AccountStateHook.md b/src/pages/docs/reference/protocol/classes/AccountStateHook.md new file mode 100644 index 0000000..74c25b3 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/AccountStateHook.md @@ -0,0 +1,190 @@ +--- +title: AccountStateHook +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / AccountStateHook + +# Class: AccountStateHook + +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/AccountStateHook.ts#L15) + +## Extends + +- [`ProvableTransactionHook`](ProvableTransactionHook.md) + +## Constructors + +### new AccountStateHook() + +> **new AccountStateHook**(): [`AccountStateHook`](AccountStateHook.md) + +#### Returns + +[`AccountStateHook`](AccountStateHook.md) + +#### Inherited from + +[`ProvableTransactionHook`](ProvableTransactionHook.md).[`constructor`](ProvableTransactionHook.md#constructors) + +## Properties + +### accountState + +> **accountState**: [`StateMap`](StateMap.md)\<`PublicKey`, [`AccountState`](AccountState.md)\> + +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/AccountStateHook.ts#L16) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProvableTransactionHook`](ProvableTransactionHook.md).[`currentConfig`](ProvableTransactionHook.md#currentconfig) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) + +#### Inherited from + +[`ProvableTransactionHook`](ProvableTransactionHook.md).[`name`](ProvableTransactionHook.md#name) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Inherited from + +[`ProvableTransactionHook`](ProvableTransactionHook.md).[`protocol`](ProvableTransactionHook.md#protocol) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +[`ProvableTransactionHook`](ProvableTransactionHook.md).[`areProofsEnabled`](ProvableTransactionHook.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProvableTransactionHook`](ProvableTransactionHook.md).[`config`](ProvableTransactionHook.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProvableTransactionHook`](ProvableTransactionHook.md).[`create`](ProvableTransactionHook.md#create) + +*** + +### onTransaction() + +> **onTransaction**(`__namedParameters`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/AccountStateHook.ts#L21) + +#### Parameters + +##### \_\_namedParameters + +[`BlockProverExecutionData`](BlockProverExecutionData.md) + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`ProvableTransactionHook`](ProvableTransactionHook.md).[`onTransaction`](ProvableTransactionHook.md#ontransaction) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`ProvableTransactionHook`](ProvableTransactionHook.md).[`start`](ProvableTransactionHook.md#start) diff --git a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md new file mode 100644 index 0000000..87d6d94 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md @@ -0,0 +1,291 @@ +--- +title: BlockHashMerkleTree +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockHashMerkleTree + +# Class: BlockHashMerkleTree + +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L4) + +## Extends + +- [`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md) + +## Constructors + +### new BlockHashMerkleTree() + +> **new BlockHashMerkleTree**(`store`): [`BlockHashMerkleTree`](BlockHashMerkleTree.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:113 + +#### Parameters + +##### store + +[`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) + +#### Returns + +[`BlockHashMerkleTree`](BlockHashMerkleTree.md) + +#### Inherited from + +`createMerkleTree(40).constructor` + +## Properties + +### leafCount + +> `readonly` **leafCount**: `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:78 + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`leafCount`](../../common/interfaces/AbstractMerkleTree.md#leafcount) + +*** + +### store + +> **store**: [`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:77 + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`store`](../../common/interfaces/AbstractMerkleTree.md#store) + +*** + +### EMPTY\_ROOT + +> `static` **EMPTY\_ROOT**: `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:118 + +#### Inherited from + +`createMerkleTree(40).EMPTY_ROOT` + +*** + +### HEIGHT + +> `static` **HEIGHT**: `number` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:117 + +#### Inherited from + +`createMerkleTree(40).HEIGHT` + +*** + +### WITNESS + +> `static` **WITNESS**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:114 + +#### Type declaration + +##### dummy() + +> **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +###### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +#### Inherited from + +`createMerkleTree(40).WITNESS` + +## Accessors + +### leafCount + +#### Get Signature + +> **get** `static` **leafCount**(): `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:119 + +##### Returns + +`bigint` + +#### Inherited from + +`createMerkleTree(40).leafCount` + +## Methods + +### assertIndexRange() + +> **assertIndexRange**(`index`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:79 + +#### Parameters + +##### index + +`bigint` + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`assertIndexRange`](../../common/interfaces/AbstractMerkleTree.md#assertindexrange) + +*** + +### fill() + +> **fill**(`leaves`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:110 + +Fills all leaves of the tree. + +#### Parameters + +##### leaves + +`Field`[] + +Values to fill the leaves with. + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`fill`](../../common/interfaces/AbstractMerkleTree.md#fill) + +*** + +### getNode() + +> **getNode**(`level`, `index`): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:86 + +Returns a node which lives at a given index and level. + +#### Parameters + +##### level + +`number` + +Level of the node. + +##### index + +`bigint` + +Index of the node. + +#### Returns + +`Field` + +The data of the node. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getNode`](../../common/interfaces/AbstractMerkleTree.md#getnode) + +*** + +### getRoot() + +> **getRoot**(): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:91 + +Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). + +#### Returns + +`Field` + +The root of the Merkle Tree. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getRoot`](../../common/interfaces/AbstractMerkleTree.md#getroot) + +*** + +### getWitness() + +> **getWitness**(`index`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:105 + +Returns the witness (also known as +[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) +for the leaf at the given index. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +#### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +The witness that belongs to the leaf. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getWitness`](../../common/interfaces/AbstractMerkleTree.md#getwitness) + +*** + +### setLeaf() + +> **setLeaf**(`index`, `leaf`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:97 + +Sets the value of a leaf node at a given index to a given value. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +##### leaf + +`Field` + +New value. + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`setLeaf`](../../common/interfaces/AbstractMerkleTree.md#setleaf) diff --git a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md new file mode 100644 index 0000000..8114bee --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md @@ -0,0 +1,575 @@ +--- +title: BlockHashMerkleTreeWitness +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockHashMerkleTreeWitness + +# Class: BlockHashMerkleTreeWitness + +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L5) + +## Extends + +- [`WITNESS`](VKTree.md#witness) + +## Constructors + +### new BlockHashMerkleTreeWitness() + +> **new BlockHashMerkleTreeWitness**(`value`): [`BlockHashMerkleTreeWitness`](BlockHashMerkleTreeWitness.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:4 + +#### Parameters + +##### value + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +[`BlockHashMerkleTreeWitness`](BlockHashMerkleTreeWitness.md) + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.constructor` + +## Properties + +### isLeft + +> **isLeft**: `Bool`[] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:9 + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.isLeft` + +*** + +### path + +> **path**: `Field`[] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:8 + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.path` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:11 + +#### Inherited from + +`BlockHashMerkleTree.WITNESS._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`void` + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.check` + +*** + +### dummy() + +> `static` **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:115 + +#### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.dummy` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:52 + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:19 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:45 + +#### Parameters + +##### x + +###### isLeft + +`boolean`[] + +###### path + +`string`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:31 + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:38 + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `boolean`[] + +##### path + +> **path**: `string`[] + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `boolean`[] + +##### path + +> **path**: `bigint`[] + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.toValue` + +## Methods + +### calculateIndex() + +> **calculateIndex**(): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:71 + +Calculates the index of the leaf node that belongs to this Witness. + +#### Returns + +`Field` + +Index of the leaf. + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.calculateIndex` + +*** + +### calculateRoot() + +> **calculateRoot**(`hash`): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:66 + +Calculates a root depending on the leaf value. + +#### Parameters + +##### hash + +`Field` + +#### Returns + +`Field` + +The calculated root. + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.calculateRoot` + +*** + +### checkMembership() + +> **checkMembership**(`root`, `key`, `value`): `Bool` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:72 + +#### Parameters + +##### root + +`Field` + +##### key + +`Field` + +##### value + +`Field` + +#### Returns + +`Bool` + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.checkMembership` + +*** + +### checkMembershipGetRoots() + +> **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:73 + +#### Parameters + +##### root + +`Field` + +##### key + +`Field` + +##### value + +`Field` + +#### Returns + +\[`Bool`, `Field`, `Field`\] + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.checkMembershipGetRoots` + +*** + +### height() + +> **height**(): `number` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:60 + +#### Returns + +`number` + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.height` + +*** + +### toShortenedEntries() + +> **toShortenedEntries**(): `string`[] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:74 + +#### Returns + +`string`[] + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.toShortenedEntries` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`BlockHashMerkleTree.WITNESS.sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md b/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md new file mode 100644 index 0000000..f4654d6 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md @@ -0,0 +1,433 @@ +--- +title: BlockHashTreeEntry +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockHashTreeEntry + +# Class: BlockHashTreeEntry + +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L7) + +## Extends + +- `object` + +## Constructors + +### new BlockHashTreeEntry() + +> **new BlockHashTreeEntry**(`value`): [`BlockHashTreeEntry`](BlockHashTreeEntry.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### blockHash + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +#### Returns + +[`BlockHashTreeEntry`](BlockHashTreeEntry.md) + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).constructor` + +## Properties + +### blockHash + +> **blockHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L8) + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).blockHash` + +*** + +### closed + +> **closed**: `Bool` = `Bool` + +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L9) + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).closed` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### blockHash + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### blockHash + +> **blockHash**: `Field` = `Field` + +##### closed + +> **closed**: `Bool` = `Bool` + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### blockHash + +> **blockHash**: `Field` = `Field` + +##### closed + +> **closed**: `Bool` = `Bool` + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### blockHash + +`string` = `Field` + +###### closed + +`boolean` = `Bool` + +#### Returns + +`object` + +##### blockHash + +> **blockHash**: `Field` = `Field` + +##### closed + +> **closed**: `Bool` = `Bool` + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### blockHash + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### blockHash + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### blockHash + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### blockHash + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +#### Returns + +`object` + +##### blockHash + +> **blockHash**: `string` = `Field` + +##### closed + +> **closed**: `boolean` = `Bool` + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### blockHash + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +#### Returns + +`object` + +##### blockHash + +> **blockHash**: `bigint` = `Field` + +##### closed + +> **closed**: `boolean` = `Bool` + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).toValue` + +## Methods + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L13) + +#### Returns + +`Field` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/BlockHeightHook.md b/src/pages/docs/reference/protocol/classes/BlockHeightHook.md new file mode 100644 index 0000000..084b7fd --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BlockHeightHook.md @@ -0,0 +1,204 @@ +--- +title: BlockHeightHook +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockHeightHook + +# Class: BlockHeightHook + +Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/BlockHeightHook.ts#L4) + +## Extends + +- [`ProvableBlockHook`](ProvableBlockHook.md)\<`Record`\<`string`, `never`\>\> + +## Constructors + +### new BlockHeightHook() + +> **new BlockHeightHook**(): [`BlockHeightHook`](BlockHeightHook.md) + +#### Returns + +[`BlockHeightHook`](BlockHeightHook.md) + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`constructor`](ProvableBlockHook.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Record`\<`string`, `never`\> + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`currentConfig`](ProvableBlockHook.md#currentconfig) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`name`](ProvableBlockHook.md#name) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`protocol`](ProvableBlockHook.md#protocol) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`areProofsEnabled`](ProvableBlockHook.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`config`](ProvableBlockHook.md#config) + +## Methods + +### afterBlock() + +> **afterBlock**(`networkState`): `Promise`\<[`NetworkState`](NetworkState.md)\> + +Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/BlockHeightHook.ts#L5) + +#### Parameters + +##### networkState + +[`NetworkState`](NetworkState.md) + +#### Returns + +`Promise`\<[`NetworkState`](NetworkState.md)\> + +#### Overrides + +[`ProvableBlockHook`](ProvableBlockHook.md).[`afterBlock`](ProvableBlockHook.md#afterblock) + +*** + +### beforeBlock() + +> **beforeBlock**(`networkState`): `Promise`\<[`NetworkState`](NetworkState.md)\> + +Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/BlockHeightHook.ts#L14) + +#### Parameters + +##### networkState + +[`NetworkState`](NetworkState.md) + +#### Returns + +`Promise`\<[`NetworkState`](NetworkState.md)\> + +#### Overrides + +[`ProvableBlockHook`](ProvableBlockHook.md).[`beforeBlock`](ProvableBlockHook.md#beforeblock) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`create`](ProvableBlockHook.md#create) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`start`](ProvableBlockHook.md#start) diff --git a/src/pages/docs/reference/protocol/classes/BlockProver.md b/src/pages/docs/reference/protocol/classes/BlockProver.md new file mode 100644 index 0000000..409dfd8 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BlockProver.md @@ -0,0 +1,333 @@ +--- +title: BlockProver +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProver + +# Class: BlockProver + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:907](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L907) + +BlockProver class, which aggregates a AppChainProof and +a StateTransitionProof into a single BlockProof, that can +then be merged to be committed to the base-layer contract + +## Extends + +- [`ProtocolModule`](ProtocolModule.md) + +## Implements + +- [`BlockProvable`](../interfaces/BlockProvable.md) +- [`CompilableModule`](../../common/interfaces/CompilableModule.md) + +## Constructors + +### new BlockProver() + +> **new BlockProver**(`stateTransitionProver`, `runtime`, `transactionHooks`, `blockHooks`, `verificationKeyService`): [`BlockProver`](BlockProver.md) + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:913](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L913) + +#### Parameters + +##### stateTransitionProver + +[`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> & [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) + +##### runtime + +[`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> & [`CompilableModule`](../../common/interfaces/CompilableModule.md) + +##### transactionHooks + +[`ProvableTransactionHook`](ProvableTransactionHook.md)\<`unknown`\>[] + +##### blockHooks + +[`ProvableBlockHook`](ProvableBlockHook.md)\<`unknown`\>[] + +##### verificationKeyService + +[`RuntimeVerificationKeyRootService`](RuntimeVerificationKeyRootService.md) + +#### Returns + +[`BlockProver`](BlockProver.md) + +#### Overrides + +[`ProtocolModule`](ProtocolModule.md).[`constructor`](ProtocolModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`currentConfig`](ProtocolModule.md#currentconfig) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`protocol`](ProtocolModule.md#protocol) + +*** + +### runtime + +> `readonly` **runtime**: [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> & [`CompilableModule`](../../common/interfaces/CompilableModule.md) + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:921](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L921) + +*** + +### stateTransitionProver + +> `readonly` **stateTransitionProver**: [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> & [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:915](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L915) + +*** + +### zkProgrammable + +> **zkProgrammable**: [`BlockProverProgrammable`](BlockProverProgrammable.md) + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:911](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L911) + +#### Implementation of + +[`BlockProvable`](../interfaces/BlockProvable.md).[`zkProgrammable`](../interfaces/BlockProvable.md#zkprogrammable) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`areProofsEnabled`](ProtocolModule.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`config`](ProtocolModule.md#config) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<`undefined` \| `Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:940](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L940) + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`undefined` \| `Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> + +#### Implementation of + +[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`create`](ProtocolModule.md#create) + +*** + +### merge() + +> **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:983](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L983) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](BlockProverPublicInput.md) + +##### proof1 + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +##### proof2 + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +#### Implementation of + +[`BlockProvable`](../interfaces/BlockProvable.md).[`merge`](../interfaces/BlockProvable.md#merge) + +*** + +### proveBlock() + +> **proveBlock**(`publicInput`, `networkState`, `blockWitness`, `transactionProof`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:967](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L967) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](BlockProverPublicInput.md) + +##### networkState + +[`NetworkState`](NetworkState.md) + +##### blockWitness + +[`BlockHashMerkleTreeWitness`](BlockHashMerkleTreeWitness.md) + +##### transactionProof + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +#### Implementation of + +[`BlockProvable`](../interfaces/BlockProvable.md).[`proveBlock`](../interfaces/BlockProvable.md#proveblock) + +*** + +### proveTransaction() + +> **proveTransaction**(`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:951](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L951) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](BlockProverPublicInput.md) + +##### stateProof + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +##### appProof + +[`DynamicRuntimeProof`](DynamicRuntimeProof.md) + +##### executionData + +[`BlockProverExecutionData`](BlockProverExecutionData.md) + +##### verificationKeyAttestation + +[`RuntimeVerificationKeyAttestation`](RuntimeVerificationKeyAttestation.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +#### Implementation of + +[`BlockProvable`](../interfaces/BlockProvable.md).[`proveTransaction`](../interfaces/BlockProvable.md#provetransaction) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`start`](ProtocolModule.md#start) diff --git a/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md b/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md new file mode 100644 index 0000000..472f9c5 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md @@ -0,0 +1,643 @@ +--- +title: BlockProverExecutionData +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverExecutionData + +# Class: BlockProverExecutionData + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L57) + +## Extends + +- `object` + +## Constructors + +### new BlockProverExecutionData() + +> **new BlockProverExecutionData**(`value`): [`BlockProverExecutionData`](BlockProverExecutionData.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +[`BlockProverExecutionData`](BlockProverExecutionData.md) + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).constructor` + +## Properties + +### networkState + +> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L60) + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).networkState` + +*** + +### signature + +> **signature**: `Signature` = `Signature` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L59) + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).signature` + +*** + +### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L58) + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).transaction` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### networkState + +> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` + +##### signature + +> **signature**: `Signature` = `Signature` + +##### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`, `aux`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 + +A function that returns an element of type `T` from the given provable and "auxiliary" data. + +This function is the reverse operation of calling [toFields](BlockProverExecutionData.md#tofields) and toAuxilary methods on an element of type `T`. + +#### Parameters + +##### fields + +`Field`[] + +an array of Field elements describing the provable data of the new `T` element. + +##### aux + +`any`[] + +an array of any type describing the "auxiliary" data of the new `T` element, optional. + +#### Returns + +`object` + +An element of type `T` generated from the given provable and "auxiliary" data. + +##### networkState + +> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` + +##### signature + +> **signature**: `Signature` = `Signature` + +##### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### networkState + +\{ `block`: \{ `height`: `string`; \}; `previous`: \{ `rootHash`: `string`; \}; \} = `NetworkState` + +###### networkState.block + +\{ `height`: `string`; \} = `CurrentBlock` + +###### networkState.block.height + +`string` = `UInt64` + +###### networkState.previous + +\{ `rootHash`: `string`; \} = `PreviousBlock` + +###### networkState.previous.rootHash + +`string` = `Field` + +###### signature + +`any` = `Signature` + +###### transaction + +\{ `argsHash`: `string`; `methodId`: `string`; `nonce`: \{ `isSome`: `boolean`; `value`: `any`; \}; `sender`: \{ `isSome`: `boolean`; `value`: `any`; \}; \} = `RuntimeTransaction` + +###### transaction.argsHash + +`string` = `Field` + +###### transaction.methodId + +`string` = `Field` + +###### transaction.nonce + +\{ `isSome`: `boolean`; `value`: `any`; \} = `UInt64Option` + +###### transaction.nonce.isSome + +`boolean` = `Bool` + +###### transaction.nonce.value + +`any` = `valueType` + +###### transaction.sender + +\{ `isSome`: `boolean`; `value`: `any`; \} = `PublicKeyOption` + +###### transaction.sender.isSome + +`boolean` = `Bool` + +###### transaction.sender.value + +`any` = `valueType` + +#### Returns + +`object` + +##### networkState + +> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` + +##### signature + +> **signature**: `Signature` = `Signature` + +##### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`object` + +##### networkState + +> **networkState**: `object` = `NetworkState` + +###### networkState.block + +> **networkState.block**: `object` = `CurrentBlock` + +###### networkState.block.height + +> **networkState.block.height**: `string` = `UInt64` + +###### networkState.previous + +> **networkState.previous**: `object` = `PreviousBlock` + +###### networkState.previous.rootHash + +> **networkState.previous.rootHash**: `string` = `Field` + +##### signature + +> **signature**: `any` = `Signature` + +##### transaction + +> **transaction**: `object` = `RuntimeTransaction` + +###### transaction.argsHash + +> **transaction.argsHash**: `string` = `Field` + +###### transaction.methodId + +> **transaction.methodId**: `string` = `Field` + +###### transaction.nonce + +> **transaction.nonce**: `object` = `UInt64Option` + +###### transaction.nonce.isSome + +> **transaction.nonce.isSome**: `boolean` = `Bool` + +###### transaction.nonce.value + +> **transaction.nonce.value**: `any` = `valueType` + +###### transaction.sender + +> **transaction.sender**: `object` = `PublicKeyOption` + +###### transaction.sender.isSome + +> **transaction.sender.isSome**: `boolean` = `Bool` + +###### transaction.sender.value + +> **transaction.sender.value**: `any` = `valueType` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`object` + +##### networkState + +> **networkState**: `object` = `NetworkState` + +###### networkState.block + +> **networkState.block**: `object` = `CurrentBlock` + +###### networkState.block.height + +> **networkState.block.height**: `bigint` = `UInt64` + +###### networkState.previous + +> **networkState.previous**: `object` = `PreviousBlock` + +###### networkState.previous.rootHash + +> **networkState.previous.rootHash**: `bigint` = `Field` + +##### signature + +> **signature**: `any` = `Signature` + +##### transaction + +> **transaction**: `object` = `RuntimeTransaction` + +###### transaction.argsHash + +> **transaction.argsHash**: `bigint` = `Field` + +###### transaction.methodId + +> **transaction.methodId**: `bigint` = `Field` + +###### transaction.nonce + +> **transaction.nonce**: `object` = `UInt64Option` + +###### transaction.nonce.isSome + +> **transaction.nonce.isSome**: `boolean` = `Bool` + +###### transaction.nonce.value + +> **transaction.nonce.value**: `any` = `valueType` + +###### transaction.sender + +> **transaction.sender**: `object` = `PublicKeyOption` + +###### transaction.sender.isSome + +> **transaction.sender.isSome**: `boolean` = `Bool` + +###### transaction.sender.value + +> **transaction.sender.value**: `any` = `valueType` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md b/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md new file mode 100644 index 0000000..2676d3d --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md @@ -0,0 +1,318 @@ +--- +title: BlockProverProgrammable +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverProgrammable + +# Class: BlockProverProgrammable + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:135](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L135) + +## Extends + +- [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`BlockProverPublicInput`](BlockProverPublicInput.md), [`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +## Constructors + +### new BlockProverProgrammable() + +> **new BlockProverProgrammable**(`prover`, `stateTransitionProver`, `runtime`, `transactionHooks`, `blockHooks`, `verificationKeyService`): [`BlockProverProgrammable`](BlockProverProgrammable.md) + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:139](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L139) + +#### Parameters + +##### prover + +[`BlockProver`](BlockProver.md) + +##### stateTransitionProver + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +##### runtime + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> + +##### transactionHooks + +[`ProvableTransactionHook`](ProvableTransactionHook.md)\<`unknown`\>[] + +##### blockHooks + +[`ProvableBlockHook`](ProvableBlockHook.md)\<`unknown`\>[] + +##### verificationKeyService + +[`MinimalVKTreeService`](../interfaces/MinimalVKTreeService.md) + +#### Returns + +[`BlockProverProgrammable`](BlockProverProgrammable.md) + +#### Overrides + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`constructor`](../../common/classes/ZkProgrammable.md#constructors) + +## Properties + +### name + +> **name**: `string` = `"BlockProver"` + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:153](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L153) + +*** + +### runtime + +> `readonly` **runtime**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:145](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L145) + +*** + +### stateTransitionProver + +> `readonly` **stateTransitionProver**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:141](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L141) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:155](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L155) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Overrides + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`areProofsEnabled`](../../common/classes/ZkProgrammable.md#areproofsenabled) + +*** + +### zkProgram + +#### Get Signature + +> **get** **zkProgram**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] + +Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:34 + +##### Returns + +[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] + +#### Inherited from + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgram`](../../common/classes/ZkProgrammable.md#zkprogram) + +## Methods + +### applyTransaction() + +> **applyTransaction**(`state`, `stateTransitionProof`, `runtimeProof`, `executionData`, `verificationKey`): `Promise`\<[`BlockProverState`](../interfaces/BlockProverState.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:170](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L170) + +Applies and checks the two proofs and applies the corresponding state +changes to the given state + +#### Parameters + +##### state + +[`BlockProverState`](../interfaces/BlockProverState.md) + +The from-state of the BlockProver + +##### stateTransitionProof + +`Proof`\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +##### runtimeProof + +[`DynamicRuntimeProof`](DynamicRuntimeProof.md) + +##### executionData + +[`BlockProverExecutionData`](BlockProverExecutionData.md) + +##### verificationKey + +`VerificationKey` + +#### Returns + +`Promise`\<[`BlockProverState`](../interfaces/BlockProverState.md)\> + +The new BlockProver-state to be used as public output + +*** + +### assertProtocolTransitions() + +> **assertProtocolTransitions**(`stateTransitionProof`, `executionData`, `runtimeProof`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:264](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L264) + +#### Parameters + +##### stateTransitionProof + +`Proof`\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +##### executionData + +[`BlockProverExecutionData`](BlockProverExecutionData.md) + +##### runtimeProof + +`DynamicProof`\<`void`, [`MethodPublicOutput`](MethodPublicOutput.md)\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### compile() + +> **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> + +Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:35 + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> + +#### Inherited from + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`compile`](../../common/classes/ZkProgrammable.md#compile) + +*** + +### merge() + +> **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:656](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L656) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](BlockProverPublicInput.md) + +##### proof1 + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +##### proof2 + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +*** + +### proveBlock() + +> **proveBlock**(`publicInput`, `networkState`, `blockWitness`, `transactionProof`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:482](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L482) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](BlockProverPublicInput.md) + +##### networkState + +[`NetworkState`](NetworkState.md) + +##### blockWitness + +[`BlockHashMerkleTreeWitness`](BlockHashMerkleTreeWitness.md) + +##### transactionProof + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +*** + +### proveTransaction() + +> **proveTransaction**(`publicInput`, `stateProof`, `runtimeProof`, `executionData`, `verificationKeyWitness`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L406) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](BlockProverPublicInput.md) + +##### stateProof + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +##### runtimeProof + +[`DynamicRuntimeProof`](DynamicRuntimeProof.md) + +##### executionData + +[`BlockProverExecutionData`](BlockProverExecutionData.md) + +##### verificationKeyWitness + +[`RuntimeVerificationKeyAttestation`](RuntimeVerificationKeyAttestation.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +*** + +### zkProgramFactory() + +> **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`BlockProverPublicInput`](BlockProverPublicInput.md), [`BlockProverPublicOutput`](BlockProverPublicOutput.md)\>[] + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:798](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L798) + +Creates the BlockProver ZkProgram. +Recursive linking of proofs is done via the previously +injected StateTransitionProver and the required AppChainProof class + +#### Returns + +[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`BlockProverPublicInput`](BlockProverPublicInput.md), [`BlockProverPublicOutput`](BlockProverPublicOutput.md)\>[] + +#### Overrides + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgramFactory`](../../common/classes/ZkProgrammable.md#zkprogramfactory) diff --git a/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md b/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md new file mode 100644 index 0000000..019b1fd --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md @@ -0,0 +1,741 @@ +--- +title: BlockProverPublicInput +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverPublicInput + +# Class: BlockProverPublicInput + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L20) + +## Extends + +- `object` + +## Constructors + +### new BlockProverPublicInput() + +> **new BlockProverPublicInput**(`value`): [`BlockProverPublicInput`](BlockProverPublicInput.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +[`BlockProverPublicInput`](BlockProverPublicInput.md) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).constructor` + +## Properties + +### blockHashRoot + +> **blockHashRoot**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L24) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).blockHashRoot` + +*** + +### blockNumber + +> **blockNumber**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L27) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).blockNumber` + +*** + +### eternalTransactionsHash + +> **eternalTransactionsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L25) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).eternalTransactionsHash` + +*** + +### incomingMessagesHash + +> **incomingMessagesHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L26) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).incomingMessagesHash` + +*** + +### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L23) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).networkStateHash` + +*** + +### stateRoot + +> **stateRoot**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L22) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).stateRoot` + +*** + +### transactionsHash + +> **transactionsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L21) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).transactionsHash` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### blockHashRoot + +> **blockHashRoot**: `Field` = `Field` + +##### blockNumber + +> **blockNumber**: `Field` = `Field` + +##### eternalTransactionsHash + +> **eternalTransactionsHash**: `Field` = `Field` + +##### incomingMessagesHash + +> **incomingMessagesHash**: `Field` = `Field` + +##### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### transactionsHash + +> **transactionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### blockHashRoot + +> **blockHashRoot**: `Field` = `Field` + +##### blockNumber + +> **blockNumber**: `Field` = `Field` + +##### eternalTransactionsHash + +> **eternalTransactionsHash**: `Field` = `Field` + +##### incomingMessagesHash + +> **incomingMessagesHash**: `Field` = `Field` + +##### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### transactionsHash + +> **transactionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### blockHashRoot + +`string` = `Field` + +###### blockNumber + +`string` = `Field` + +###### eternalTransactionsHash + +`string` = `Field` + +###### incomingMessagesHash + +`string` = `Field` + +###### networkStateHash + +`string` = `Field` + +###### stateRoot + +`string` = `Field` + +###### transactionsHash + +`string` = `Field` + +#### Returns + +`object` + +##### blockHashRoot + +> **blockHashRoot**: `Field` = `Field` + +##### blockNumber + +> **blockNumber**: `Field` = `Field` + +##### eternalTransactionsHash + +> **eternalTransactionsHash**: `Field` = `Field` + +##### incomingMessagesHash + +> **incomingMessagesHash**: `Field` = `Field` + +##### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### transactionsHash + +> **transactionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### blockHashRoot + +> **blockHashRoot**: `string` = `Field` + +##### blockNumber + +> **blockNumber**: `string` = `Field` + +##### eternalTransactionsHash + +> **eternalTransactionsHash**: `string` = `Field` + +##### incomingMessagesHash + +> **incomingMessagesHash**: `string` = `Field` + +##### networkStateHash + +> **networkStateHash**: `string` = `Field` + +##### stateRoot + +> **stateRoot**: `string` = `Field` + +##### transactionsHash + +> **transactionsHash**: `string` = `Field` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### blockHashRoot + +> **blockHashRoot**: `bigint` = `Field` + +##### blockNumber + +> **blockNumber**: `bigint` = `Field` + +##### eternalTransactionsHash + +> **eternalTransactionsHash**: `bigint` = `Field` + +##### incomingMessagesHash + +> **incomingMessagesHash**: `bigint` = `Field` + +##### networkStateHash + +> **networkStateHash**: `bigint` = `Field` + +##### stateRoot + +> **stateRoot**: `bigint` = `Field` + +##### transactionsHash + +> **transactionsHash**: `bigint` = `Field` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md b/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md new file mode 100644 index 0000000..ab6a6b7 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md @@ -0,0 +1,827 @@ +--- +title: BlockProverPublicOutput +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverPublicOutput + +# Class: BlockProverPublicOutput + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L30) + +## Extends + +- `object` + +## Constructors + +### new BlockProverPublicOutput() + +> **new BlockProverPublicOutput**(`value`): [`BlockProverPublicOutput`](BlockProverPublicOutput.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +[`BlockProverPublicOutput`](BlockProverPublicOutput.md) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).constructor` + +## Properties + +### blockHashRoot + +> **blockHashRoot**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L34) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).blockHashRoot` + +*** + +### blockNumber + +> **blockNumber**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L38) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).blockNumber` + +*** + +### closed + +> **closed**: `Bool` = `Bool` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L37) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).closed` + +*** + +### eternalTransactionsHash + +> **eternalTransactionsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L35) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).eternalTransactionsHash` + +*** + +### incomingMessagesHash + +> **incomingMessagesHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L36) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).incomingMessagesHash` + +*** + +### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L33) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).networkStateHash` + +*** + +### stateRoot + +> **stateRoot**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L32) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).stateRoot` + +*** + +### transactionsHash + +> **transactionsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L31) + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).transactionsHash` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### blockHashRoot + +> **blockHashRoot**: `Field` = `Field` + +##### blockNumber + +> **blockNumber**: `Field` = `Field` + +##### closed + +> **closed**: `Bool` = `Bool` + +##### eternalTransactionsHash + +> **eternalTransactionsHash**: `Field` = `Field` + +##### incomingMessagesHash + +> **incomingMessagesHash**: `Field` = `Field` + +##### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### transactionsHash + +> **transactionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### blockHashRoot + +> **blockHashRoot**: `Field` = `Field` + +##### blockNumber + +> **blockNumber**: `Field` = `Field` + +##### closed + +> **closed**: `Bool` = `Bool` + +##### eternalTransactionsHash + +> **eternalTransactionsHash**: `Field` = `Field` + +##### incomingMessagesHash + +> **incomingMessagesHash**: `Field` = `Field` + +##### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### transactionsHash + +> **transactionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### blockHashRoot + +`string` = `Field` + +###### blockNumber + +`string` = `Field` + +###### closed + +`boolean` = `Bool` + +###### eternalTransactionsHash + +`string` = `Field` + +###### incomingMessagesHash + +`string` = `Field` + +###### networkStateHash + +`string` = `Field` + +###### stateRoot + +`string` = `Field` + +###### transactionsHash + +`string` = `Field` + +#### Returns + +`object` + +##### blockHashRoot + +> **blockHashRoot**: `Field` = `Field` + +##### blockNumber + +> **blockNumber**: `Field` = `Field` + +##### closed + +> **closed**: `Bool` = `Bool` + +##### eternalTransactionsHash + +> **eternalTransactionsHash**: `Field` = `Field` + +##### incomingMessagesHash + +> **incomingMessagesHash**: `Field` = `Field` + +##### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### transactionsHash + +> **transactionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### blockHashRoot + +> **blockHashRoot**: `string` = `Field` + +##### blockNumber + +> **blockNumber**: `string` = `Field` + +##### closed + +> **closed**: `boolean` = `Bool` + +##### eternalTransactionsHash + +> **eternalTransactionsHash**: `string` = `Field` + +##### incomingMessagesHash + +> **incomingMessagesHash**: `string` = `Field` + +##### networkStateHash + +> **networkStateHash**: `string` = `Field` + +##### stateRoot + +> **stateRoot**: `string` = `Field` + +##### transactionsHash + +> **transactionsHash**: `string` = `Field` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### blockHashRoot + +`Field` = `Field` + +###### blockNumber + +`Field` = `Field` + +###### closed + +`Bool` = `Bool` + +###### eternalTransactionsHash + +`Field` = `Field` + +###### incomingMessagesHash + +`Field` = `Field` + +###### networkStateHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### transactionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### blockHashRoot + +> **blockHashRoot**: `bigint` = `Field` + +##### blockNumber + +> **blockNumber**: `bigint` = `Field` + +##### closed + +> **closed**: `boolean` = `Bool` + +##### eternalTransactionsHash + +> **eternalTransactionsHash**: `bigint` = `Field` + +##### incomingMessagesHash + +> **incomingMessagesHash**: `bigint` = `Field` + +##### networkStateHash + +> **networkStateHash**: `bigint` = `Field` + +##### stateRoot + +> **stateRoot**: `bigint` = `Field` + +##### transactionsHash + +> **transactionsHash**: `bigint` = `Field` + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).toValue` + +## Methods + +### equals() + +> **equals**(`input`, `closed`): `Bool` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L40) + +#### Parameters + +##### input + +[`BlockProverPublicInput`](BlockProverPublicInput.md) + +##### closed + +`Bool` + +#### Returns + +`Bool` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/BridgeContract.md b/src/pages/docs/reference/protocol/classes/BridgeContract.md new file mode 100644 index 0000000..97440c6 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BridgeContract.md @@ -0,0 +1,1587 @@ +--- +title: BridgeContract +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BridgeContract + +# Class: BridgeContract + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:211](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L211) + +## Extends + +- [`BridgeContractBase`](BridgeContractBase.md) + +## Implements + +- [`BridgeContractType`](../type-aliases/BridgeContractType.md) + +## Constructors + +### new BridgeContract() + +> **new BridgeContract**(`address`, `tokenId`?): [`BridgeContract`](BridgeContract.md) + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 + +#### Parameters + +##### address + +`PublicKey` + +##### tokenId? + +`Field` + +#### Returns + +[`BridgeContract`](BridgeContract.md) + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`constructor`](BridgeContractBase.md#constructors) + +## Properties + +### address + +> **address**: `PublicKey` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`address`](BridgeContractBase.md#address-1) + +*** + +### events + +> **events**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:315 + +A list of event types that can be emitted using this.emitEvent()`. + +#### Index Signature + +\[`key`: `string`\]: `FlexibleProvablePure`\<`any`\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`events`](BridgeContractBase.md#events) + +*** + +### outgoingMessageCursor + +> **outgoingMessageCursor**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:219](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L219) + +#### Implementation of + +`BridgeContractType.outgoingMessageCursor` + +#### Overrides + +[`BridgeContractBase`](BridgeContractBase.md).[`outgoingMessageCursor`](BridgeContractBase.md#outgoingmessagecursor) + +*** + +### sender + +> **sender**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 + +#### self + +> **self**: `SmartContract` + +#### ~~getAndRequireSignature()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key. + +#### getAndRequireSignatureV2() + +Return a public key that is forced to sign this transaction. + +Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created +the transaction controls the private key associated with the returned public key. + +##### Returns + +`PublicKey` + +#### ~~getUnconstrained()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getUnconstrainedV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key, +which would cause an account update with that public key to not be included. + +#### getUnconstrainedV2() + +The public key of the current transaction's sender account. + +Throws an error if not inside a transaction, or the sender wasn't passed in. + +**Warning**: The fact that this public key equals the current sender is not part of the proof. +A malicious prover could use any other public key without affecting the validity of the proof. + +Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. + +##### Returns + +`PublicKey` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`sender`](BridgeContractBase.md#sender) + +*** + +### settlementContractAddress + +> **settlementContractAddress**: `State`\<`PublicKey`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:215](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L215) + +#### Overrides + +[`BridgeContractBase`](BridgeContractBase.md).[`settlementContractAddress`](BridgeContractBase.md#settlementcontractaddress) + +*** + +### stateRoot + +> **stateRoot**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:217](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L217) + +#### Implementation of + +`BridgeContractType.stateRoot` + +#### Overrides + +[`BridgeContractBase`](BridgeContractBase.md).[`stateRoot`](BridgeContractBase.md#stateroot) + +*** + +### tokenId + +> **tokenId**: `Field` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`tokenId`](BridgeContractBase.md#tokenid-1) + +*** + +### \_maxProofsVerified? + +> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`_maxProofsVerified`](BridgeContractBase.md#_maxproofsverified) + +*** + +### \_methodMetadata? + +> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`_methodMetadata`](BridgeContractBase.md#_methodmetadata) + +*** + +### \_methods? + +> `static` `optional` **\_methods**: `MethodInterface`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`_methods`](BridgeContractBase.md#_methods) + +*** + +### \_provers? + +> `static` `optional` **\_provers**: `Prover`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`_provers`](BridgeContractBase.md#_provers) + +*** + +### \_verificationKey? + +> `static` `optional` **\_verificationKey**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 + +#### data + +> **data**: `string` + +#### hash + +> **hash**: `Field` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`_verificationKey`](BridgeContractBase.md#_verificationkey) + +*** + +### args + +> `static` **args**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) + +#### SettlementContract + +> **SettlementContract**: `undefined` \| [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> & *typeof* `SmartContract` + +#### withdrawalStatePath + +> **withdrawalStatePath**: \[`string`, `string`\] + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`args`](BridgeContractBase.md#args) + +*** + +### MAX\_ACCOUNT\_UPDATES + +> `static` **MAX\_ACCOUNT\_UPDATES**: `number` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:94 + +The maximum number of account updates using the token in a single +transaction that this contract supports. + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`MAX_ACCOUNT_UPDATES`](BridgeContractBase.md#max_account_updates) + +## Accessors + +### account + +#### Get Signature + +> **get** **account**(): `Account` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 + +Current account of the SmartContract. + +##### Returns + +`Account` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`account`](BridgeContractBase.md#account) + +*** + +### balance + +#### Get Signature + +> **get** **balance**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 + +Balance of this SmartContract. + +##### Returns + +`object` + +###### addInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +###### subInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`balance`](BridgeContractBase.md#balance) + +*** + +### currentSlot + +#### Get Signature + +> **get** **currentSlot**(): `CurrentSlot` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 + +Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value +at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) +or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) + +##### Returns + +`CurrentSlot` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`currentSlot`](BridgeContractBase.md#currentslot) + +*** + +### internal + +#### Get Signature + +> **get** **internal**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:47 + +Helper methods to use from within a token contract. + +##### Returns + +`object` + +###### burn() + +###### Parameters + +###### \_\_namedParameters + +###### address + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### Returns + +`AccountUpdate` + +###### mint() + +###### Parameters + +###### \_\_namedParameters + +###### address + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### Returns + +`AccountUpdate` + +###### send() + +###### Parameters + +###### \_\_namedParameters + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### from + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### to + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### Returns + +`AccountUpdate` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`internal`](BridgeContractBase.md#internal) + +*** + +### network + +#### Get Signature + +> **get** **network**(): `Network` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 + +Current network state of the SmartContract. + +##### Returns + +`Network` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`network`](BridgeContractBase.md#network) + +*** + +### self + +#### Get Signature + +> **get** **self**(): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 + +Returns the current AccountUpdate associated to this SmartContract. + +##### Returns + +`AccountUpdate` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`self`](BridgeContractBase.md#self) + +## Methods + +### approve() + +> **approve**(`update`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 + +Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, +which allows you to read and use its content in a proof, make assertions about it, and modify it. + +```ts +`@method` myApprovingMethod(update: AccountUpdate) { + this.approve(update); + + // read balance on the account (for example) + let balance = update.account.balance.getAndRequireEquals(); +} +``` + +Under the hood, "approving" just means that the account update is made a child of the zkApp in the +tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, +the entire tree will become a subtree of the zkApp's account update. + +Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update +at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally +excluding important information from the public input. + +#### Parameters + +##### update + +`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` + +#### Returns + +`void` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`approve`](BridgeContractBase.md#approve) + +*** + +### approveAccountUpdate() + +> **approveAccountUpdate**(`accountUpdate`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:78 + +Approve a single account update (with arbitrarily many children). + +#### Parameters + +##### accountUpdate + +`AccountUpdate` | `AccountUpdateTree` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`approveAccountUpdate`](BridgeContractBase.md#approveaccountupdate) + +*** + +### approveAccountUpdates() + +> **approveAccountUpdates**(`accountUpdates`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:82 + +Approve a list of account updates (with arbitrarily many children). + +#### Parameters + +##### accountUpdates + +(`AccountUpdate` \| `AccountUpdateTree`)[] + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`approveAccountUpdates`](BridgeContractBase.md#approveaccountupdates) + +*** + +### approveBase() + +> **approveBase**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`approveBase`](BridgeContractBase.md#approvebase) + +*** + +### checkZeroBalanceChange() + +> **checkZeroBalanceChange**(`updates`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:74 + +Use `forEachUpdate()` to prove that the total balance change of child account updates is zero. + +This is provided out of the box as it is both a good example, and probably the most common implementation, of `approveBase()`. + +#### Parameters + +##### updates + +`AccountUpdateForest` + +#### Returns + +`void` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`checkZeroBalanceChange`](BridgeContractBase.md#checkzerobalancechange) + +*** + +### deploy() + +> **deploy**(`args`?): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:39 + +Deploys a TokenContract. + +In addition to base smart contract deployment, this adds two steps: +- set the `access` permission to `proofOrSignature()`, to prevent against unauthorized token operations + - not doing this would imply that anyone can bypass token contract authorization and simply mint themselves tokens +- require the zkapp account to be new, using the `isNew` precondition. + this guarantees that the access permission is set from the very start of the existence of this account. + creating the zkapp account before deployment would otherwise be a security vulnerability that is too easy to introduce. + +Note that because of the `isNew` precondition, the zkapp account must not be created prior to calling `deploy()`. + +If the contract needs to be re-deployed, you can switch off this behaviour by overriding the `isNew` precondition: +```ts +async deploy() { + await super.deploy(); + // DON'T DO THIS ON THE INITIAL DEPLOYMENT! + this.account.isNew.requireNothing(); +} +``` + +#### Parameters + +##### args? + +`DeployArgs` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`deploy`](BridgeContractBase.md#deploy) + +*** + +### deployProvable() + +> **deployProvable**(`verificationKey`, `signedSettlement`, `permissions`, `settlementContractAddress`): `Promise`\<`AccountUpdate`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) + +Function to deploy the bridging contract in a provable way, so that it can be +a provable process initiated by the settlement contract with a baked-in vk + +#### Parameters + +##### verificationKey + +`undefined` | `VerificationKey` + +##### signedSettlement + +`boolean` + +##### permissions + +`Permissions` + +##### settlementContractAddress + +`PublicKey` + +#### Returns + +`Promise`\<`AccountUpdate`\> + +Creates and returns an account update deploying the bridge contract + +#### Implementation of + +`BridgeContractType.deployProvable` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`deployProvable`](BridgeContractBase.md#deployprovable) + +*** + +### deriveTokenId() + +> **deriveTokenId**(): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:43 + +Returns the `tokenId` of the token managed by this contract. + +#### Returns + +`Field` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`deriveTokenId`](BridgeContractBase.md#derivetokenid) + +*** + +### emitEvent() + +> **emitEvent**\<`K`\>(`type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 + +Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `string` \| `number` + +#### Parameters + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`emitEvent`](BridgeContractBase.md#emitevent) + +*** + +### emitEventIf() + +> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 + +Conditionally emits an event. + +Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `string` \| `number` + +#### Parameters + +##### condition + +`Bool` + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`emitEventIf`](BridgeContractBase.md#emiteventif) + +*** + +### fetchEvents() + +> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 + +Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. + +#### Parameters + +##### start? + +`UInt32` + +The start height of the events to fetch. + +##### end? + +`UInt32` + +The end height of the events to fetch. If not provided, fetches events up to the latest height. + +#### Returns + +`Promise`\<`object`[]\> + +A promise that resolves to an array of objects, each containing the event type and event data for the specified range. + +#### Async + +#### Throws + +If there is an error fetching events from the Mina network. + +#### Example + +```ts +const startHeight = UInt32.from(1000); +const endHeight = UInt32.from(2000); +const events = await myZkapp.fetchEvents(startHeight, endHeight); +console.log(events); +``` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`fetchEvents`](BridgeContractBase.md#fetchevents) + +*** + +### forEachUpdate() + +> **forEachUpdate**(`updates`, `callback`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:68 + +Iterate through the account updates in `updates` and apply `callback` to each. + +This method is provable and is suitable as a base for implementing `approveUpdates()`. + +#### Parameters + +##### updates + +`AccountUpdateForest` + +##### callback + +(`update`, `usesToken`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`forEachUpdate`](BridgeContractBase.md#foreachupdate) + +*** + +### init() + +> **init**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 + +`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. +This method can be overridden as follows +``` +class MyContract extends SmartContract { + init() { + super.init(); + this.account.permissions.set(...); + this.x.set(Field(1)); + } +} +``` + +#### Returns + +`void` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`init`](BridgeContractBase.md#init) + +*** + +### newSelf() + +> **newSelf**(`methodName`?): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 + +Same as `SmartContract.self` but explicitly creates a new AccountUpdate. + +#### Parameters + +##### methodName? + +`string` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`newSelf`](BridgeContractBase.md#newself) + +*** + +### redeem() + +> **redeem**(`additionUpdate`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:234](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L234) + +#### Parameters + +##### additionUpdate + +`AccountUpdate` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +`BridgeContractType.redeem` + +*** + +### redeemBase() + +> `protected` **redeemBase**(`additionUpdate`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) + +#### Parameters + +##### additionUpdate + +`AccountUpdate` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`redeemBase`](BridgeContractBase.md#redeembase) + +*** + +### requireSignature() + +> **requireSignature**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 + +Use this command if the account update created by this SmartContract should be signed by the account owner, +instead of authorized with a proof. + +Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. + +If you only want to avoid creating proofs for quicker testing, we advise you to +use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting +`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, +with the only difference being that quick mock proofs are filled in instead of real proofs. + +#### Returns + +`void` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`requireSignature`](BridgeContractBase.md#requiresignature) + +*** + +### rollupOutgoingMessages() + +> **rollupOutgoingMessages**(`batch`): `Promise`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:227](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L227) + +#### Parameters + +##### batch + +[`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) + +#### Returns + +`Promise`\<`Field`\> + +#### Implementation of + +`BridgeContractType.rollupOutgoingMessages` + +*** + +### rollupOutgoingMessagesBase() + +> **rollupOutgoingMessagesBase**(`batch`): `Promise`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) + +#### Parameters + +##### batch + +[`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) + +#### Returns + +`Promise`\<`Field`\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`rollupOutgoingMessagesBase`](BridgeContractBase.md#rollupoutgoingmessagesbase) + +*** + +### send() + +> **send**(`args`): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 + +#### Parameters + +##### args + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### to + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`send`](BridgeContractBase.md#send-2) + +*** + +### skipAuthorization() + +> **skipAuthorization**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 + +Use this command if the account update created by this SmartContract should have no authorization on it, +instead of being authorized with a proof. + +WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look +at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the +authorization flow. + +#### Returns + +`void` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`skipAuthorization`](BridgeContractBase.md#skipauthorization) + +*** + +### transfer() + +> **transfer**(`from`, `to`, `amount`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:86 + +Transfer `amount` of tokens from `from` to `to`. + +#### Parameters + +##### from + +`PublicKey` | `AccountUpdate` + +##### to + +`PublicKey` | `AccountUpdate` + +##### amount + +`number` | `bigint` | `UInt64` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`transfer`](BridgeContractBase.md#transfer) + +*** + +### updateStateRoot() + +> **updateStateRoot**(`root`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:222](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L222) + +#### Parameters + +##### root + +`Field` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +`BridgeContractType.updateStateRoot` + +*** + +### updateStateRootBase() + +> **updateStateRootBase**(`root`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) + +#### Parameters + +##### root + +`Field` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`updateStateRootBase`](BridgeContractBase.md#updatestaterootbase) + +*** + +### analyzeMethods() + +> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 + +This function is run internally before compiling a smart contract, to collect metadata about what each of your +smart contract methods does. + +For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, +so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. + +`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), +which is a good indicator for circuit size and the time it will take to create proofs. +To inspect the created circuit in detail, you can look at the returned `gates`. + +Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. + +#### Parameters + +##### \_\_namedParameters? + +###### printSummary + +`boolean` + +#### Returns + +`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +an object, keyed by method name, each entry containing: + - `rows` the size of the constraint system created by this method + - `digest` a digest of the method circuit + - `actions` the number of actions the method dispatches + - `gates` the constraint system, represented as an array of gates + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`analyzeMethods`](BridgeContractBase.md#analyzemethods) + +*** + +### compile() + +> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 + +Compile your smart contract. + +This generates both the prover functions, needed to create proofs for running `@method`s, +and the verification key, needed to deploy your zkApp. + +Although provers and verification key are returned by this method, they are also cached internally and used when needed, +so you don't actually have to use the return value of this function. + +Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to +create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps +it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, +up to several minutes if your circuit is large or your hardware is not optimal for these operations. + +#### Parameters + +##### \_\_namedParameters? + +###### cache + +`Cache` + +###### forceRecompile + +`boolean` + +#### Returns + +`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`compile`](BridgeContractBase.md#compile) + +*** + +### digest() + +> `static` **digest**(): `Promise`\<`string`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 + +Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. +This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or +a cached verification key can be used. + +#### Returns + +`Promise`\<`string`\> + +the digest, as a hex string + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`digest`](BridgeContractBase.md#digest) + +*** + +### Proof() + +> `static` **Proof**(): (`__namedParameters`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 + +Returns a Proof type that belongs to this SmartContract. + +#### Returns + +`Function` + +##### Parameters + +###### \_\_namedParameters + +###### maxProofsVerified + +`0` \| `1` \| `2` + +###### proof + +`unknown` + +###### publicInput + +`ZkappPublicInput` + +###### publicOutput + +`undefined` + +##### Returns + +`object` + +###### maxProofsVerified + +> **maxProofsVerified**: `0` \| `1` \| `2` + +###### proof + +> **proof**: `unknown` + +###### publicInput + +> **publicInput**: `ZkappPublicInput` + +###### publicOutput + +> **publicOutput**: `undefined` + +###### shouldVerify + +> **shouldVerify**: `Bool` + +###### toJSON() + +###### Returns + +`JsonProof` + +###### verify() + +###### Returns + +`void` + +###### verifyIf() + +###### Parameters + +###### condition + +`Bool` + +###### Returns + +`void` + +##### publicInputType + +> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` + +###### Type declaration + +###### fromFields() + +> **fromFields**: (`fields`) => `object` + +###### Parameters + +###### fields + +`Field`[] + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### Type declaration + +###### empty() + +> **empty**: () => `object` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### fromJSON() + +> **fromJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`string` + +###### calls + +`string` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### toInput() + +> **toInput**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### fields? + +> `optional` **fields**: `Field`[] + +###### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +###### toJSON() + +> **toJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `string` + +###### calls + +> **calls**: `string` + +##### publicOutputType + +> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> + +##### tag() + +> **tag**: () => *typeof* `SmartContract` + +###### Returns + +*typeof* `SmartContract` + +##### dummy() + +###### Type Parameters + +• **Input** + +• **OutPut** + +###### Parameters + +###### publicInput + +`Input` + +###### publicOutput + +`OutPut` + +###### maxProofsVerified + +`0` | `1` | `2` + +###### domainLog2? + +`number` + +###### Returns + +`Promise`\<`Proof`\<`Input`, `OutPut`\>\> + +##### fromJSON() + +###### Type Parameters + +• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` + +###### Parameters + +###### this + +`S` + +###### \_\_namedParameters + +`JsonProof` + +###### Returns + +`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`Proof`](BridgeContractBase.md#proof) + +*** + +### runOutsideCircuit() + +> `static` **runOutsideCircuit**(`run`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 + +#### Parameters + +##### run + +() => `void` + +#### Returns + +`void` + +#### Inherited from + +[`BridgeContractBase`](BridgeContractBase.md).[`runOutsideCircuit`](BridgeContractBase.md#runoutsidecircuit) diff --git a/src/pages/docs/reference/protocol/classes/BridgeContractBase.md b/src/pages/docs/reference/protocol/classes/BridgeContractBase.md new file mode 100644 index 0000000..79ce557 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BridgeContractBase.md @@ -0,0 +1,1477 @@ +--- +title: BridgeContractBase +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BridgeContractBase + +# Class: `abstract` BridgeContractBase + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L54) + +## Extends + +- `TokenContractV2` + +## Extended by + +- [`BridgeContract`](BridgeContract.md) + +## Constructors + +### new BridgeContractBase() + +> **new BridgeContractBase**(`address`, `tokenId`?): [`BridgeContractBase`](BridgeContractBase.md) + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 + +#### Parameters + +##### address + +`PublicKey` + +##### tokenId? + +`Field` + +#### Returns + +[`BridgeContractBase`](BridgeContractBase.md) + +#### Inherited from + +`TokenContractV2.constructor` + +## Properties + +### address + +> **address**: `PublicKey` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 + +#### Inherited from + +`TokenContractV2.address` + +*** + +### events + +> **events**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:315 + +A list of event types that can be emitted using this.emitEvent()`. + +#### Index Signature + +\[`key`: `string`\]: `FlexibleProvablePure`\<`any`\> + +#### Inherited from + +`TokenContractV2.events` + +*** + +### outgoingMessageCursor + +> `abstract` **outgoingMessageCursor**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L66) + +*** + +### sender + +> **sender**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 + +#### self + +> **self**: `SmartContract` + +#### ~~getAndRequireSignature()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key. + +#### getAndRequireSignatureV2() + +Return a public key that is forced to sign this transaction. + +Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created +the transaction controls the private key associated with the returned public key. + +##### Returns + +`PublicKey` + +#### ~~getUnconstrained()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getUnconstrainedV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key, +which would cause an account update with that public key to not be included. + +#### getUnconstrainedV2() + +The public key of the current transaction's sender account. + +Throws an error if not inside a transaction, or the sender wasn't passed in. + +**Warning**: The fact that this public key equals the current sender is not part of the proof. +A malicious prover could use any other public key without affecting the validity of the proof. + +Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. + +##### Returns + +`PublicKey` + +#### Inherited from + +`TokenContractV2.sender` + +*** + +### settlementContractAddress + +> `abstract` **settlementContractAddress**: `State`\<`PublicKey`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L62) + +*** + +### stateRoot + +> `abstract` **stateRoot**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L64) + +*** + +### tokenId + +> **tokenId**: `Field` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 + +#### Inherited from + +`TokenContractV2.tokenId` + +*** + +### \_maxProofsVerified? + +> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 + +#### Inherited from + +`TokenContractV2._maxProofsVerified` + +*** + +### \_methodMetadata? + +> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 + +#### Inherited from + +`TokenContractV2._methodMetadata` + +*** + +### \_methods? + +> `static` `optional` **\_methods**: `MethodInterface`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 + +#### Inherited from + +`TokenContractV2._methods` + +*** + +### \_provers? + +> `static` `optional` **\_provers**: `Prover`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 + +#### Inherited from + +`TokenContractV2._provers` + +*** + +### \_verificationKey? + +> `static` `optional` **\_verificationKey**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 + +#### data + +> **data**: `string` + +#### hash + +> **hash**: `Field` + +#### Inherited from + +`TokenContractV2._verificationKey` + +*** + +### args + +> `static` **args**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) + +#### SettlementContract + +> **SettlementContract**: `undefined` \| [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> & *typeof* `SmartContract` + +#### withdrawalStatePath + +> **withdrawalStatePath**: \[`string`, `string`\] + +*** + +### MAX\_ACCOUNT\_UPDATES + +> `static` **MAX\_ACCOUNT\_UPDATES**: `number` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:94 + +The maximum number of account updates using the token in a single +transaction that this contract supports. + +#### Inherited from + +`TokenContractV2.MAX_ACCOUNT_UPDATES` + +## Accessors + +### account + +#### Get Signature + +> **get** **account**(): `Account` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 + +Current account of the SmartContract. + +##### Returns + +`Account` + +#### Inherited from + +`TokenContractV2.account` + +*** + +### balance + +#### Get Signature + +> **get** **balance**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 + +Balance of this SmartContract. + +##### Returns + +`object` + +###### addInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +###### subInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +#### Inherited from + +`TokenContractV2.balance` + +*** + +### currentSlot + +#### Get Signature + +> **get** **currentSlot**(): `CurrentSlot` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 + +Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value +at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) +or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) + +##### Returns + +`CurrentSlot` + +#### Inherited from + +`TokenContractV2.currentSlot` + +*** + +### internal + +#### Get Signature + +> **get** **internal**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:47 + +Helper methods to use from within a token contract. + +##### Returns + +`object` + +###### burn() + +###### Parameters + +###### \_\_namedParameters + +###### address + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### Returns + +`AccountUpdate` + +###### mint() + +###### Parameters + +###### \_\_namedParameters + +###### address + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### Returns + +`AccountUpdate` + +###### send() + +###### Parameters + +###### \_\_namedParameters + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### from + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### to + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### Returns + +`AccountUpdate` + +#### Inherited from + +`TokenContractV2.internal` + +*** + +### network + +#### Get Signature + +> **get** **network**(): `Network` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 + +Current network state of the SmartContract. + +##### Returns + +`Network` + +#### Inherited from + +`TokenContractV2.network` + +*** + +### self + +#### Get Signature + +> **get** **self**(): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 + +Returns the current AccountUpdate associated to this SmartContract. + +##### Returns + +`AccountUpdate` + +#### Inherited from + +`TokenContractV2.self` + +## Methods + +### approve() + +> **approve**(`update`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 + +Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, +which allows you to read and use its content in a proof, make assertions about it, and modify it. + +```ts +`@method` myApprovingMethod(update: AccountUpdate) { + this.approve(update); + + // read balance on the account (for example) + let balance = update.account.balance.getAndRequireEquals(); +} +``` + +Under the hood, "approving" just means that the account update is made a child of the zkApp in the +tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, +the entire tree will become a subtree of the zkApp's account update. + +Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update +at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally +excluding important information from the public input. + +#### Parameters + +##### update + +`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.approve` + +*** + +### approveAccountUpdate() + +> **approveAccountUpdate**(`accountUpdate`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:78 + +Approve a single account update (with arbitrarily many children). + +#### Parameters + +##### accountUpdate + +`AccountUpdate` | `AccountUpdateTree` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TokenContractV2.approveAccountUpdate` + +*** + +### approveAccountUpdates() + +> **approveAccountUpdates**(`accountUpdates`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:82 + +Approve a list of account updates (with arbitrarily many children). + +#### Parameters + +##### accountUpdates + +(`AccountUpdate` \| `AccountUpdateTree`)[] + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TokenContractV2.approveAccountUpdates` + +*** + +### approveBase() + +> **approveBase**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +`TokenContractV2.approveBase` + +*** + +### checkZeroBalanceChange() + +> **checkZeroBalanceChange**(`updates`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:74 + +Use `forEachUpdate()` to prove that the total balance change of child account updates is zero. + +This is provided out of the box as it is both a good example, and probably the most common implementation, of `approveBase()`. + +#### Parameters + +##### updates + +`AccountUpdateForest` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.checkZeroBalanceChange` + +*** + +### deploy() + +> **deploy**(`args`?): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:39 + +Deploys a TokenContract. + +In addition to base smart contract deployment, this adds two steps: +- set the `access` permission to `proofOrSignature()`, to prevent against unauthorized token operations + - not doing this would imply that anyone can bypass token contract authorization and simply mint themselves tokens +- require the zkapp account to be new, using the `isNew` precondition. + this guarantees that the access permission is set from the very start of the existence of this account. + creating the zkapp account before deployment would otherwise be a security vulnerability that is too easy to introduce. + +Note that because of the `isNew` precondition, the zkapp account must not be created prior to calling `deploy()`. + +If the contract needs to be re-deployed, you can switch off this behaviour by overriding the `isNew` precondition: +```ts +async deploy() { + await super.deploy(); + // DON'T DO THIS ON THE INITIAL DEPLOYMENT! + this.account.isNew.requireNothing(); +} +``` + +#### Parameters + +##### args? + +`DeployArgs` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TokenContractV2.deploy` + +*** + +### deployProvable() + +> **deployProvable**(`verificationKey`, `signedSettlement`, `permissions`, `settlementContractAddress`): `Promise`\<`AccountUpdate`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) + +Function to deploy the bridging contract in a provable way, so that it can be +a provable process initiated by the settlement contract with a baked-in vk + +#### Parameters + +##### verificationKey + +`undefined` | `VerificationKey` + +##### signedSettlement + +`boolean` + +##### permissions + +`Permissions` + +##### settlementContractAddress + +`PublicKey` + +#### Returns + +`Promise`\<`AccountUpdate`\> + +Creates and returns an account update deploying the bridge contract + +*** + +### deriveTokenId() + +> **deriveTokenId**(): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:43 + +Returns the `tokenId` of the token managed by this contract. + +#### Returns + +`Field` + +#### Inherited from + +`TokenContractV2.deriveTokenId` + +*** + +### emitEvent() + +> **emitEvent**\<`K`\>(`type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 + +Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `string` \| `number` + +#### Parameters + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.emitEvent` + +*** + +### emitEventIf() + +> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 + +Conditionally emits an event. + +Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `string` \| `number` + +#### Parameters + +##### condition + +`Bool` + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.emitEventIf` + +*** + +### fetchEvents() + +> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 + +Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. + +#### Parameters + +##### start? + +`UInt32` + +The start height of the events to fetch. + +##### end? + +`UInt32` + +The end height of the events to fetch. If not provided, fetches events up to the latest height. + +#### Returns + +`Promise`\<`object`[]\> + +A promise that resolves to an array of objects, each containing the event type and event data for the specified range. + +#### Async + +#### Throws + +If there is an error fetching events from the Mina network. + +#### Example + +```ts +const startHeight = UInt32.from(1000); +const endHeight = UInt32.from(2000); +const events = await myZkapp.fetchEvents(startHeight, endHeight); +console.log(events); +``` + +#### Inherited from + +`TokenContractV2.fetchEvents` + +*** + +### forEachUpdate() + +> **forEachUpdate**(`updates`, `callback`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:68 + +Iterate through the account updates in `updates` and apply `callback` to each. + +This method is provable and is suitable as a base for implementing `approveUpdates()`. + +#### Parameters + +##### updates + +`AccountUpdateForest` + +##### callback + +(`update`, `usesToken`) => `void` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.forEachUpdate` + +*** + +### init() + +> **init**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 + +`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. +This method can be overridden as follows +``` +class MyContract extends SmartContract { + init() { + super.init(); + this.account.permissions.set(...); + this.x.set(Field(1)); + } +} +``` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.init` + +*** + +### newSelf() + +> **newSelf**(`methodName`?): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 + +Same as `SmartContract.self` but explicitly creates a new AccountUpdate. + +#### Parameters + +##### methodName? + +`string` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +`TokenContractV2.newSelf` + +*** + +### redeemBase() + +> `protected` **redeemBase**(`additionUpdate`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) + +#### Parameters + +##### additionUpdate + +`AccountUpdate` + +#### Returns + +`Promise`\<`void`\> + +*** + +### requireSignature() + +> **requireSignature**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 + +Use this command if the account update created by this SmartContract should be signed by the account owner, +instead of authorized with a proof. + +Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. + +If you only want to avoid creating proofs for quicker testing, we advise you to +use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting +`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, +with the only difference being that quick mock proofs are filled in instead of real proofs. + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.requireSignature` + +*** + +### rollupOutgoingMessagesBase() + +> **rollupOutgoingMessagesBase**(`batch`): `Promise`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) + +#### Parameters + +##### batch + +[`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) + +#### Returns + +`Promise`\<`Field`\> + +*** + +### send() + +> **send**(`args`): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 + +#### Parameters + +##### args + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### to + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +`TokenContractV2.send` + +*** + +### skipAuthorization() + +> **skipAuthorization**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 + +Use this command if the account update created by this SmartContract should have no authorization on it, +instead of being authorized with a proof. + +WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look +at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the +authorization flow. + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.skipAuthorization` + +*** + +### transfer() + +> **transfer**(`from`, `to`, `amount`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:86 + +Transfer `amount` of tokens from `from` to `to`. + +#### Parameters + +##### from + +`PublicKey` | `AccountUpdate` + +##### to + +`PublicKey` | `AccountUpdate` + +##### amount + +`number` | `bigint` | `UInt64` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TokenContractV2.transfer` + +*** + +### updateStateRootBase() + +> **updateStateRootBase**(`root`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) + +#### Parameters + +##### root + +`Field` + +#### Returns + +`Promise`\<`void`\> + +*** + +### analyzeMethods() + +> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 + +This function is run internally before compiling a smart contract, to collect metadata about what each of your +smart contract methods does. + +For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, +so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. + +`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), +which is a good indicator for circuit size and the time it will take to create proofs. +To inspect the created circuit in detail, you can look at the returned `gates`. + +Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. + +#### Parameters + +##### \_\_namedParameters? + +###### printSummary + +`boolean` + +#### Returns + +`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +an object, keyed by method name, each entry containing: + - `rows` the size of the constraint system created by this method + - `digest` a digest of the method circuit + - `actions` the number of actions the method dispatches + - `gates` the constraint system, represented as an array of gates + +#### Inherited from + +`TokenContractV2.analyzeMethods` + +*** + +### compile() + +> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 + +Compile your smart contract. + +This generates both the prover functions, needed to create proofs for running `@method`s, +and the verification key, needed to deploy your zkApp. + +Although provers and verification key are returned by this method, they are also cached internally and used when needed, +so you don't actually have to use the return value of this function. + +Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to +create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps +it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, +up to several minutes if your circuit is large or your hardware is not optimal for these operations. + +#### Parameters + +##### \_\_namedParameters? + +###### cache + +`Cache` + +###### forceRecompile + +`boolean` + +#### Returns + +`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +#### Inherited from + +`TokenContractV2.compile` + +*** + +### digest() + +> `static` **digest**(): `Promise`\<`string`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 + +Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. +This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or +a cached verification key can be used. + +#### Returns + +`Promise`\<`string`\> + +the digest, as a hex string + +#### Inherited from + +`TokenContractV2.digest` + +*** + +### Proof() + +> `static` **Proof**(): (`__namedParameters`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 + +Returns a Proof type that belongs to this SmartContract. + +#### Returns + +`Function` + +##### Parameters + +###### \_\_namedParameters + +###### maxProofsVerified + +`0` \| `1` \| `2` + +###### proof + +`unknown` + +###### publicInput + +`ZkappPublicInput` + +###### publicOutput + +`undefined` + +##### Returns + +`object` + +###### maxProofsVerified + +> **maxProofsVerified**: `0` \| `1` \| `2` + +###### proof + +> **proof**: `unknown` + +###### publicInput + +> **publicInput**: `ZkappPublicInput` + +###### publicOutput + +> **publicOutput**: `undefined` + +###### shouldVerify + +> **shouldVerify**: `Bool` + +###### toJSON() + +###### Returns + +`JsonProof` + +###### verify() + +###### Returns + +`void` + +###### verifyIf() + +###### Parameters + +###### condition + +`Bool` + +###### Returns + +`void` + +##### publicInputType + +> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` + +###### Type declaration + +###### fromFields() + +> **fromFields**: (`fields`) => `object` + +###### Parameters + +###### fields + +`Field`[] + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### Type declaration + +###### empty() + +> **empty**: () => `object` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### fromJSON() + +> **fromJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`string` + +###### calls + +`string` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### toInput() + +> **toInput**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### fields? + +> `optional` **fields**: `Field`[] + +###### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +###### toJSON() + +> **toJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `string` + +###### calls + +> **calls**: `string` + +##### publicOutputType + +> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> + +##### tag() + +> **tag**: () => *typeof* `SmartContract` + +###### Returns + +*typeof* `SmartContract` + +##### dummy() + +###### Type Parameters + +• **Input** + +• **OutPut** + +###### Parameters + +###### publicInput + +`Input` + +###### publicOutput + +`OutPut` + +###### maxProofsVerified + +`0` | `1` | `2` + +###### domainLog2? + +`number` + +###### Returns + +`Promise`\<`Proof`\<`Input`, `OutPut`\>\> + +##### fromJSON() + +###### Type Parameters + +• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` + +###### Parameters + +###### this + +`S` + +###### \_\_namedParameters + +`JsonProof` + +###### Returns + +`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +#### Inherited from + +`TokenContractV2.Proof` + +*** + +### runOutsideCircuit() + +> `static` **runOutsideCircuit**(`run`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 + +#### Parameters + +##### run + +() => `void` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.runOutsideCircuit` diff --git a/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md new file mode 100644 index 0000000..bac2a2f --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md @@ -0,0 +1,147 @@ +--- +title: BridgeContractProtocolModule +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BridgeContractProtocolModule + +# Class: BridgeContractProtocolModule + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L18) + +This module type is used to define a contract module that can be used to +construct and inject smart contract instances. +It defines a method contractFactory, whose arguments can be configured via +the Argument generic. It returns a smart contract class that is a subclass +of SmartContract and implements a certain interface as specified by the +ContractType generic. + +## Extends + +- [`ContractModule`](ContractModule.md)\<[`BridgeContractType`](../type-aliases/BridgeContractType.md), [`BridgeContractConfig`](../type-aliases/BridgeContractConfig.md)\> + +## Constructors + +### new BridgeContractProtocolModule() + +> **new BridgeContractProtocolModule**(): [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md) + +#### Returns + +[`BridgeContractProtocolModule`](BridgeContractProtocolModule.md) + +#### Inherited from + +[`ContractModule`](ContractModule.md).[`constructor`](ContractModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`BridgeContractConfig`](../type-aliases/BridgeContractConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ContractModule`](ContractModule.md).[`currentConfig`](ContractModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ContractModule`](ContractModule.md).[`config`](ContractModule.md#config) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<\{ `BridgeContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L38) + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<\{ `BridgeContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> + +#### Overrides + +[`ContractModule`](ContractModule.md).[`compile`](ContractModule.md#compile) + +*** + +### contractFactory() + +> **contractFactory**(): *typeof* [`BridgeContract`](BridgeContract.md) + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L22) + +#### Returns + +*typeof* [`BridgeContract`](BridgeContract.md) + +#### Overrides + +[`ContractModule`](ContractModule.md).[`contractFactory`](ContractModule.md#contractfactory) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ContractModule`](ContractModule.md).[`create`](ContractModule.md#create) diff --git a/src/pages/docs/reference/protocol/classes/ContractModule.md b/src/pages/docs/reference/protocol/classes/ContractModule.md new file mode 100644 index 0000000..fc33e18 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/ContractModule.md @@ -0,0 +1,159 @@ +--- +title: ContractModule +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ContractModule + +# Class: `abstract` ContractModule\ + +Defined in: [packages/protocol/src/settlement/ContractModule.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/ContractModule.ts#L22) + +This module type is used to define a contract module that can be used to +construct and inject smart contract instances. +It defines a method contractFactory, whose arguments can be configured via +the Argument generic. It returns a smart contract class that is a subclass +of SmartContract and implements a certain interface as specified by the +ContractType generic. + +## Extends + +- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> + +## Extended by + +- [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md) +- [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) +- [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md) + +## Type Parameters + +• **ContractType** + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +## Implements + +- [`CompilableModule`](../../common/interfaces/CompilableModule.md) + +## Constructors + +### new ContractModule() + +> **new ContractModule**\<`ContractType`, `Config`\>(): [`ContractModule`](ContractModule.md)\<`ContractType`, `Config`\> + +#### Returns + +[`ContractModule`](ContractModule.md)\<`ContractType`, `Config`\> + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) + +## Methods + +### compile() + +> `abstract` **compile**(`registry`): `Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +Defined in: [packages/protocol/src/settlement/ContractModule.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/ContractModule.ts#L28) + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +#### Implementation of + +[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) + +*** + +### contractFactory() + +> `abstract` **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<`ContractType`\> + +Defined in: [packages/protocol/src/settlement/ContractModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/ContractModule.ts#L26) + +#### Returns + +[`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<`ContractType`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) diff --git a/src/pages/docs/reference/protocol/classes/CurrentBlock.md b/src/pages/docs/reference/protocol/classes/CurrentBlock.md new file mode 100644 index 0000000..8850e3a --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/CurrentBlock.md @@ -0,0 +1,357 @@ +--- +title: CurrentBlock +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / CurrentBlock + +# Class: CurrentBlock + +Defined in: [packages/protocol/src/model/network/NetworkState.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L4) + +## Extends + +- `object` + +## Constructors + +### new CurrentBlock() + +> **new CurrentBlock**(`value`): [`CurrentBlock`](CurrentBlock.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### height + +`UInt64` = `UInt64` + +#### Returns + +[`CurrentBlock`](CurrentBlock.md) + +#### Inherited from + +`Struct({ height: UInt64, }).constructor` + +## Properties + +### height + +> **height**: `UInt64` = `UInt64` + +Defined in: [packages/protocol/src/model/network/NetworkState.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L5) + +#### Inherited from + +`Struct({ height: UInt64, }).height` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ height: UInt64, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### height + +`UInt64` = `UInt64` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ height: UInt64, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### height + +> **height**: `UInt64` = `UInt64` + +#### Inherited from + +`Struct({ height: UInt64, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### height + +> **height**: `UInt64` = `UInt64` + +#### Inherited from + +`Struct({ height: UInt64, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### height + +`string` = `UInt64` + +#### Returns + +`object` + +##### height + +> **height**: `UInt64` = `UInt64` + +#### Inherited from + +`Struct({ height: UInt64, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ height: UInt64, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### height + +`UInt64` = `UInt64` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ height: UInt64, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### height + +`UInt64` = `UInt64` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ height: UInt64, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### height + +`UInt64` = `UInt64` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ height: UInt64, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### height + +`UInt64` = `UInt64` + +#### Returns + +`object` + +##### height + +> **height**: `string` = `UInt64` + +#### Inherited from + +`Struct({ height: UInt64, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### height + +`UInt64` = `UInt64` + +#### Returns + +`object` + +##### height + +> **height**: `bigint` = `UInt64` + +#### Inherited from + +`Struct({ height: UInt64, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ height: UInt64, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md b/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md new file mode 100644 index 0000000..81c60ce --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md @@ -0,0 +1,168 @@ +--- +title: DefaultProvableHashList +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DefaultProvableHashList + +# Class: DefaultProvableHashList\ + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L46) + +Utilities for creating a hash list from a given value type. + +## Extends + +- [`ProvableHashList`](ProvableHashList.md)\<`Value`\> + +## Type Parameters + +• **Value** + +## Constructors + +### new DefaultProvableHashList() + +> **new DefaultProvableHashList**\<`Value`\>(`valueType`, `commitment`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L7) + +#### Parameters + +##### valueType + +`ProvablePure`\<`Value`\> + +##### commitment + +`Field` = `...` + +#### Returns + +[`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`constructor`](ProvableHashList.md#constructors) + +## Properties + +### commitment + +> **commitment**: `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`commitment`](ProvableHashList.md#commitment-1) + +*** + +### valueType + +> `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`valueType`](ProvableHashList.md#valuetype-1) + +## Methods + +### hash() + +> **hash**(`elements`): `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L47) + +#### Parameters + +##### elements + +`Field`[] + +#### Returns + +`Field` + +#### Overrides + +[`ProvableHashList`](ProvableHashList.md).[`hash`](ProvableHashList.md#hash) + +*** + +### push() + +> **push**(`value`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) + +Converts the provided value to Field[] and appends it to +the current hashlist. + +#### Parameters + +##### value + +`Value` + +Value to be appended to the hash list + +#### Returns + +[`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> + +Current hash list. + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`push`](ProvableHashList.md#push) + +*** + +### pushIf() + +> **pushIf**(`value`, `condition`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L29) + +#### Parameters + +##### value + +`Value` + +##### condition + +`Bool` + +#### Returns + +[`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`pushIf`](ProvableHashList.md#pushif) + +*** + +### toField() + +> **toField**(): `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) + +#### Returns + +`Field` + +Traling hash of the current hashlist. + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`toField`](ProvableHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/Deposit.md b/src/pages/docs/reference/protocol/classes/Deposit.md new file mode 100644 index 0000000..aa97e8a --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/Deposit.md @@ -0,0 +1,493 @@ +--- +title: Deposit +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Deposit + +# Class: Deposit + +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Deposit.ts#L3) + +## Extends + +- `object` + +## Constructors + +### new Deposit() + +> **new Deposit**(`value`): [`Deposit`](Deposit.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +[`Deposit`](Deposit.md) + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).constructor` + +## Properties + +### address + +> **address**: `PublicKey` = `PublicKey` + +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Deposit.ts#L5) + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).address` + +*** + +### amount + +> **amount**: `UInt64` = `UInt64` + +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Deposit.ts#L6) + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).amount` + +*** + +### tokenId + +> **tokenId**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Deposit.ts#L4) + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).tokenId` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### amount + +> **amount**: `UInt64` = `UInt64` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### amount + +> **amount**: `UInt64` = `UInt64` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### address + +`string` = `PublicKey` + +###### amount + +`string` = `UInt64` + +###### tokenId + +`string` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### amount + +> **amount**: `UInt64` = `UInt64` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `string` = `PublicKey` + +##### amount + +> **amount**: `string` = `UInt64` + +##### tokenId + +> **tokenId**: `string` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `object` = `PublicKey` + +###### address.isOdd + +> **address.isOdd**: `boolean` + +###### address.x + +> **address.x**: `bigint` + +##### amount + +> **amount**: `bigint` = `UInt64` + +##### tokenId + +> **tokenId**: `bigint` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md new file mode 100644 index 0000000..d60dd2d --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md @@ -0,0 +1,175 @@ +--- +title: DispatchContractProtocolModule +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DispatchContractProtocolModule + +# Class: DispatchContractProtocolModule + +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L22) + +This module type is used to define a contract module that can be used to +construct and inject smart contract instances. +It defines a method contractFactory, whose arguments can be configured via +the Argument generic. It returns a smart contract class that is a subclass +of SmartContract and implements a certain interface as specified by the +ContractType generic. + +## Extends + +- [`ContractModule`](ContractModule.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md), [`DispatchContractConfig`](../type-aliases/DispatchContractConfig.md)\> + +## Constructors + +### new DispatchContractProtocolModule() + +> **new DispatchContractProtocolModule**(`runtime`): [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) + +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L26) + +#### Parameters + +##### runtime + +[`RuntimeLike`](../interfaces/RuntimeLike.md) + +#### Returns + +[`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) + +#### Overrides + +[`ContractModule`](ContractModule.md).[`constructor`](ContractModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`DispatchContractConfig`](../type-aliases/DispatchContractConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ContractModule`](ContractModule.md).[`currentConfig`](ContractModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ContractModule`](ContractModule.md).[`config`](ContractModule.md#config) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<\{ `DispatchSmartContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L65) + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<\{ `DispatchSmartContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> + +#### Overrides + +[`ContractModule`](ContractModule.md).[`compile`](ContractModule.md#compile) + +*** + +### contractFactory() + +> **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md)\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L49) + +#### Returns + +[`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md)\> + +#### Overrides + +[`ContractModule`](ContractModule.md).[`contractFactory`](ContractModule.md#contractfactory) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ContractModule`](ContractModule.md).[`create`](ContractModule.md#create) + +*** + +### eventsDefinition() + +> **eventsDefinition**(): `object` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L30) + +#### Returns + +`object` + +##### incoming-message-placeholder + +> **incoming-message-placeholder**: *typeof* `Field` & (`x`) => `Field` = `Field` + +##### token-bridge-added + +> **token-bridge-added**: *typeof* [`TokenBridgeTreeAddition`](TokenBridgeTreeAddition.md) = `TokenBridgeTreeAddition` diff --git a/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md b/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md new file mode 100644 index 0000000..697d79d --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md @@ -0,0 +1,1401 @@ +--- +title: DispatchSmartContract +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DispatchSmartContract + +# Class: DispatchSmartContract + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:229](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L229) + +## Extends + +- [`DispatchSmartContractBase`](DispatchSmartContractBase.md) + +## Implements + +- [`DispatchContractType`](../interfaces/DispatchContractType.md) + +## Constructors + +### new DispatchSmartContract() + +> **new DispatchSmartContract**(`address`, `tokenId`?): [`DispatchSmartContract`](DispatchSmartContract.md) + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 + +#### Parameters + +##### address + +`PublicKey` + +##### tokenId? + +`Field` + +#### Returns + +[`DispatchSmartContract`](DispatchSmartContract.md) + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`constructor`](DispatchSmartContractBase.md#constructors) + +## Properties + +### address + +> **address**: `PublicKey` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`address`](DispatchSmartContractBase.md#address-1) + +*** + +### events + +> **events**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) + +A list of event types that can be emitted using this.emitEvent()`. + +#### incoming-message-placeholder + +> **incoming-message-placeholder**: *typeof* `Field` & (`x`) => `Field` = `Field` + +#### token-bridge-added + +> **token-bridge-added**: *typeof* [`TokenBridgeTreeAddition`](TokenBridgeTreeAddition.md) = `TokenBridgeTreeAddition` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`events`](DispatchSmartContractBase.md#events) + +*** + +### honoredMessagesHash + +> **honoredMessagesHash**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:235](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L235) + +#### Overrides + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`honoredMessagesHash`](DispatchSmartContractBase.md#honoredmessageshash) + +*** + +### promisedMessagesHash + +> **promisedMessagesHash**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:233](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L233) + +#### Implementation of + +[`DispatchContractType`](../interfaces/DispatchContractType.md).[`promisedMessagesHash`](../interfaces/DispatchContractType.md#promisedmessageshash) + +#### Overrides + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`promisedMessagesHash`](DispatchSmartContractBase.md#promisedmessageshash) + +*** + +### sender + +> **sender**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 + +#### self + +> **self**: `SmartContract` + +#### ~~getAndRequireSignature()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key. + +#### getAndRequireSignatureV2() + +Return a public key that is forced to sign this transaction. + +Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created +the transaction controls the private key associated with the returned public key. + +##### Returns + +`PublicKey` + +#### ~~getUnconstrained()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getUnconstrainedV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key, +which would cause an account update with that public key to not be included. + +#### getUnconstrainedV2() + +The public key of the current transaction's sender account. + +Throws an error if not inside a transaction, or the sender wasn't passed in. + +**Warning**: The fact that this public key equals the current sender is not part of the proof. +A malicious prover could use any other public key without affecting the validity of the proof. + +Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. + +##### Returns + +`PublicKey` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`sender`](DispatchSmartContractBase.md#sender) + +*** + +### settlementContract + +> **settlementContract**: `State`\<`PublicKey`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:237](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L237) + +#### Overrides + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`settlementContract`](DispatchSmartContractBase.md#settlementcontract) + +*** + +### tokenBridgeCount + +> **tokenBridgeCount**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:241](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L241) + +#### Overrides + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`tokenBridgeCount`](DispatchSmartContractBase.md#tokenbridgecount) + +*** + +### tokenBridgeRoot + +> **tokenBridgeRoot**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:239](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L239) + +#### Overrides + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`tokenBridgeRoot`](DispatchSmartContractBase.md#tokenbridgeroot) + +*** + +### tokenId + +> **tokenId**: `Field` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`tokenId`](DispatchSmartContractBase.md#tokenid-1) + +*** + +### \_maxProofsVerified? + +> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`_maxProofsVerified`](DispatchSmartContractBase.md#_maxproofsverified) + +*** + +### \_methodMetadata? + +> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`_methodMetadata`](DispatchSmartContractBase.md#_methodmetadata) + +*** + +### \_methods? + +> `static` `optional` **\_methods**: `MethodInterface`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`_methods`](DispatchSmartContractBase.md#_methods) + +*** + +### \_provers? + +> `static` `optional` **\_provers**: `Prover`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`_provers`](DispatchSmartContractBase.md#_provers) + +*** + +### \_verificationKey? + +> `static` `optional` **\_verificationKey**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 + +#### data + +> **data**: `string` + +#### hash + +> **hash**: `Field` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`_verificationKey`](DispatchSmartContractBase.md#_verificationkey) + +*** + +### args + +> `static` **args**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) + +#### incomingMessagesPaths + +> **incomingMessagesPaths**: `Record`\<`string`, `` `${string}.${string}` ``\> + +#### methodIdMappings + +> **methodIdMappings**: [`RuntimeMethodIdMapping`](../type-aliases/RuntimeMethodIdMapping.md) + +#### settlementContractClass? + +> `optional` **settlementContractClass**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> & *typeof* `SmartContract` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`args`](DispatchSmartContractBase.md#args) + +## Accessors + +### account + +#### Get Signature + +> **get** **account**(): `Account` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 + +Current account of the SmartContract. + +##### Returns + +`Account` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`account`](DispatchSmartContractBase.md#account) + +*** + +### balance + +#### Get Signature + +> **get** **balance**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 + +Balance of this SmartContract. + +##### Returns + +`object` + +###### addInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +###### subInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`balance`](DispatchSmartContractBase.md#balance) + +*** + +### currentSlot + +#### Get Signature + +> **get** **currentSlot**(): `CurrentSlot` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 + +Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value +at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) +or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) + +##### Returns + +`CurrentSlot` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`currentSlot`](DispatchSmartContractBase.md#currentslot) + +*** + +### network + +#### Get Signature + +> **get** **network**(): `Network` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 + +Current network state of the SmartContract. + +##### Returns + +`Network` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`network`](DispatchSmartContractBase.md#network) + +*** + +### self + +#### Get Signature + +> **get** **self**(): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 + +Returns the current AccountUpdate associated to this SmartContract. + +##### Returns + +`AccountUpdate` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`self`](DispatchSmartContractBase.md#self) + +## Methods + +### approve() + +> **approve**(`update`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 + +Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, +which allows you to read and use its content in a proof, make assertions about it, and modify it. + +```ts +`@method` myApprovingMethod(update: AccountUpdate) { + this.approve(update); + + // read balance on the account (for example) + let balance = update.account.balance.getAndRequireEquals(); +} +``` + +Under the hood, "approving" just means that the account update is made a child of the zkApp in the +tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, +the entire tree will become a subtree of the zkApp's account update. + +Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update +at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally +excluding important information from the public input. + +#### Parameters + +##### update + +`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` + +#### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`approve`](DispatchSmartContractBase.md#approve) + +*** + +### deploy() + +> **deploy**(`__namedParameters`?): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:182 + +Deploys a SmartContract. + +```ts +let tx = await Mina.transaction(sender, async () => { + AccountUpdate.fundNewAccount(sender); + await zkapp.deploy(); +}); +tx.sign([senderKey, zkAppKey]); +``` + +#### Parameters + +##### \_\_namedParameters? + +###### verificationKey + +\{ `data`: `string`; `hash`: `string` \| `Field`; \} + +###### verificationKey.data + +`string` + +###### verificationKey.hash + +`string` \| `Field` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`deploy`](DispatchSmartContractBase.md#deploy) + +*** + +### deposit() + +> **deposit**(`amount`, `tokenId`, `bridgingContract`, `bridgingContractAttestation`, `l2Receiver`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:273](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L273) + +#### Parameters + +##### amount + +`UInt64` + +##### tokenId + +`Field` + +##### bridgingContract + +`PublicKey` + +##### bridgingContractAttestation + +[`TokenBridgeAttestation`](TokenBridgeAttestation.md) + +##### l2Receiver + +`PublicKey` + +#### Returns + +`Promise`\<`void`\> + +*** + +### dispatchMessage() + +> `protected` **dispatchMessage**\<`Type`\>(`methodId`, `value`, `valueType`): `void` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) + +#### Type Parameters + +• **Type** + +#### Parameters + +##### methodId + +`Field` + +##### value + +`Type` + +##### valueType + +`ProvableExtended`\<`Type`\> + +#### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`dispatchMessage`](DispatchSmartContractBase.md#dispatchmessage) + +*** + +### emitEvent() + +> **emitEvent**\<`K`\>(`type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 + +Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `"token-bridge-added"` \| `"incoming-message-placeholder"` + +#### Parameters + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`emitEvent`](DispatchSmartContractBase.md#emitevent) + +*** + +### emitEventIf() + +> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 + +Conditionally emits an event. + +Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `"token-bridge-added"` \| `"incoming-message-placeholder"` + +#### Parameters + +##### condition + +`Bool` + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`emitEventIf`](DispatchSmartContractBase.md#emiteventif) + +*** + +### enableTokenDeposits() + +> **enableTokenDeposits**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:244](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L244) + +#### Parameters + +##### tokenId + +`Field` + +##### bridgeContractAddress + +`PublicKey` + +##### settlementContractAddress + +`PublicKey` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`DispatchContractType`](../interfaces/DispatchContractType.md).[`enableTokenDeposits`](../interfaces/DispatchContractType.md#enabletokendeposits) + +*** + +### enableTokenDepositsBase() + +> `protected` **enableTokenDepositsBase**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) + +#### Parameters + +##### tokenId + +`Field` + +##### bridgeContractAddress + +`PublicKey` + +##### settlementContractAddress + +`PublicKey` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`enableTokenDepositsBase`](DispatchSmartContractBase.md#enabletokendepositsbase) + +*** + +### fetchEvents() + +> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 + +Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. + +#### Parameters + +##### start? + +`UInt32` + +The start height of the events to fetch. + +##### end? + +`UInt32` + +The end height of the events to fetch. If not provided, fetches events up to the latest height. + +#### Returns + +`Promise`\<`object`[]\> + +A promise that resolves to an array of objects, each containing the event type and event data for the specified range. + +#### Async + +#### Throws + +If there is an error fetching events from the Mina network. + +#### Example + +```ts +const startHeight = UInt32.from(1000); +const endHeight = UInt32.from(2000); +const events = await myZkapp.fetchEvents(startHeight, endHeight); +console.log(events); +``` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`fetchEvents`](DispatchSmartContractBase.md#fetchevents) + +*** + +### init() + +> **init**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 + +`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. +This method can be overridden as follows +``` +class MyContract extends SmartContract { + init() { + super.init(); + this.account.permissions.set(...); + this.x.set(Field(1)); + } +} +``` + +#### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`init`](DispatchSmartContractBase.md#init) + +*** + +### initialize() + +> **initialize**(`settlementContract`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:268](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L268) + +#### Parameters + +##### settlementContract + +`PublicKey` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`DispatchContractType`](../interfaces/DispatchContractType.md).[`initialize`](../interfaces/DispatchContractType.md#initialize) + +*** + +### initializeBase() + +> `protected` **initializeBase**(`settlementContract`): `void` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) + +#### Parameters + +##### settlementContract + +`PublicKey` + +#### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`initializeBase`](DispatchSmartContractBase.md#initializebase) + +*** + +### newSelf() + +> **newSelf**(`methodName`?): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 + +Same as `SmartContract.self` but explicitly creates a new AccountUpdate. + +#### Parameters + +##### methodName? + +`string` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`newSelf`](DispatchSmartContractBase.md#newself) + +*** + +### requireSignature() + +> **requireSignature**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 + +Use this command if the account update created by this SmartContract should be signed by the account owner, +instead of authorized with a proof. + +Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. + +If you only want to avoid creating proofs for quicker testing, we advise you to +use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting +`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, +with the only difference being that quick mock proofs are filled in instead of real proofs. + +#### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`requireSignature`](DispatchSmartContractBase.md#requiresignature) + +*** + +### send() + +> **send**(`args`): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 + +#### Parameters + +##### args + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### to + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`send`](DispatchSmartContractBase.md#send) + +*** + +### skipAuthorization() + +> **skipAuthorization**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 + +Use this command if the account update created by this SmartContract should have no authorization on it, +instead of being authorized with a proof. + +WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look +at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the +authorization flow. + +#### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`skipAuthorization`](DispatchSmartContractBase.md#skipauthorization) + +*** + +### updateMessagesHash() + +> **updateMessagesHash**(`executedMessagesHash`, `newPromisedMessagesHash`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:257](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L257) + +#### Parameters + +##### executedMessagesHash + +`Field` + +##### newPromisedMessagesHash + +`Field` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`DispatchContractType`](../interfaces/DispatchContractType.md).[`updateMessagesHash`](../interfaces/DispatchContractType.md#updatemessageshash) + +*** + +### updateMessagesHashBase() + +> `protected` **updateMessagesHashBase**(`executedMessagesHash`, `newPromisedMessagesHash`): `void` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) + +#### Parameters + +##### executedMessagesHash + +`Field` + +##### newPromisedMessagesHash + +`Field` + +#### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`updateMessagesHashBase`](DispatchSmartContractBase.md#updatemessageshashbase) + +*** + +### analyzeMethods() + +> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 + +This function is run internally before compiling a smart contract, to collect metadata about what each of your +smart contract methods does. + +For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, +so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. + +`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), +which is a good indicator for circuit size and the time it will take to create proofs. +To inspect the created circuit in detail, you can look at the returned `gates`. + +Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. + +#### Parameters + +##### \_\_namedParameters? + +###### printSummary + +`boolean` + +#### Returns + +`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +an object, keyed by method name, each entry containing: + - `rows` the size of the constraint system created by this method + - `digest` a digest of the method circuit + - `actions` the number of actions the method dispatches + - `gates` the constraint system, represented as an array of gates + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`analyzeMethods`](DispatchSmartContractBase.md#analyzemethods) + +*** + +### compile() + +> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 + +Compile your smart contract. + +This generates both the prover functions, needed to create proofs for running `@method`s, +and the verification key, needed to deploy your zkApp. + +Although provers and verification key are returned by this method, they are also cached internally and used when needed, +so you don't actually have to use the return value of this function. + +Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to +create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps +it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, +up to several minutes if your circuit is large or your hardware is not optimal for these operations. + +#### Parameters + +##### \_\_namedParameters? + +###### cache + +`Cache` + +###### forceRecompile + +`boolean` + +#### Returns + +`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`compile`](DispatchSmartContractBase.md#compile) + +*** + +### digest() + +> `static` **digest**(): `Promise`\<`string`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 + +Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. +This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or +a cached verification key can be used. + +#### Returns + +`Promise`\<`string`\> + +the digest, as a hex string + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`digest`](DispatchSmartContractBase.md#digest) + +*** + +### Proof() + +> `static` **Proof**(): (`__namedParameters`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 + +Returns a Proof type that belongs to this SmartContract. + +#### Returns + +`Function` + +##### Parameters + +###### \_\_namedParameters + +###### maxProofsVerified + +`0` \| `1` \| `2` + +###### proof + +`unknown` + +###### publicInput + +`ZkappPublicInput` + +###### publicOutput + +`undefined` + +##### Returns + +`object` + +###### maxProofsVerified + +> **maxProofsVerified**: `0` \| `1` \| `2` + +###### proof + +> **proof**: `unknown` + +###### publicInput + +> **publicInput**: `ZkappPublicInput` + +###### publicOutput + +> **publicOutput**: `undefined` + +###### shouldVerify + +> **shouldVerify**: `Bool` + +###### toJSON() + +###### Returns + +`JsonProof` + +###### verify() + +###### Returns + +`void` + +###### verifyIf() + +###### Parameters + +###### condition + +`Bool` + +###### Returns + +`void` + +##### publicInputType + +> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` + +###### Type declaration + +###### fromFields() + +> **fromFields**: (`fields`) => `object` + +###### Parameters + +###### fields + +`Field`[] + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### Type declaration + +###### empty() + +> **empty**: () => `object` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### fromJSON() + +> **fromJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`string` + +###### calls + +`string` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### toInput() + +> **toInput**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### fields? + +> `optional` **fields**: `Field`[] + +###### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +###### toJSON() + +> **toJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `string` + +###### calls + +> **calls**: `string` + +##### publicOutputType + +> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> + +##### tag() + +> **tag**: () => *typeof* `SmartContract` + +###### Returns + +*typeof* `SmartContract` + +##### dummy() + +###### Type Parameters + +• **Input** + +• **OutPut** + +###### Parameters + +###### publicInput + +`Input` + +###### publicOutput + +`OutPut` + +###### maxProofsVerified + +`0` | `1` | `2` + +###### domainLog2? + +`number` + +###### Returns + +`Promise`\<`Proof`\<`Input`, `OutPut`\>\> + +##### fromJSON() + +###### Type Parameters + +• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` + +###### Parameters + +###### this + +`S` + +###### \_\_namedParameters + +`JsonProof` + +###### Returns + +`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`Proof`](DispatchSmartContractBase.md#proof) + +*** + +### runOutsideCircuit() + +> `static` **runOutsideCircuit**(`run`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 + +#### Parameters + +##### run + +() => `void` + +#### Returns + +`void` + +#### Inherited from + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`runOutsideCircuit`](DispatchSmartContractBase.md#runoutsidecircuit) diff --git a/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md b/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md new file mode 100644 index 0000000..d81b54d --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md @@ -0,0 +1,1245 @@ +--- +title: DispatchSmartContractBase +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DispatchSmartContractBase + +# Class: `abstract` DispatchSmartContractBase + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L59) + +## Extends + +- `SmartContract` + +## Extended by + +- [`DispatchSmartContract`](DispatchSmartContract.md) + +## Constructors + +### new DispatchSmartContractBase() + +> **new DispatchSmartContractBase**(`address`, `tokenId`?): [`DispatchSmartContractBase`](DispatchSmartContractBase.md) + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 + +#### Parameters + +##### address + +`PublicKey` + +##### tokenId? + +`Field` + +#### Returns + +[`DispatchSmartContractBase`](DispatchSmartContractBase.md) + +#### Inherited from + +`SmartContract.constructor` + +## Properties + +### address + +> **address**: `PublicKey` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 + +#### Inherited from + +`SmartContract.address` + +*** + +### events + +> **events**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) + +A list of event types that can be emitted using this.emitEvent()`. + +#### incoming-message-placeholder + +> **incoming-message-placeholder**: *typeof* `Field` & (`x`) => `Field` = `Field` + +#### token-bridge-added + +> **token-bridge-added**: *typeof* [`TokenBridgeTreeAddition`](TokenBridgeTreeAddition.md) = `TokenBridgeTreeAddition` + +#### Overrides + +`SmartContract.events` + +*** + +### honoredMessagesHash + +> `abstract` **honoredMessagesHash**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L77) + +*** + +### promisedMessagesHash + +> `abstract` **promisedMessagesHash**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L75) + +*** + +### sender + +> **sender**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 + +#### self + +> **self**: `SmartContract` + +#### ~~getAndRequireSignature()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key. + +#### getAndRequireSignatureV2() + +Return a public key that is forced to sign this transaction. + +Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created +the transaction controls the private key associated with the returned public key. + +##### Returns + +`PublicKey` + +#### ~~getUnconstrained()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getUnconstrainedV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key, +which would cause an account update with that public key to not be included. + +#### getUnconstrainedV2() + +The public key of the current transaction's sender account. + +Throws an error if not inside a transaction, or the sender wasn't passed in. + +**Warning**: The fact that this public key equals the current sender is not part of the proof. +A malicious prover could use any other public key without affecting the validity of the proof. + +Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. + +##### Returns + +`PublicKey` + +#### Inherited from + +`SmartContract.sender` + +*** + +### settlementContract + +> `abstract` **settlementContract**: `State`\<`PublicKey`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L79) + +*** + +### tokenBridgeCount + +> `abstract` **tokenBridgeCount**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L83) + +*** + +### tokenBridgeRoot + +> `abstract` **tokenBridgeRoot**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L81) + +*** + +### tokenId + +> **tokenId**: `Field` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 + +#### Inherited from + +`SmartContract.tokenId` + +*** + +### \_maxProofsVerified? + +> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 + +#### Inherited from + +`SmartContract._maxProofsVerified` + +*** + +### \_methodMetadata? + +> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 + +#### Inherited from + +`SmartContract._methodMetadata` + +*** + +### \_methods? + +> `static` `optional` **\_methods**: `MethodInterface`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 + +#### Inherited from + +`SmartContract._methods` + +*** + +### \_provers? + +> `static` `optional` **\_provers**: `Prover`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 + +#### Inherited from + +`SmartContract._provers` + +*** + +### \_verificationKey? + +> `static` `optional` **\_verificationKey**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 + +#### data + +> **data**: `string` + +#### hash + +> **hash**: `Field` + +#### Inherited from + +`SmartContract._verificationKey` + +*** + +### args + +> `static` **args**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) + +#### incomingMessagesPaths + +> **incomingMessagesPaths**: `Record`\<`string`, `` `${string}.${string}` ``\> + +#### methodIdMappings + +> **methodIdMappings**: [`RuntimeMethodIdMapping`](../type-aliases/RuntimeMethodIdMapping.md) + +#### settlementContractClass? + +> `optional` **settlementContractClass**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> & *typeof* `SmartContract` + +## Accessors + +### account + +#### Get Signature + +> **get** **account**(): `Account` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 + +Current account of the SmartContract. + +##### Returns + +`Account` + +#### Inherited from + +`SmartContract.account` + +*** + +### balance + +#### Get Signature + +> **get** **balance**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 + +Balance of this SmartContract. + +##### Returns + +`object` + +###### addInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +###### subInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +#### Inherited from + +`SmartContract.balance` + +*** + +### currentSlot + +#### Get Signature + +> **get** **currentSlot**(): `CurrentSlot` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 + +Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value +at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) +or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) + +##### Returns + +`CurrentSlot` + +#### Inherited from + +`SmartContract.currentSlot` + +*** + +### network + +#### Get Signature + +> **get** **network**(): `Network` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 + +Current network state of the SmartContract. + +##### Returns + +`Network` + +#### Inherited from + +`SmartContract.network` + +*** + +### self + +#### Get Signature + +> **get** **self**(): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 + +Returns the current AccountUpdate associated to this SmartContract. + +##### Returns + +`AccountUpdate` + +#### Inherited from + +`SmartContract.self` + +## Methods + +### approve() + +> **approve**(`update`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 + +Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, +which allows you to read and use its content in a proof, make assertions about it, and modify it. + +```ts +`@method` myApprovingMethod(update: AccountUpdate) { + this.approve(update); + + // read balance on the account (for example) + let balance = update.account.balance.getAndRequireEquals(); +} +``` + +Under the hood, "approving" just means that the account update is made a child of the zkApp in the +tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, +the entire tree will become a subtree of the zkApp's account update. + +Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update +at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally +excluding important information from the public input. + +#### Parameters + +##### update + +`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` + +#### Returns + +`void` + +#### Inherited from + +`SmartContract.approve` + +*** + +### deploy() + +> **deploy**(`__namedParameters`?): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:182 + +Deploys a SmartContract. + +```ts +let tx = await Mina.transaction(sender, async () => { + AccountUpdate.fundNewAccount(sender); + await zkapp.deploy(); +}); +tx.sign([senderKey, zkAppKey]); +``` + +#### Parameters + +##### \_\_namedParameters? + +###### verificationKey + +\{ `data`: `string`; `hash`: `string` \| `Field`; \} + +###### verificationKey.data + +`string` + +###### verificationKey.hash + +`string` \| `Field` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`SmartContract.deploy` + +*** + +### dispatchMessage() + +> `protected` **dispatchMessage**\<`Type`\>(`methodId`, `value`, `valueType`): `void` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) + +#### Type Parameters + +• **Type** + +#### Parameters + +##### methodId + +`Field` + +##### value + +`Type` + +##### valueType + +`ProvableExtended`\<`Type`\> + +#### Returns + +`void` + +*** + +### emitEvent() + +> **emitEvent**\<`K`\>(`type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 + +Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `"token-bridge-added"` \| `"incoming-message-placeholder"` + +#### Parameters + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +`SmartContract.emitEvent` + +*** + +### emitEventIf() + +> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 + +Conditionally emits an event. + +Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `"token-bridge-added"` \| `"incoming-message-placeholder"` + +#### Parameters + +##### condition + +`Bool` + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +`SmartContract.emitEventIf` + +*** + +### enableTokenDepositsBase() + +> `protected` **enableTokenDepositsBase**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) + +#### Parameters + +##### tokenId + +`Field` + +##### bridgeContractAddress + +`PublicKey` + +##### settlementContractAddress + +`PublicKey` + +#### Returns + +`Promise`\<`void`\> + +*** + +### fetchEvents() + +> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 + +Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. + +#### Parameters + +##### start? + +`UInt32` + +The start height of the events to fetch. + +##### end? + +`UInt32` + +The end height of the events to fetch. If not provided, fetches events up to the latest height. + +#### Returns + +`Promise`\<`object`[]\> + +A promise that resolves to an array of objects, each containing the event type and event data for the specified range. + +#### Async + +#### Throws + +If there is an error fetching events from the Mina network. + +#### Example + +```ts +const startHeight = UInt32.from(1000); +const endHeight = UInt32.from(2000); +const events = await myZkapp.fetchEvents(startHeight, endHeight); +console.log(events); +``` + +#### Inherited from + +`SmartContract.fetchEvents` + +*** + +### init() + +> **init**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 + +`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. +This method can be overridden as follows +``` +class MyContract extends SmartContract { + init() { + super.init(); + this.account.permissions.set(...); + this.x.set(Field(1)); + } +} +``` + +#### Returns + +`void` + +#### Inherited from + +`SmartContract.init` + +*** + +### initializeBase() + +> `protected` **initializeBase**(`settlementContract`): `void` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) + +#### Parameters + +##### settlementContract + +`PublicKey` + +#### Returns + +`void` + +*** + +### newSelf() + +> **newSelf**(`methodName`?): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 + +Same as `SmartContract.self` but explicitly creates a new AccountUpdate. + +#### Parameters + +##### methodName? + +`string` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +`SmartContract.newSelf` + +*** + +### requireSignature() + +> **requireSignature**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 + +Use this command if the account update created by this SmartContract should be signed by the account owner, +instead of authorized with a proof. + +Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. + +If you only want to avoid creating proofs for quicker testing, we advise you to +use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting +`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, +with the only difference being that quick mock proofs are filled in instead of real proofs. + +#### Returns + +`void` + +#### Inherited from + +`SmartContract.requireSignature` + +*** + +### send() + +> **send**(`args`): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 + +#### Parameters + +##### args + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### to + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +`SmartContract.send` + +*** + +### skipAuthorization() + +> **skipAuthorization**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 + +Use this command if the account update created by this SmartContract should have no authorization on it, +instead of being authorized with a proof. + +WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look +at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the +authorization flow. + +#### Returns + +`void` + +#### Inherited from + +`SmartContract.skipAuthorization` + +*** + +### updateMessagesHashBase() + +> `protected` **updateMessagesHashBase**(`executedMessagesHash`, `newPromisedMessagesHash`): `void` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) + +#### Parameters + +##### executedMessagesHash + +`Field` + +##### newPromisedMessagesHash + +`Field` + +#### Returns + +`void` + +*** + +### analyzeMethods() + +> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 + +This function is run internally before compiling a smart contract, to collect metadata about what each of your +smart contract methods does. + +For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, +so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. + +`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), +which is a good indicator for circuit size and the time it will take to create proofs. +To inspect the created circuit in detail, you can look at the returned `gates`. + +Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. + +#### Parameters + +##### \_\_namedParameters? + +###### printSummary + +`boolean` + +#### Returns + +`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +an object, keyed by method name, each entry containing: + - `rows` the size of the constraint system created by this method + - `digest` a digest of the method circuit + - `actions` the number of actions the method dispatches + - `gates` the constraint system, represented as an array of gates + +#### Inherited from + +`SmartContract.analyzeMethods` + +*** + +### compile() + +> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 + +Compile your smart contract. + +This generates both the prover functions, needed to create proofs for running `@method`s, +and the verification key, needed to deploy your zkApp. + +Although provers and verification key are returned by this method, they are also cached internally and used when needed, +so you don't actually have to use the return value of this function. + +Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to +create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps +it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, +up to several minutes if your circuit is large or your hardware is not optimal for these operations. + +#### Parameters + +##### \_\_namedParameters? + +###### cache + +`Cache` + +###### forceRecompile + +`boolean` + +#### Returns + +`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +#### Inherited from + +`SmartContract.compile` + +*** + +### digest() + +> `static` **digest**(): `Promise`\<`string`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 + +Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. +This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or +a cached verification key can be used. + +#### Returns + +`Promise`\<`string`\> + +the digest, as a hex string + +#### Inherited from + +`SmartContract.digest` + +*** + +### Proof() + +> `static` **Proof**(): (`__namedParameters`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 + +Returns a Proof type that belongs to this SmartContract. + +#### Returns + +`Function` + +##### Parameters + +###### \_\_namedParameters + +###### maxProofsVerified + +`0` \| `1` \| `2` + +###### proof + +`unknown` + +###### publicInput + +`ZkappPublicInput` + +###### publicOutput + +`undefined` + +##### Returns + +`object` + +###### maxProofsVerified + +> **maxProofsVerified**: `0` \| `1` \| `2` + +###### proof + +> **proof**: `unknown` + +###### publicInput + +> **publicInput**: `ZkappPublicInput` + +###### publicOutput + +> **publicOutput**: `undefined` + +###### shouldVerify + +> **shouldVerify**: `Bool` + +###### toJSON() + +###### Returns + +`JsonProof` + +###### verify() + +###### Returns + +`void` + +###### verifyIf() + +###### Parameters + +###### condition + +`Bool` + +###### Returns + +`void` + +##### publicInputType + +> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` + +###### Type declaration + +###### fromFields() + +> **fromFields**: (`fields`) => `object` + +###### Parameters + +###### fields + +`Field`[] + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### Type declaration + +###### empty() + +> **empty**: () => `object` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### fromJSON() + +> **fromJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`string` + +###### calls + +`string` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### toInput() + +> **toInput**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### fields? + +> `optional` **fields**: `Field`[] + +###### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +###### toJSON() + +> **toJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `string` + +###### calls + +> **calls**: `string` + +##### publicOutputType + +> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> + +##### tag() + +> **tag**: () => *typeof* `SmartContract` + +###### Returns + +*typeof* `SmartContract` + +##### dummy() + +###### Type Parameters + +• **Input** + +• **OutPut** + +###### Parameters + +###### publicInput + +`Input` + +###### publicOutput + +`OutPut` + +###### maxProofsVerified + +`0` | `1` | `2` + +###### domainLog2? + +`number` + +###### Returns + +`Promise`\<`Proof`\<`Input`, `OutPut`\>\> + +##### fromJSON() + +###### Type Parameters + +• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` + +###### Parameters + +###### this + +`S` + +###### \_\_namedParameters + +`JsonProof` + +###### Returns + +`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +#### Inherited from + +`SmartContract.Proof` + +*** + +### runOutsideCircuit() + +> `static` **runOutsideCircuit**(`run`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 + +#### Parameters + +##### run + +() => `void` + +#### Returns + +`void` + +#### Inherited from + +`SmartContract.runOutsideCircuit` diff --git a/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md b/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md new file mode 100644 index 0000000..a1813e5 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md @@ -0,0 +1,380 @@ +--- +title: DynamicBlockProof +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DynamicBlockProof + +# Class: DynamicBlockProof + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L49) + +## Extends + +- `DynamicProof`\<[`BlockProverPublicInput`](BlockProverPublicInput.md), [`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> + +## Constructors + +### new DynamicBlockProof() + +> **new DynamicBlockProof**(`__namedParameters`): [`DynamicBlockProof`](DynamicBlockProof.md) + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:94 + +#### Parameters + +##### \_\_namedParameters + +###### maxProofsVerified + +`0` \| `1` \| `2` + +###### proof + +`unknown` + +###### publicInput + +[`BlockProverPublicInput`](BlockProverPublicInput.md) + +###### publicOutput + +[`BlockProverPublicOutput`](BlockProverPublicOutput.md) + +#### Returns + +[`DynamicBlockProof`](DynamicBlockProof.md) + +#### Inherited from + +`DynamicProof< BlockProverPublicInput, BlockProverPublicOutput >.constructor` + +## Properties + +### maxProofsVerified + +> **maxProofsVerified**: `0` \| `1` \| `2` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:91 + +#### Inherited from + +`DynamicProof.maxProofsVerified` + +*** + +### proof + +> **proof**: `unknown` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:90 + +#### Inherited from + +`DynamicProof.proof` + +*** + +### publicInput + +> **publicInput**: [`BlockProverPublicInput`](BlockProverPublicInput.md) + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:88 + +#### Inherited from + +`DynamicProof.publicInput` + +*** + +### publicOutput + +> **publicOutput**: [`BlockProverPublicOutput`](BlockProverPublicOutput.md) + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:89 + +#### Inherited from + +`DynamicProof.publicOutput` + +*** + +### shouldVerify + +> **shouldVerify**: `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:92 + +#### Inherited from + +`DynamicProof.shouldVerify` + +*** + +### usedVerificationKey? + +> `optional` **usedVerificationKey**: `VerificationKey` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:180 + +#### Inherited from + +`DynamicProof.usedVerificationKey` + +*** + +### featureFlags + +> `static` **featureFlags**: `FeatureFlags` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:176 + +As the name indicates, feature flags are features of the proof system. + +If we want to side load proofs and verification keys, we first have to tell Pickles what _shape_ of proofs it should expect. + +For example, if we want to side load proofs that use foreign field arithmetic custom gates, we have to make Pickles aware of that by defining +these custom gates. + +_Note:_ Only proofs that use the exact same composition of custom gates which were expected by Pickles can be verified using side loading. +If you want to verify _any_ proof, no matter what custom gates it uses, you can use FeatureFlags.allMaybe. Please note that this might incur a significant overhead. + +You can also toggle specific feature flags manually by specifying them here. +Alternatively, you can use {@FeatureFlags.fromZkProgram} to compute the set of feature flags that are compatible with a given program. + +#### Inherited from + +`DynamicProof.featureFlags` + +*** + +### maxProofsVerified + +> `static` **maxProofsVerified**: `2` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L57) + +#### Overrides + +`DynamicProof.maxProofsVerified` + +*** + +### publicInputType + +> `static` **publicInputType**: *typeof* [`BlockProverPublicInput`](BlockProverPublicInput.md) = `BlockProverPublicInput` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L53) + +#### Overrides + +`DynamicProof.publicInputType` + +*** + +### publicOutputType + +> `static` **publicOutputType**: *typeof* [`BlockProverPublicOutput`](BlockProverPublicOutput.md) = `BlockProverPublicOutput` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L55) + +#### Overrides + +`DynamicProof.publicOutputType` + +## Methods + +### toJSON() + +> **toJSON**(): `JsonProof` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:93 + +#### Returns + +`JsonProof` + +#### Inherited from + +`DynamicProof.toJSON` + +*** + +### verify() + +> **verify**(`vk`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:185 + +Verifies this DynamicProof using a given verification key + +#### Parameters + +##### vk + +`VerificationKey` + +The verification key this proof will be verified against + +#### Returns + +`void` + +#### Inherited from + +`DynamicProof.verify` + +*** + +### verifyIf() + +> **verifyIf**(`vk`, `condition`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:186 + +#### Parameters + +##### vk + +`VerificationKey` + +##### condition + +`Bool` + +#### Returns + +`void` + +#### Inherited from + +`DynamicProof.verifyIf` + +*** + +### dummy() + +> `static` **dummy**\<`S`\>(`this`, `publicInput`, `publicOutput`, `maxProofsVerified`, `domainLog2`?): `Promise`\<`InstanceType`\<`S`\>\> + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:188 + +#### Type Parameters + +• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> + +#### Parameters + +##### this + +`S` + +##### publicInput + +`InferProvable`\<`S`\[`"publicInputType"`\]\> + +##### publicOutput + +`InferProvable`\<`S`\[`"publicOutputType"`\]\> + +##### maxProofsVerified + +`0` | `1` | `2` + +##### domainLog2? + +`number` + +#### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +#### Inherited from + +`DynamicProof.dummy` + +*** + +### fromJSON() + +> `static` **fromJSON**\<`S`\>(`this`, `__namedParameters`): `Promise`\<`DynamicProof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:187 + +#### Type Parameters + +• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> + +#### Parameters + +##### this + +`S` + +##### \_\_namedParameters + +`JsonProof` + +#### Returns + +`Promise`\<`DynamicProof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +#### Inherited from + +`DynamicProof.fromJSON` + +*** + +### fromProof() + +> `static` **fromProof**\<`S`\>(`this`, `proof`): `InstanceType`\<`S`\> + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:194 + +Converts a Proof into a DynamicProof carrying over all relevant data. +This method can be used to convert a Proof computed by a ZkProgram +into a DynamicProof that is accepted in a circuit that accepts DynamicProofs + +#### Type Parameters + +• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> + +#### Parameters + +##### this + +`S` + +##### proof + +`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\> + +#### Returns + +`InstanceType`\<`S`\> + +#### Inherited from + +`DynamicProof.fromProof` + +*** + +### tag() + +> `static` **tag**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:177 + +#### Returns + +`object` + +##### name + +> **name**: `string` + +#### Inherited from + +`DynamicProof.tag` diff --git a/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md b/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md new file mode 100644 index 0000000..0302c3f --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md @@ -0,0 +1,380 @@ +--- +title: DynamicRuntimeProof +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DynamicRuntimeProof + +# Class: DynamicRuntimeProof + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L63) + +## Extends + +- `DynamicProof`\<`Void`, [`MethodPublicOutput`](MethodPublicOutput.md)\> + +## Constructors + +### new DynamicRuntimeProof() + +> **new DynamicRuntimeProof**(`__namedParameters`): [`DynamicRuntimeProof`](DynamicRuntimeProof.md) + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:94 + +#### Parameters + +##### \_\_namedParameters + +###### maxProofsVerified + +`0` \| `1` \| `2` + +###### proof + +`unknown` + +###### publicInput + +`undefined` + +###### publicOutput + +[`MethodPublicOutput`](MethodPublicOutput.md) + +#### Returns + +[`DynamicRuntimeProof`](DynamicRuntimeProof.md) + +#### Inherited from + +`DynamicProof< Void, MethodPublicOutput >.constructor` + +## Properties + +### maxProofsVerified + +> **maxProofsVerified**: `0` \| `1` \| `2` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:91 + +#### Inherited from + +`DynamicProof.maxProofsVerified` + +*** + +### proof + +> **proof**: `unknown` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:90 + +#### Inherited from + +`DynamicProof.proof` + +*** + +### publicInput + +> **publicInput**: `undefined` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:88 + +#### Inherited from + +`DynamicProof.publicInput` + +*** + +### publicOutput + +> **publicOutput**: [`MethodPublicOutput`](MethodPublicOutput.md) + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:89 + +#### Inherited from + +`DynamicProof.publicOutput` + +*** + +### shouldVerify + +> **shouldVerify**: `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:92 + +#### Inherited from + +`DynamicProof.shouldVerify` + +*** + +### usedVerificationKey? + +> `optional` **usedVerificationKey**: `VerificationKey` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:180 + +#### Inherited from + +`DynamicProof.usedVerificationKey` + +*** + +### featureFlags + +> `static` **featureFlags**: `FeatureFlags` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:176 + +As the name indicates, feature flags are features of the proof system. + +If we want to side load proofs and verification keys, we first have to tell Pickles what _shape_ of proofs it should expect. + +For example, if we want to side load proofs that use foreign field arithmetic custom gates, we have to make Pickles aware of that by defining +these custom gates. + +_Note:_ Only proofs that use the exact same composition of custom gates which were expected by Pickles can be verified using side loading. +If you want to verify _any_ proof, no matter what custom gates it uses, you can use FeatureFlags.allMaybe. Please note that this might incur a significant overhead. + +You can also toggle specific feature flags manually by specifying them here. +Alternatively, you can use {@FeatureFlags.fromZkProgram} to compute the set of feature flags that are compatible with a given program. + +#### Inherited from + +`DynamicProof.featureFlags` + +*** + +### maxProofsVerified + +> `static` **maxProofsVerified**: `0` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L72) + +#### Overrides + +`DynamicProof.maxProofsVerified` + +*** + +### publicInputType + +> `static` **publicInputType**: `ProvablePureExtended`\<`void`, `void`, `null`\> = `Void` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L67) + +#### Overrides + +`DynamicProof.publicInputType` + +*** + +### publicOutputType + +> `static` **publicOutputType**: *typeof* [`MethodPublicOutput`](MethodPublicOutput.md) = `MethodPublicOutput` + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L69) + +#### Overrides + +`DynamicProof.publicOutputType` + +## Methods + +### toJSON() + +> **toJSON**(): `JsonProof` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:93 + +#### Returns + +`JsonProof` + +#### Inherited from + +`DynamicProof.toJSON` + +*** + +### verify() + +> **verify**(`vk`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:185 + +Verifies this DynamicProof using a given verification key + +#### Parameters + +##### vk + +`VerificationKey` + +The verification key this proof will be verified against + +#### Returns + +`void` + +#### Inherited from + +`DynamicProof.verify` + +*** + +### verifyIf() + +> **verifyIf**(`vk`, `condition`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:186 + +#### Parameters + +##### vk + +`VerificationKey` + +##### condition + +`Bool` + +#### Returns + +`void` + +#### Inherited from + +`DynamicProof.verifyIf` + +*** + +### dummy() + +> `static` **dummy**\<`S`\>(`this`, `publicInput`, `publicOutput`, `maxProofsVerified`, `domainLog2`?): `Promise`\<`InstanceType`\<`S`\>\> + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:188 + +#### Type Parameters + +• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> + +#### Parameters + +##### this + +`S` + +##### publicInput + +`InferProvable`\<`S`\[`"publicInputType"`\]\> + +##### publicOutput + +`InferProvable`\<`S`\[`"publicOutputType"`\]\> + +##### maxProofsVerified + +`0` | `1` | `2` + +##### domainLog2? + +`number` + +#### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +#### Inherited from + +`DynamicProof.dummy` + +*** + +### fromJSON() + +> `static` **fromJSON**\<`S`\>(`this`, `__namedParameters`): `Promise`\<`DynamicProof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:187 + +#### Type Parameters + +• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> + +#### Parameters + +##### this + +`S` + +##### \_\_namedParameters + +`JsonProof` + +#### Returns + +`Promise`\<`DynamicProof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +#### Inherited from + +`DynamicProof.fromJSON` + +*** + +### fromProof() + +> `static` **fromProof**\<`S`\>(`this`, `proof`): `InstanceType`\<`S`\> + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:194 + +Converts a Proof into a DynamicProof carrying over all relevant data. +This method can be used to convert a Proof computed by a ZkProgram +into a DynamicProof that is accepted in a circuit that accepts DynamicProofs + +#### Type Parameters + +• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> + +#### Parameters + +##### this + +`S` + +##### proof + +`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\> + +#### Returns + +`InstanceType`\<`S`\> + +#### Inherited from + +`DynamicProof.fromProof` + +*** + +### tag() + +> `static` **tag**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:177 + +#### Returns + +`object` + +##### name + +> **name**: `string` + +#### Inherited from + +`DynamicProof.tag` diff --git a/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md b/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md new file mode 100644 index 0000000..531fc79 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md @@ -0,0 +1,212 @@ +--- +title: LastStateRootBlockHook +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / LastStateRootBlockHook + +# Class: LastStateRootBlockHook + +Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L5) + +## Extends + +- [`ProvableBlockHook`](ProvableBlockHook.md)\<`Record`\<`string`, `never`\>\> + +## Constructors + +### new LastStateRootBlockHook() + +> **new LastStateRootBlockHook**(): [`LastStateRootBlockHook`](LastStateRootBlockHook.md) + +#### Returns + +[`LastStateRootBlockHook`](LastStateRootBlockHook.md) + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`constructor`](ProvableBlockHook.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Record`\<`string`, `never`\> + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`currentConfig`](ProvableBlockHook.md#currentconfig) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`name`](ProvableBlockHook.md#name) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`protocol`](ProvableBlockHook.md#protocol) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`areProofsEnabled`](ProvableBlockHook.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`config`](ProvableBlockHook.md#config) + +## Methods + +### afterBlock() + +> **afterBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> + +Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L8) + +#### Parameters + +##### networkState + +[`NetworkState`](NetworkState.md) + +##### state + +[`BlockProverState`](../interfaces/BlockProverState.md) + +#### Returns + +`Promise`\<[`NetworkState`](NetworkState.md)\> + +#### Overrides + +[`ProvableBlockHook`](ProvableBlockHook.md).[`afterBlock`](ProvableBlockHook.md#afterblock) + +*** + +### beforeBlock() + +> **beforeBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> + +Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L20) + +#### Parameters + +##### networkState + +[`NetworkState`](NetworkState.md) + +##### state + +[`BlockProverState`](../interfaces/BlockProverState.md) + +#### Returns + +`Promise`\<[`NetworkState`](NetworkState.md)\> + +#### Overrides + +[`ProvableBlockHook`](ProvableBlockHook.md).[`beforeBlock`](ProvableBlockHook.md#beforeblock) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`create`](ProvableBlockHook.md#create) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`ProvableBlockHook`](ProvableBlockHook.md).[`start`](ProvableBlockHook.md#start) diff --git a/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md b/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md new file mode 100644 index 0000000..8d008bd --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md @@ -0,0 +1,680 @@ +--- +title: MethodPublicOutput +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MethodPublicOutput + +# Class: MethodPublicOutput + +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L7) + +Public input used to link in-circuit execution with +the proof's public input. + +## Extends + +- `object` + +## Constructors + +### new MethodPublicOutput() + +> **new MethodPublicOutput**(`value`): [`MethodPublicOutput`](MethodPublicOutput.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### eventsHash + +`Field` = `Field` + +###### isMessage + +`Bool` = `Bool` + +###### networkStateHash + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +###### status + +`Bool` = `Bool` + +###### transactionHash + +`Field` = `Field` + +#### Returns + +[`MethodPublicOutput`](MethodPublicOutput.md) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).constructor` + +## Properties + +### eventsHash + +> **eventsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L13) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).eventsHash` + +*** + +### isMessage + +> **isMessage**: `Bool` = `Bool` + +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L12) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).isMessage` + +*** + +### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L11) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).networkStateHash` + +*** + +### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L8) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).stateTransitionsHash` + +*** + +### status + +> **status**: `Bool` = `Bool` + +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L9) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).status` + +*** + +### transactionHash + +> **transactionHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L10) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).transactionHash` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### eventsHash + +`Field` = `Field` + +###### isMessage + +`Bool` = `Bool` + +###### networkStateHash + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +###### status + +`Bool` = `Bool` + +###### transactionHash + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### eventsHash + +> **eventsHash**: `Field` = `Field` + +##### isMessage + +> **isMessage**: `Bool` = `Bool` + +##### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +##### status + +> **status**: `Bool` = `Bool` + +##### transactionHash + +> **transactionHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### eventsHash + +> **eventsHash**: `Field` = `Field` + +##### isMessage + +> **isMessage**: `Bool` = `Bool` + +##### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +##### status + +> **status**: `Bool` = `Bool` + +##### transactionHash + +> **transactionHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### eventsHash + +`string` = `Field` + +###### isMessage + +`boolean` = `Bool` + +###### networkStateHash + +`string` = `Field` + +###### stateTransitionsHash + +`string` = `Field` + +###### status + +`boolean` = `Bool` + +###### transactionHash + +`string` = `Field` + +#### Returns + +`object` + +##### eventsHash + +> **eventsHash**: `Field` = `Field` + +##### isMessage + +> **isMessage**: `Bool` = `Bool` + +##### networkStateHash + +> **networkStateHash**: `Field` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +##### status + +> **status**: `Bool` = `Bool` + +##### transactionHash + +> **transactionHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### eventsHash + +`Field` = `Field` + +###### isMessage + +`Bool` = `Bool` + +###### networkStateHash + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +###### status + +`Bool` = `Bool` + +###### transactionHash + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### eventsHash + +`Field` = `Field` + +###### isMessage + +`Bool` = `Bool` + +###### networkStateHash + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +###### status + +`Bool` = `Bool` + +###### transactionHash + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### eventsHash + +`Field` = `Field` + +###### isMessage + +`Bool` = `Bool` + +###### networkStateHash + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +###### status + +`Bool` = `Bool` + +###### transactionHash + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### eventsHash + +`Field` = `Field` + +###### isMessage + +`Bool` = `Bool` + +###### networkStateHash + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +###### status + +`Bool` = `Bool` + +###### transactionHash + +`Field` = `Field` + +#### Returns + +`object` + +##### eventsHash + +> **eventsHash**: `string` = `Field` + +##### isMessage + +> **isMessage**: `boolean` = `Bool` + +##### networkStateHash + +> **networkStateHash**: `string` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `string` = `Field` + +##### status + +> **status**: `boolean` = `Bool` + +##### transactionHash + +> **transactionHash**: `string` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### eventsHash + +`Field` = `Field` + +###### isMessage + +`Bool` = `Bool` + +###### networkStateHash + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +###### status + +`Bool` = `Bool` + +###### transactionHash + +`Field` = `Field` + +#### Returns + +`object` + +##### eventsHash + +> **eventsHash**: `bigint` = `Field` + +##### isMessage + +> **isMessage**: `boolean` = `Bool` + +##### networkStateHash + +> **networkStateHash**: `bigint` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `bigint` = `Field` + +##### status + +> **status**: `boolean` = `Bool` + +##### transactionHash + +> **transactionHash**: `bigint` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md b/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md new file mode 100644 index 0000000..f1b5251 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md @@ -0,0 +1,433 @@ +--- +title: MethodVKConfigData +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MethodVKConfigData + +# Class: MethodVKConfigData + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L13) + +## Extends + +- `object` + +## Constructors + +### new MethodVKConfigData() + +> **new MethodVKConfigData**(`value`): [`MethodVKConfigData`](MethodVKConfigData.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### methodId + +`Field` = `Field` + +###### vkHash + +`Field` = `Field` + +#### Returns + +[`MethodVKConfigData`](MethodVKConfigData.md) + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).constructor` + +## Properties + +### methodId + +> **methodId**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L14) + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).methodId` + +*** + +### vkHash + +> **vkHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L15) + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).vkHash` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### methodId + +`Field` = `Field` + +###### vkHash + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### methodId + +> **methodId**: `Field` = `Field` + +##### vkHash + +> **vkHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### methodId + +> **methodId**: `Field` = `Field` + +##### vkHash + +> **vkHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### methodId + +`string` = `Field` + +###### vkHash + +`string` = `Field` + +#### Returns + +`object` + +##### methodId + +> **methodId**: `Field` = `Field` + +##### vkHash + +> **vkHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### methodId + +`Field` = `Field` + +###### vkHash + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### methodId + +`Field` = `Field` + +###### vkHash + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### methodId + +`Field` = `Field` + +###### vkHash + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### methodId + +`Field` = `Field` + +###### vkHash + +`Field` = `Field` + +#### Returns + +`object` + +##### methodId + +> **methodId**: `string` = `Field` + +##### vkHash + +> **vkHash**: `string` = `Field` + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### methodId + +`Field` = `Field` + +###### vkHash + +`Field` = `Field` + +#### Returns + +`object` + +##### methodId + +> **methodId**: `bigint` = `Field` + +##### vkHash + +> **vkHash**: `bigint` = `Field` + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).toValue` + +## Methods + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L17) + +#### Returns + +`Field` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ methodId: Field, vkHash: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/MinaActions.md b/src/pages/docs/reference/protocol/classes/MinaActions.md new file mode 100644 index 0000000..2510be7 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/MinaActions.md @@ -0,0 +1,45 @@ +--- +title: MinaActions +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MinaActions + +# Class: MinaActions + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L28) + +## Constructors + +### new MinaActions() + +> **new MinaActions**(): [`MinaActions`](MinaActions.md) + +#### Returns + +[`MinaActions`](MinaActions.md) + +## Methods + +### actionHash() + +> `static` **actionHash**(`action`, `previousHash`): `Field` + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L29) + +#### Parameters + +##### action + +`Field`[] + +##### previousHash + +`Field` = `...` + +#### Returns + +`Field` diff --git a/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md b/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md new file mode 100644 index 0000000..9d476bf --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md @@ -0,0 +1,172 @@ +--- +title: MinaActionsHashList +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MinaActionsHashList + +# Class: MinaActionsHashList + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L69) + +Utilities for creating a hash list from a given value type. + +## Extends + +- [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Field`\> + +## Constructors + +### new MinaActionsHashList() + +> **new MinaActionsHashList**(`internalCommitment`): [`MinaActionsHashList`](MinaActionsHashList.md) + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L70) + +#### Parameters + +##### internalCommitment + +`Field` = `...` + +#### Returns + +[`MinaActionsHashList`](MinaActionsHashList.md) + +#### Overrides + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`constructor`](MinaPrefixedProvableHashList.md#constructors) + +## Properties + +### commitment + +> **commitment**: `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) + +#### Inherited from + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`commitment`](MinaPrefixedProvableHashList.md#commitment) + +*** + +### prefix + +> `readonly` **prefix**: `string` + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) + +#### Inherited from + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`prefix`](MinaPrefixedProvableHashList.md#prefix-1) + +*** + +### valueType + +> `protected` `readonly` **valueType**: `ProvablePure`\<`Field`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) + +#### Inherited from + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`valueType`](MinaPrefixedProvableHashList.md#valuetype-1) + +## Methods + +### hash() + +> `protected` **hash**(`elements`): `Field` + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) + +#### Parameters + +##### elements + +`Field`[] + +#### Returns + +`Field` + +#### Inherited from + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`hash`](MinaPrefixedProvableHashList.md#hash) + +*** + +### push() + +> **push**(`value`): [`MinaActionsHashList`](MinaActionsHashList.md) + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) + +Converts the provided value to Field[] and appends it to +the current hashlist. + +#### Parameters + +##### value + +`Field` + +Value to be appended to the hash list + +#### Returns + +[`MinaActionsHashList`](MinaActionsHashList.md) + +Current hash list. + +#### Inherited from + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`push`](MinaPrefixedProvableHashList.md#push) + +*** + +### pushIf() + +> **pushIf**(`value`, `condition`): [`MinaActionsHashList`](MinaActionsHashList.md) + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L29) + +#### Parameters + +##### value + +`Field` + +##### condition + +`Bool` + +#### Returns + +[`MinaActionsHashList`](MinaActionsHashList.md) + +#### Inherited from + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`pushIf`](MinaPrefixedProvableHashList.md#pushif) + +*** + +### toField() + +> **toField**(): `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) + +#### Returns + +`Field` + +Traling hash of the current hashlist. + +#### Inherited from + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`toField`](MinaPrefixedProvableHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/MinaEvents.md b/src/pages/docs/reference/protocol/classes/MinaEvents.md new file mode 100644 index 0000000..497c10e --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/MinaEvents.md @@ -0,0 +1,45 @@ +--- +title: MinaEvents +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MinaEvents + +# Class: MinaEvents + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L41) + +## Constructors + +### new MinaEvents() + +> **new MinaEvents**(): [`MinaEvents`](MinaEvents.md) + +#### Returns + +[`MinaEvents`](MinaEvents.md) + +## Methods + +### eventHash() + +> `static` **eventHash**(`event`, `previousHash`): `Field` + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L42) + +#### Parameters + +##### event + +`Field`[] + +##### previousHash + +`Field` = `...` + +#### Returns + +`Field` diff --git a/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md b/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md new file mode 100644 index 0000000..087c9d9 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md @@ -0,0 +1,184 @@ +--- +title: MinaPrefixedProvableHashList +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MinaPrefixedProvableHashList + +# Class: MinaPrefixedProvableHashList\ + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L51) + +Utilities for creating a hash list from a given value type. + +## Extends + +- [`ProvableHashList`](ProvableHashList.md)\<`Value`\> + +## Extended by + +- [`MinaActionsHashList`](MinaActionsHashList.md) + +## Type Parameters + +• **Value** + +## Constructors + +### new MinaPrefixedProvableHashList() + +> **new MinaPrefixedProvableHashList**\<`Value`\>(`valueType`, `prefix`, `internalCommitment`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L54) + +#### Parameters + +##### valueType + +`ProvablePure`\<`Value`\> + +##### prefix + +`string` + +##### internalCommitment + +`Field` = `...` + +#### Returns + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> + +#### Overrides + +[`ProvableHashList`](ProvableHashList.md).[`constructor`](ProvableHashList.md#constructors) + +## Properties + +### commitment + +> **commitment**: `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`commitment`](ProvableHashList.md#commitment-1) + +*** + +### prefix + +> `readonly` **prefix**: `string` + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) + +*** + +### valueType + +> `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`valueType`](ProvableHashList.md#valuetype-1) + +## Methods + +### hash() + +> `protected` **hash**(`elements`): `Field` + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) + +#### Parameters + +##### elements + +`Field`[] + +#### Returns + +`Field` + +#### Overrides + +[`ProvableHashList`](ProvableHashList.md).[`hash`](ProvableHashList.md#hash) + +*** + +### push() + +> **push**(`value`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) + +Converts the provided value to Field[] and appends it to +the current hashlist. + +#### Parameters + +##### value + +`Value` + +Value to be appended to the hash list + +#### Returns + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> + +Current hash list. + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`push`](ProvableHashList.md#push) + +*** + +### pushIf() + +> **pushIf**(`value`, `condition`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L29) + +#### Parameters + +##### value + +`Value` + +##### condition + +`Bool` + +#### Returns + +[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`pushIf`](ProvableHashList.md#pushif) + +*** + +### toField() + +> **toField**(): `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) + +#### Returns + +`Field` + +Traling hash of the current hashlist. + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`toField`](ProvableHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/NetworkState.md b/src/pages/docs/reference/protocol/classes/NetworkState.md new file mode 100644 index 0000000..5c22f43 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/NetworkState.md @@ -0,0 +1,449 @@ +--- +title: NetworkState +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / NetworkState + +# Class: NetworkState + +Defined in: [packages/protocol/src/model/network/NetworkState.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L12) + +## Extends + +- `object` + +## Constructors + +### new NetworkState() + +> **new NetworkState**(`value`): [`NetworkState`](NetworkState.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### block + +[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` + +###### previous + +[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` + +#### Returns + +[`NetworkState`](NetworkState.md) + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).constructor` + +## Properties + +### block + +> **block**: [`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` + +Defined in: [packages/protocol/src/model/network/NetworkState.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L13) + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).block` + +*** + +### previous + +> **previous**: [`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` + +Defined in: [packages/protocol/src/model/network/NetworkState.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L14) + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).previous` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### block + +[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` + +###### previous + +[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).check` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### block + +> **block**: [`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` + +##### previous + +> **previous**: [`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### block + +\{ `height`: `string`; \} = `CurrentBlock` + +###### block.height + +`string` = `UInt64` + +###### previous + +\{ `rootHash`: `string`; \} = `PreviousBlock` + +###### previous.rootHash + +`string` = `Field` + +#### Returns + +`object` + +##### block + +> **block**: [`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` + +##### previous + +> **previous**: [`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### block + +[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` + +###### previous + +[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### block + +[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` + +###### previous + +[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### block + +[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` + +###### previous + +[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### block + +[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` + +###### previous + +[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` + +#### Returns + +`object` + +##### block + +> **block**: `object` = `CurrentBlock` + +###### block.height + +> **block.height**: `string` = `UInt64` + +##### previous + +> **previous**: `object` = `PreviousBlock` + +###### previous.rootHash + +> **previous.rootHash**: `string` = `Field` + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### block + +[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` + +###### previous + +[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` + +#### Returns + +`object` + +##### block + +> **block**: `object` = `CurrentBlock` + +###### block.height + +> **block.height**: `bigint` = `UInt64` + +##### previous + +> **previous**: `object` = `PreviousBlock` + +###### previous.rootHash + +> **previous.rootHash**: `bigint` = `Field` + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).toValue` + +## Methods + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/protocol/src/model/network/NetworkState.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L16) + +#### Returns + +`Field` + +*** + +### empty() + +> `static` **empty**(): [`NetworkState`](NetworkState.md) + +Defined in: [packages/protocol/src/model/network/NetworkState.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L23) + +#### Returns + +[`NetworkState`](NetworkState.md) + +#### Overrides + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).empty` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ block: CurrentBlock, previous: PreviousBlock, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md b/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md new file mode 100644 index 0000000..55c2b10 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md @@ -0,0 +1,176 @@ +--- +title: NetworkStateSettlementModule +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / NetworkStateSettlementModule + +# Class: NetworkStateSettlementModule + +Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L14) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ProvableSettlementHook`](ProvableSettlementHook.md)\<`NetworkStateSettlementModuleConfig`\> + +## Constructors + +### new NetworkStateSettlementModule() + +> **new NetworkStateSettlementModule**(): [`NetworkStateSettlementModule`](NetworkStateSettlementModule.md) + +#### Returns + +[`NetworkStateSettlementModule`](NetworkStateSettlementModule.md) + +#### Inherited from + +[`ProvableSettlementHook`](ProvableSettlementHook.md).[`constructor`](ProvableSettlementHook.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `NetworkStateSettlementModuleConfig` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProvableSettlementHook`](ProvableSettlementHook.md).[`currentConfig`](ProvableSettlementHook.md#currentconfig) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Inherited from + +[`ProvableSettlementHook`](ProvableSettlementHook.md).[`protocol`](ProvableSettlementHook.md#protocol) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +[`ProvableSettlementHook`](ProvableSettlementHook.md).[`areProofsEnabled`](ProvableSettlementHook.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProvableSettlementHook`](ProvableSettlementHook.md).[`config`](ProvableSettlementHook.md#config) + +## Methods + +### beforeSettlement() + +> **beforeSettlement**(`smartContract`, `__namedParameters`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L15) + +#### Parameters + +##### smartContract + +[`SettlementSmartContract`](SettlementSmartContract.md) + +##### \_\_namedParameters + +[`SettlementHookInputs`](../type-aliases/SettlementHookInputs.md) + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`ProvableSettlementHook`](ProvableSettlementHook.md).[`beforeSettlement`](ProvableSettlementHook.md#beforesettlement) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProvableSettlementHook`](ProvableSettlementHook.md).[`create`](ProvableSettlementHook.md#create) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`ProvableSettlementHook`](ProvableSettlementHook.md).[`start`](ProvableSettlementHook.md#start) diff --git a/src/pages/docs/reference/protocol/classes/Option.md b/src/pages/docs/reference/protocol/classes/Option.md new file mode 100644 index 0000000..1fa7bd7 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/Option.md @@ -0,0 +1,341 @@ +--- +title: Option +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Option + +# Class: Option\ + +Defined in: [packages/protocol/src/model/Option.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L84) + +Option facilitating in-circuit values that may or may not exist. + +## Extends + +- [`OptionBase`](OptionBase.md) + +## Type Parameters + +• **Value** + +## Constructors + +### new Option() + +> **new Option**\<`Value`\>(`isSome`, `value`, `valueType`, `isForcedSome`): [`Option`](Option.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/Option.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L122) + +#### Parameters + +##### isSome + +`Bool` + +##### value + +`Value` + +##### valueType + +`FlexibleProvablePure`\<`Value`\> + +##### isForcedSome + +`Bool` = `...` + +#### Returns + +[`Option`](Option.md)\<`Value`\> + +#### Overrides + +[`OptionBase`](OptionBase.md).[`constructor`](OptionBase.md#constructors) + +## Properties + +### isForcedSome + +> **isForcedSome**: `Bool` + +Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L24) + +#### Inherited from + +[`OptionBase`](OptionBase.md).[`isForcedSome`](OptionBase.md#isforcedsome-1) + +*** + +### isSome + +> **isSome**: `Bool` + +Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L23) + +#### Inherited from + +[`OptionBase`](OptionBase.md).[`isSome`](OptionBase.md#issome-1) + +*** + +### value + +> **value**: `Value` + +Defined in: [packages/protocol/src/model/Option.ts:124](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L124) + +*** + +### valueType + +> **valueType**: `FlexibleProvablePure`\<`Value`\> + +Defined in: [packages/protocol/src/model/Option.ts:125](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L125) + +## Accessors + +### treeValue + +#### Get Signature + +> **get** **treeValue**(): `Field` + +Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L34) + +##### Returns + +`Field` + +Tree representation of the current value + +#### Inherited from + +[`OptionBase`](OptionBase.md).[`treeValue`](OptionBase.md#treevalue) + +## Methods + +### clone() + +> **clone**(): [`Option`](Option.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/Option.ts:135](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L135) + +#### Returns + +[`Option`](Option.md)\<`Value`\> + +#### Overrides + +[`OptionBase`](OptionBase.md).[`clone`](OptionBase.md#clone) + +*** + +### encodeValueToFields() + +> **encodeValueToFields**(): `Field`[] + +Defined in: [packages/protocol/src/model/Option.ts:131](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L131) + +#### Returns + +`Field`[] + +#### Overrides + +[`OptionBase`](OptionBase.md).[`encodeValueToFields`](OptionBase.md#encodevaluetofields) + +*** + +### forceSome() + +> **forceSome**(): `void` + +Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L44) + +#### Returns + +`void` + +#### Inherited from + +[`OptionBase`](OptionBase.md).[`forceSome`](OptionBase.md#forcesome) + +*** + +### orElse() + +> **orElse**(`defaultValue`): `Value` + +Defined in: [packages/protocol/src/model/Option.ts:148](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L148) + +#### Parameters + +##### defaultValue + +`Value` + +#### Returns + +`Value` + +Returns the value of this option if it isSome, +otherwise returns the given defaultValue + +*** + +### toConstant() + +> **toConstant**(): [`Option`](Option.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/Option.ts:157](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L157) + +#### Returns + +[`Option`](Option.md)\<`Value`\> + +*** + +### toFields() + +> **toFields**(): `Field`[] + +Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L53) + +Returns the `to`-value as decoded as a list of fields +Not in circuit + +#### Returns + +`Field`[] + +#### Inherited from + +[`OptionBase`](OptionBase.md).[`toFields`](OptionBase.md#tofields) + +*** + +### toJSON() + +> **toJSON**(): `object` + +Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L70) + +#### Returns + +`object` + +##### isForcedSome + +> **isForcedSome**: `boolean` + +##### isSome + +> **isSome**: `boolean` + +##### value + +> **value**: `string`[] + +#### Inherited from + +[`OptionBase`](OptionBase.md).[`toJSON`](OptionBase.md#tojson) + +*** + +### toProvable() + +> **toProvable**(): [`ProvableOption`](ProvableOption.md) + +Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L63) + +#### Returns + +[`ProvableOption`](ProvableOption.md) + +Provable representation of the current option. + +#### Inherited from + +[`OptionBase`](OptionBase.md).[`toProvable`](OptionBase.md#toprovable) + +*** + +### from() + +> `static` **from**\<`Value`\>(`isSome`, `value`, `valueType`): [`Option`](Option.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/Option.ts:93](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L93) + +Creates a new Option from the provided parameters + +#### Type Parameters + +• **Value** + +#### Parameters + +##### isSome + +`Bool` + +##### value + +`Value` + +##### valueType + +`FlexibleProvablePure`\<`Value`\> + +#### Returns + +[`Option`](Option.md)\<`Value`\> + +New option from the provided parameters. + +*** + +### fromValue() + +> `static` **fromValue**\<`Value`\>(`value`, `valueType`): [`Option`](Option.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/Option.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L108) + +Creates a new Option from the provided parameters + +#### Type Parameters + +• **Value** + +#### Parameters + +##### value + +`Value` + +##### valueType + +`FlexibleProvablePure`\<`Value`\> + +#### Returns + +[`Option`](Option.md)\<`Value`\> + +New option from the provided parameters. + +*** + +### none() + +> `static` **none**(): [`Option`](Option.md)\<`Field`\> + +Defined in: [packages/protocol/src/model/Option.ts:118](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L118) + +#### Returns + +[`Option`](Option.md)\<`Field`\> + +Empty / none option diff --git a/src/pages/docs/reference/protocol/classes/OptionBase.md b/src/pages/docs/reference/protocol/classes/OptionBase.md new file mode 100644 index 0000000..79e878c --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/OptionBase.md @@ -0,0 +1,161 @@ +--- +title: OptionBase +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / OptionBase + +# Class: `abstract` OptionBase + +Defined in: [packages/protocol/src/model/Option.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L21) + +## Extended by + +- [`Option`](Option.md) +- [`UntypedOption`](../../sequencer/classes/UntypedOption.md) + +## Constructors + +### new OptionBase() + +> `protected` **new OptionBase**(`isSome`, `isForcedSome`): [`OptionBase`](OptionBase.md) + +Defined in: [packages/protocol/src/model/Option.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L22) + +#### Parameters + +##### isSome + +`Bool` + +##### isForcedSome + +`Bool` + +#### Returns + +[`OptionBase`](OptionBase.md) + +## Properties + +### isForcedSome + +> **isForcedSome**: `Bool` + +Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L24) + +*** + +### isSome + +> **isSome**: `Bool` + +Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L23) + +## Accessors + +### treeValue + +#### Get Signature + +> **get** **treeValue**(): `Field` + +Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L34) + +##### Returns + +`Field` + +Tree representation of the current value + +## Methods + +### clone() + +> `abstract` `protected` **clone**(): [`OptionBase`](OptionBase.md) + +Defined in: [packages/protocol/src/model/Option.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L29) + +#### Returns + +[`OptionBase`](OptionBase.md) + +*** + +### encodeValueToFields() + +> `abstract` `protected` **encodeValueToFields**(): `Field`[] + +Defined in: [packages/protocol/src/model/Option.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L27) + +#### Returns + +`Field`[] + +*** + +### forceSome() + +> **forceSome**(): `void` + +Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L44) + +#### Returns + +`void` + +*** + +### toFields() + +> **toFields**(): `Field`[] + +Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L53) + +Returns the `to`-value as decoded as a list of fields +Not in circuit + +#### Returns + +`Field`[] + +*** + +### toJSON() + +> **toJSON**(): `object` + +Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L70) + +#### Returns + +`object` + +##### isForcedSome + +> **isForcedSome**: `boolean` + +##### isSome + +> **isSome**: `boolean` + +##### value + +> **value**: `string`[] + +*** + +### toProvable() + +> **toProvable**(): [`ProvableOption`](ProvableOption.md) + +Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L63) + +#### Returns + +[`ProvableOption`](ProvableOption.md) + +Provable representation of the current option. diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md new file mode 100644 index 0000000..ec1ccec --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md @@ -0,0 +1,501 @@ +--- +title: OutgoingMessageArgument +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / OutgoingMessageArgument + +# Class: OutgoingMessageArgument + +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L8) + +## Extends + +- `object` + +## Constructors + +### new OutgoingMessageArgument() + +> **new OutgoingMessageArgument**(`value`): [`OutgoingMessageArgument`](OutgoingMessageArgument.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### value + +[`Withdrawal`](Withdrawal.md) = `Withdrawal` + +###### witness + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +#### Returns + +[`OutgoingMessageArgument`](OutgoingMessageArgument.md) + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).constructor` + +## Properties + +### value + +> **value**: [`Withdrawal`](Withdrawal.md) = `Withdrawal` + +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L10) + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).value` + +*** + +### witness + +> **witness**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L9) + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).witness` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### value + +[`Withdrawal`](Withdrawal.md) = `Withdrawal` + +###### witness + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### value + +> **value**: [`Withdrawal`](Withdrawal.md) = `Withdrawal` + +##### witness + +> **witness**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### value + +> **value**: [`Withdrawal`](Withdrawal.md) = `Withdrawal` + +##### witness + +> **witness**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### value + +\{ `address`: `string`; `amount`: `string`; `tokenId`: `string`; \} = `Withdrawal` + +###### value.address + +`string` = `PublicKey` + +###### value.amount + +`string` = `UInt64` + +###### value.tokenId + +`string` = `Field` + +###### witness + +\{ `isLeft`: `boolean`[]; `path`: `string`[]; \} = `RollupMerkleTreeWitness` + +###### witness.isLeft + +`boolean`[] + +###### witness.path + +`string`[] + +#### Returns + +`object` + +##### value + +> **value**: [`Withdrawal`](Withdrawal.md) = `Withdrawal` + +##### witness + +> **witness**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### value + +[`Withdrawal`](Withdrawal.md) = `Withdrawal` + +###### witness + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### value + +[`Withdrawal`](Withdrawal.md) = `Withdrawal` + +###### witness + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### value + +[`Withdrawal`](Withdrawal.md) = `Withdrawal` + +###### witness + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### value + +[`Withdrawal`](Withdrawal.md) = `Withdrawal` + +###### witness + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +#### Returns + +`object` + +##### value + +> **value**: `object` = `Withdrawal` + +###### value.address + +> **value.address**: `string` = `PublicKey` + +###### value.amount + +> **value.amount**: `string` = `UInt64` + +###### value.tokenId + +> **value.tokenId**: `string` = `Field` + +##### witness + +> **witness**: `object` = `RollupMerkleTreeWitness` + +###### witness.isLeft + +> **witness.isLeft**: `boolean`[] + +###### witness.path + +> **witness.path**: `string`[] + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### value + +[`Withdrawal`](Withdrawal.md) = `Withdrawal` + +###### witness + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` + +#### Returns + +`object` + +##### value + +> **value**: `object` = `Withdrawal` + +###### value.address + +> **value.address**: `object` = `PublicKey` + +###### value.address.isOdd + +> **value.address.isOdd**: `boolean` + +###### value.address.x + +> **value.address.x**: `bigint` + +###### value.amount + +> **value.amount**: `bigint` = `UInt64` + +###### value.tokenId + +> **value.tokenId**: `bigint` = `Field` + +##### witness + +> **witness**: `object` = `RollupMerkleTreeWitness` + +###### witness.isLeft + +> **witness.isLeft**: `boolean`[] + +###### witness.path + +> **witness.path**: `bigint`[] + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).toValue` + +## Methods + +### dummy() + +> `static` **dummy**(): [`OutgoingMessageArgument`](OutgoingMessageArgument.md) + +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L12) + +#### Returns + +[`OutgoingMessageArgument`](OutgoingMessageArgument.md) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md new file mode 100644 index 0000000..38c0e47 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md @@ -0,0 +1,439 @@ +--- +title: OutgoingMessageArgumentBatch +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / OutgoingMessageArgumentBatch + +# Class: OutgoingMessageArgumentBatch + +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L20) + +## Extends + +- `object` + +## Constructors + +### new OutgoingMessageArgumentBatch() + +> **new OutgoingMessageArgumentBatch**(`value`): [`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### arguments + +[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` + +###### isDummys + +`Bool`[] = `...` + +#### Returns + +[`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).constructor` + +## Properties + +### arguments + +> **arguments**: [`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] + +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L21) + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).arguments` + +*** + +### isDummys + +> **isDummys**: `Bool`[] + +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L26) + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).isDummys` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### arguments + +[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` + +###### isDummys + +`Bool`[] = `...` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### arguments + +> **arguments**: [`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] + +##### isDummys + +> **isDummys**: `Bool`[] + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### arguments + +> **arguments**: [`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] + +##### isDummys + +> **isDummys**: `Bool`[] + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### arguments + +`object`[] = `...` + +###### isDummys + +`boolean`[] = `...` + +#### Returns + +`object` + +##### arguments + +> **arguments**: [`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] + +##### isDummys + +> **isDummys**: `Bool`[] + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### arguments + +[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` + +###### isDummys + +`Bool`[] = `...` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### arguments + +[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` + +###### isDummys + +`Bool`[] = `...` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### arguments + +[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` + +###### isDummys + +`Bool`[] = `...` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### arguments + +[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` + +###### isDummys + +`Bool`[] = `...` + +#### Returns + +`object` + +##### arguments + +> **arguments**: `object`[] + +##### isDummys + +> **isDummys**: `boolean`[] + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### arguments + +[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` + +###### isDummys + +`Bool`[] = `...` + +#### Returns + +`object` + +##### arguments + +> **arguments**: `object`[] + +##### isDummys + +> **isDummys**: `boolean`[] + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).toValue` + +## Methods + +### fromMessages() + +> `static` **fromMessages**(`providedArguments`): [`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) + +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L28) + +#### Parameters + +##### providedArguments + +[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] + +#### Returns + +[`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md new file mode 100644 index 0000000..1630274 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md @@ -0,0 +1,421 @@ +--- +title: OutgoingMessageKey +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / OutgoingMessageKey + +# Class: OutgoingMessageKey + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L49) + +## Extends + +- `object` + +## Constructors + +### new OutgoingMessageKey() + +> **new OutgoingMessageKey**(`value`): [`OutgoingMessageKey`](OutgoingMessageKey.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +[`OutgoingMessageKey`](OutgoingMessageKey.md) + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).constructor` + +## Properties + +### index + +> **index**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L50) + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).index` + +*** + +### tokenId + +> **tokenId**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L51) + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).tokenId` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### index + +`string` = `Field` + +###### tokenId + +`string` = `Field` + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### index + +> **index**: `string` = `Field` + +##### tokenId + +> **tokenId**: `string` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### index + +> **index**: `bigint` = `Field` + +##### tokenId + +> **tokenId**: `bigint` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/Path.md b/src/pages/docs/reference/protocol/classes/Path.md new file mode 100644 index 0000000..9227cca --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/Path.md @@ -0,0 +1,107 @@ +--- +title: Path +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Path + +# Class: Path + +Defined in: [packages/protocol/src/model/Path.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Path.ts#L8) + +Helps manage path (key) identifiers for key-values in trees. + +## Constructors + +### new Path() + +> **new Path**(): [`Path`](Path.md) + +#### Returns + +[`Path`](Path.md) + +## Methods + +### fromKey() + +> `static` **fromKey**\<`KeyType`\>(`path`, `keyType`, `key`): `Field` + +Defined in: [packages/protocol/src/model/Path.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Path.ts#L42) + +Encodes an existing path with the provided key into a single Field. + +#### Type Parameters + +• **KeyType** + +#### Parameters + +##### path + +`Field` + +##### keyType + +`FlexibleProvablePure`\<`KeyType`\> + +##### key + +`KeyType` + +#### Returns + +`Field` + +Field representation of the leading path + the provided key. + +*** + +### fromProperty() + +> `static` **fromProperty**(`className`, `propertyKey`): `Field` + +Defined in: [packages/protocol/src/model/Path.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Path.ts#L26) + +Encodes a class name and its property name into a Field + +#### Parameters + +##### className + +`string` + +##### propertyKey + +`string` + +#### Returns + +`Field` + +Field representation of class name + property name + +*** + +### toField() + +> `static` **toField**(`value`): `Field` + +Defined in: [packages/protocol/src/model/Path.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Path.ts#L15) + +Encodes a JS string as a Field + +#### Parameters + +##### value + +`string` + +#### Returns + +`Field` + +Field representation of the provided value diff --git a/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md b/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md new file mode 100644 index 0000000..a3acfa2 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md @@ -0,0 +1,172 @@ +--- +title: PrefixedProvableHashList +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / PrefixedProvableHashList + +# Class: PrefixedProvableHashList\ + +Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/PrefixedProvableHashList.ts#L6) + +Utilities for creating a hash list from a given value type. + +## Extends + +- [`ProvableHashList`](ProvableHashList.md)\<`Value`\> + +## Type Parameters + +• **Value** + +## Constructors + +### new PrefixedProvableHashList() + +> **new PrefixedProvableHashList**\<`Value`\>(`valueType`, `prefix`, `internalCommitment`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/PrefixedProvableHashList.ts#L9) + +#### Parameters + +##### valueType + +`ProvablePure`\<`Value`\> + +##### prefix + +`string` + +##### internalCommitment + +`Field` = `...` + +#### Returns + +[`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> + +#### Overrides + +[`ProvableHashList`](ProvableHashList.md).[`constructor`](ProvableHashList.md#constructors) + +## Properties + +### commitment + +> **commitment**: `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`commitment`](ProvableHashList.md#commitment-1) + +*** + +### valueType + +> `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`valueType`](ProvableHashList.md#valuetype-1) + +## Methods + +### hash() + +> `protected` **hash**(`elements`): `Field` + +Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/PrefixedProvableHashList.ts#L18) + +#### Parameters + +##### elements + +`Field`[] + +#### Returns + +`Field` + +#### Overrides + +[`ProvableHashList`](ProvableHashList.md).[`hash`](ProvableHashList.md#hash) + +*** + +### push() + +> **push**(`value`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) + +Converts the provided value to Field[] and appends it to +the current hashlist. + +#### Parameters + +##### value + +`Value` + +Value to be appended to the hash list + +#### Returns + +[`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> + +Current hash list. + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`push`](ProvableHashList.md#push) + +*** + +### pushIf() + +> **pushIf**(`value`, `condition`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L29) + +#### Parameters + +##### value + +`Value` + +##### condition + +`Bool` + +#### Returns + +[`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`pushIf`](ProvableHashList.md#pushif) + +*** + +### toField() + +> **toField**(): `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) + +#### Returns + +`Field` + +Traling hash of the current hashlist. + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`toField`](ProvableHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/PreviousBlock.md b/src/pages/docs/reference/protocol/classes/PreviousBlock.md new file mode 100644 index 0000000..1cd5d17 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/PreviousBlock.md @@ -0,0 +1,357 @@ +--- +title: PreviousBlock +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / PreviousBlock + +# Class: PreviousBlock + +Defined in: [packages/protocol/src/model/network/NetworkState.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L8) + +## Extends + +- `object` + +## Constructors + +### new PreviousBlock() + +> **new PreviousBlock**(`value`): [`PreviousBlock`](PreviousBlock.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### rootHash + +`Field` = `Field` + +#### Returns + +[`PreviousBlock`](PreviousBlock.md) + +#### Inherited from + +`Struct({ rootHash: Field, }).constructor` + +## Properties + +### rootHash + +> **rootHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/model/network/NetworkState.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L9) + +#### Inherited from + +`Struct({ rootHash: Field, }).rootHash` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ rootHash: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### rootHash + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ rootHash: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### rootHash + +> **rootHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ rootHash: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### rootHash + +> **rootHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ rootHash: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### rootHash + +`string` = `Field` + +#### Returns + +`object` + +##### rootHash + +> **rootHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ rootHash: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ rootHash: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### rootHash + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ rootHash: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### rootHash + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ rootHash: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### rootHash + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ rootHash: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### rootHash + +`Field` = `Field` + +#### Returns + +`object` + +##### rootHash + +> **rootHash**: `string` = `Field` + +#### Inherited from + +`Struct({ rootHash: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### rootHash + +`Field` = `Field` + +#### Returns + +`object` + +##### rootHash + +> **rootHash**: `bigint` = `Field` + +#### Inherited from + +`Struct({ rootHash: Field, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ rootHash: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/Protocol.md b/src/pages/docs/reference/protocol/classes/Protocol.md new file mode 100644 index 0000000..02b425b --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/Protocol.md @@ -0,0 +1,716 @@ +--- +title: Protocol +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Protocol + +# Class: Protocol\ + +Defined in: [packages/protocol/src/protocol/Protocol.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L60) + +Reusable module container facilitating registration, resolution +configuration, decoration and validation of modules + +## Extends + +- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Modules`\> + +## Type Parameters + +• **Modules** *extends* [`ProtocolModulesRecord`](../type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../type-aliases/MandatoryProtocolModulesRecord.md) + +## Implements + +- [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +## Constructors + +### new Protocol() + +> **new Protocol**\<`Modules`\>(`definition`): [`Protocol`](Protocol.md)\<`Modules`\> + +Defined in: [packages/protocol/src/protocol/Protocol.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L78) + +#### Parameters + +##### definition + +[`ProtocolDefinition`](../interfaces/ProtocolDefinition.md)\<`Modules`\> + +#### Returns + +[`Protocol`](Protocol.md)\<`Modules`\> + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) + +*** + +### definition + +> **definition**: [`ProtocolDefinition`](../interfaces/ProtocolDefinition.md)\<`Modules`\> + +Defined in: [packages/protocol/src/protocol/Protocol.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L76) + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) + +## Accessors + +### blockProver + +#### Get Signature + +> **get** **blockProver**(): [`BlockProvable`](../interfaces/BlockProvable.md) + +Defined in: [packages/protocol/src/protocol/Protocol.ts:115](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L115) + +##### Returns + +[`BlockProvable`](../interfaces/BlockProvable.md) + +*** + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) + +*** + +### dependencyContainer + +#### Get Signature + +> **get** **dependencyContainer**(): `DependencyContainer` + +Defined in: [packages/protocol/src/protocol/Protocol.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L105) + +##### Returns + +`DependencyContainer` + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) + +*** + +### stateService + +#### Get Signature + +> **get** **stateService**(): [`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) + +Defined in: [packages/protocol/src/protocol/Protocol.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L83) + +##### Returns + +[`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) + +#### Implementation of + +[`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md).[`stateService`](../interfaces/ProtocolEnvironment.md#stateservice) + +*** + +### stateServiceProvider + +#### Get Signature + +> **get** **stateServiceProvider**(): [`StateServiceProvider`](StateServiceProvider.md) + +Defined in: [packages/protocol/src/protocol/Protocol.ts:87](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L87) + +##### Returns + +[`StateServiceProvider`](StateServiceProvider.md) + +#### Implementation of + +[`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md).[`stateServiceProvider`](../interfaces/ProtocolEnvironment.md#stateserviceprovider) + +*** + +### stateTransitionProver + +#### Get Signature + +> **get** **stateTransitionProver**(): [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) + +Defined in: [packages/protocol/src/protocol/Protocol.ts:123](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L123) + +##### Returns + +[`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/Protocol.ts:133](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L133) + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) + +*** + +### decorateModule() + +> **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: [packages/protocol/src/protocol/Protocol.ts:91](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L91) + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +`InstanceType`\<`Modules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>\]\> + +#### Returns + +`void` + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) + +*** + +### getAreProofsEnabled() + +> **getAreProofsEnabled**(): [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/Protocol.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L129) + +#### Returns + +[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Implementation of + +[`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md).[`getAreProofsEnabled`](../interfaces/ProtocolEnvironment.md#getareproofsenabled) + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>[] + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +`Modules` + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +`Modules` + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/Protocol.ts:186](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L186) + +#### Returns + +`Promise`\<`void`\> + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`Modules`\>(`modules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](Protocol.md)\<`Modules`\>\> + +Defined in: [packages/protocol/src/protocol/Protocol.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L66) + +#### Type Parameters + +• **Modules** *extends* [`ProtocolModulesRecord`](../type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../type-aliases/MandatoryProtocolModulesRecord.md) + +#### Parameters + +##### modules + +[`ProtocolDefinition`](../interfaces/ProtocolDefinition.md)\<`Modules`\> + +#### Returns + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](Protocol.md)\<`Modules`\>\> diff --git a/src/pages/docs/reference/protocol/classes/ProtocolModule.md b/src/pages/docs/reference/protocol/classes/ProtocolModule.md new file mode 100644 index 0000000..147516e --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/ProtocolModule.md @@ -0,0 +1,150 @@ +--- +title: ProtocolModule +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProtocolModule + +# Class: `abstract` ProtocolModule\ + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L11) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> + +## Extended by + +- [`BlockProver`](BlockProver.md) +- [`StateTransitionProver`](StateTransitionProver.md) +- [`BlockProverType`](../interfaces/BlockProverType.md) +- [`StateTransitionProverType`](../interfaces/StateTransitionProverType.md) +- [`ProvableSettlementHook`](ProvableSettlementHook.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +## Constructors + +### new ProtocolModule() + +> **new ProtocolModule**\<`Config`\>(): [`ProtocolModule`](ProtocolModule.md)\<`Config`\> + +#### Returns + +[`ProtocolModule`](ProtocolModule.md)\<`Config`\> + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Overrides + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md b/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md new file mode 100644 index 0000000..ce9974d --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md @@ -0,0 +1,213 @@ +--- +title: ProvableBlockHook +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableBlockHook + +# Class: `abstract` ProvableBlockHook\ + +Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProvableBlockHook.ts#L7) + +## Extends + +- `TransitioningProtocolModule`\<`Config`\> + +## Extended by + +- [`BlockHeightHook`](BlockHeightHook.md) +- [`LastStateRootBlockHook`](LastStateRootBlockHook.md) + +## Type Parameters + +• **Config** + +## Constructors + +### new ProvableBlockHook() + +> **new ProvableBlockHook**\<`Config`\>(): [`ProvableBlockHook`](ProvableBlockHook.md)\<`Config`\> + +#### Returns + +[`ProvableBlockHook`](ProvableBlockHook.md)\<`Config`\> + +#### Inherited from + +`TransitioningProtocolModule.constructor` + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +`TransitioningProtocolModule.currentConfig` + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) + +#### Inherited from + +`TransitioningProtocolModule.name` + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Inherited from + +`TransitioningProtocolModule.protocol` + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +`TransitioningProtocolModule.areProofsEnabled` + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +`TransitioningProtocolModule.config` + +## Methods + +### afterBlock() + +> `abstract` **afterBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> + +Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProvableBlockHook.ts#L15) + +#### Parameters + +##### networkState + +[`NetworkState`](NetworkState.md) + +##### state + +[`BlockProverState`](../interfaces/BlockProverState.md) + +#### Returns + +`Promise`\<[`NetworkState`](NetworkState.md)\> + +*** + +### beforeBlock() + +> `abstract` **beforeBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> + +Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProvableBlockHook.ts#L10) + +#### Parameters + +##### networkState + +[`NetworkState`](NetworkState.md) + +##### state + +[`BlockProverState`](../interfaces/BlockProverState.md) + +#### Returns + +`Promise`\<[`NetworkState`](NetworkState.md)\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +`TransitioningProtocolModule.create` + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TransitioningProtocolModule.start` diff --git a/src/pages/docs/reference/protocol/classes/ProvableHashList.md b/src/pages/docs/reference/protocol/classes/ProvableHashList.md new file mode 100644 index 0000000..ccbcbd2 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/ProvableHashList.md @@ -0,0 +1,143 @@ +--- +title: ProvableHashList +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableHashList + +# Class: `abstract` ProvableHashList\ + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L6) + +Utilities for creating a hash list from a given value type. + +## Extended by + +- [`DefaultProvableHashList`](DefaultProvableHashList.md) +- [`PrefixedProvableHashList`](PrefixedProvableHashList.md) +- [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md) +- [`ProvableReductionHashList`](ProvableReductionHashList.md) + +## Type Parameters + +• **Value** + +## Constructors + +### new ProvableHashList() + +> **new ProvableHashList**\<`Value`\>(`valueType`, `commitment`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L7) + +#### Parameters + +##### valueType + +`ProvablePure`\<`Value`\> + +##### commitment + +`Field` = `...` + +#### Returns + +[`ProvableHashList`](ProvableHashList.md)\<`Value`\> + +## Properties + +### commitment + +> **commitment**: `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) + +*** + +### valueType + +> `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) + +## Methods + +### hash() + +> `abstract` `protected` **hash**(`elements`): `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L12) + +#### Parameters + +##### elements + +`Field`[] + +#### Returns + +`Field` + +*** + +### push() + +> **push**(`value`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) + +Converts the provided value to Field[] and appends it to +the current hashlist. + +#### Parameters + +##### value + +`Value` + +Value to be appended to the hash list + +#### Returns + +[`ProvableHashList`](ProvableHashList.md)\<`Value`\> + +Current hash list. + +*** + +### pushIf() + +> **pushIf**(`value`, `condition`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L29) + +#### Parameters + +##### value + +`Value` + +##### condition + +`Bool` + +#### Returns + +[`ProvableHashList`](ProvableHashList.md)\<`Value`\> + +*** + +### toField() + +> **toField**(): `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) + +#### Returns + +`Field` + +Traling hash of the current hashlist. diff --git a/src/pages/docs/reference/protocol/classes/ProvableOption.md b/src/pages/docs/reference/protocol/classes/ProvableOption.md new file mode 100644 index 0000000..28bb333 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/ProvableOption.md @@ -0,0 +1,433 @@ +--- +title: ProvableOption +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableOption + +# Class: ProvableOption + +Defined in: [packages/protocol/src/model/Option.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L11) + +## Extends + +- `object` + +## Constructors + +### new ProvableOption() + +> **new ProvableOption**(`value`): [`ProvableOption`](ProvableOption.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### isSome + +`Bool` = `Bool` + +###### value + +`Field` = `Field` + +#### Returns + +[`ProvableOption`](ProvableOption.md) + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).constructor` + +## Properties + +### isSome + +> **isSome**: `Bool` = `Bool` + +Defined in: [packages/protocol/src/model/Option.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L12) + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).isSome` + +*** + +### value + +> **value**: `Field` = `Field` + +Defined in: [packages/protocol/src/model/Option.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L13) + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).value` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### isSome + +`Bool` = `Bool` + +###### value + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### isSome + +> **isSome**: `Bool` = `Bool` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### isSome + +> **isSome**: `Bool` = `Bool` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### isSome + +`boolean` = `Bool` + +###### value + +`string` = `Field` + +#### Returns + +`object` + +##### isSome + +> **isSome**: `Bool` = `Bool` + +##### value + +> **value**: `Field` = `Field` + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### isSome + +`Bool` = `Bool` + +###### value + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### isSome + +`Bool` = `Bool` + +###### value + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### isSome + +`Bool` = `Bool` + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### isSome + +`Bool` = `Bool` + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### isSome + +> **isSome**: `boolean` = `Bool` + +##### value + +> **value**: `string` = `Field` + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### isSome + +`Bool` = `Bool` + +###### value + +`Field` = `Field` + +#### Returns + +`object` + +##### isSome + +> **isSome**: `boolean` = `Bool` + +##### value + +> **value**: `bigint` = `Field` + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).toValue` + +## Methods + +### toSome() + +> **toSome**(): [`ProvableOption`](ProvableOption.md) + +Defined in: [packages/protocol/src/model/Option.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L15) + +#### Returns + +[`ProvableOption`](ProvableOption.md) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ isSome: Bool, value: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md b/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md new file mode 100644 index 0000000..fc8b639 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md @@ -0,0 +1,210 @@ +--- +title: ProvableReductionHashList +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableReductionHashList + +# Class: ProvableReductionHashList\ + +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L5) + +Utilities for creating a hash list from a given value type. + +## Extends + +- [`ProvableHashList`](ProvableHashList.md)\<`Value`\> + +## Extended by + +- [`StateTransitionReductionList`](StateTransitionReductionList.md) + +## Type Parameters + +• **Value** + +## Constructors + +### new ProvableReductionHashList() + +> **new ProvableReductionHashList**\<`Value`\>(`valueType`, `commitment`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L7) + +#### Parameters + +##### valueType + +`ProvablePure`\<`Value`\> + +##### commitment + +`Field` = `...` + +#### Returns + +[`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`constructor`](ProvableHashList.md#constructors) + +## Properties + +### commitment + +> **commitment**: `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`commitment`](ProvableHashList.md#commitment-1) + +*** + +### unconstrainedList + +> **unconstrainedList**: `Value`[] = `[]` + +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) + +*** + +### valueType + +> `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`valueType`](ProvableHashList.md#valuetype-1) + +## Methods + +### hash() + +> **hash**(`elements`): `Field` + +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) + +#### Parameters + +##### elements + +`Field`[] + +#### Returns + +`Field` + +#### Overrides + +[`ProvableHashList`](ProvableHashList.md).[`hash`](ProvableHashList.md#hash) + +*** + +### push() + +> **push**(`value`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) + +Converts the provided value to Field[] and appends it to +the current hashlist. + +#### Parameters + +##### value + +`Value` + +Value to be appended to the hash list + +#### Returns + +[`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> + +Current hash list. + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`push`](ProvableHashList.md#push) + +*** + +### pushAndReduce() + +> **pushAndReduce**(`value`, `reduce`): `object` + +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) + +#### Parameters + +##### value + +`Value` + +##### reduce + +(`previous`) => \[`Value`, `Bool`\] + +#### Returns + +`object` + +##### popLast + +> **popLast**: `Bool` + +##### value + +> **value**: `Value` + +*** + +### pushIf() + +> **pushIf**(`value`, `condition`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> + +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) + +#### Parameters + +##### value + +`Value` + +##### condition + +`Bool` + +#### Returns + +[`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> + +#### Overrides + +[`ProvableHashList`](ProvableHashList.md).[`pushIf`](ProvableHashList.md#pushif) + +*** + +### toField() + +> **toField**(): `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) + +#### Returns + +`Field` + +Traling hash of the current hashlist. + +#### Inherited from + +[`ProvableHashList`](ProvableHashList.md).[`toField`](ProvableHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md b/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md new file mode 100644 index 0000000..00705aa --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md @@ -0,0 +1,180 @@ +--- +title: ProvableSettlementHook +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableSettlementHook + +# Class: `abstract` ProvableSettlementHook\ + +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L29) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ProtocolModule`](ProtocolModule.md)\<`Config`\> + +## Extended by + +- [`NetworkStateSettlementModule`](NetworkStateSettlementModule.md) + +## Type Parameters + +• **Config** + +## Constructors + +### new ProvableSettlementHook() + +> **new ProvableSettlementHook**\<`Config`\>(): [`ProvableSettlementHook`](ProvableSettlementHook.md)\<`Config`\> + +#### Returns + +[`ProvableSettlementHook`](ProvableSettlementHook.md)\<`Config`\> + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`constructor`](ProtocolModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`currentConfig`](ProtocolModule.md#currentconfig) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`protocol`](ProtocolModule.md#protocol) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`areProofsEnabled`](ProtocolModule.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`config`](ProtocolModule.md#config) + +## Methods + +### beforeSettlement() + +> `abstract` **beforeSettlement**(`smartContract`, `inputs`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L32) + +#### Parameters + +##### smartContract + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md) + +##### inputs + +[`SettlementHookInputs`](../type-aliases/SettlementHookInputs.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`create`](ProtocolModule.md#create) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`start`](ProtocolModule.md#start) diff --git a/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md b/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md new file mode 100644 index 0000000..85d3bef --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md @@ -0,0 +1,549 @@ +--- +title: ProvableStateTransition +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableStateTransition + +# Class: ProvableStateTransition + +Defined in: [packages/protocol/src/model/StateTransition.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L10) + +Provable representation of a State Transition, used to +normalize state transitions of various value types for +the state transition circuit. + +## Extends + +- `object` + +## Constructors + +### new ProvableStateTransition() + +> **new ProvableStateTransition**(`value`): [`ProvableStateTransition`](ProvableStateTransition.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### from + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +###### path + +`Field` = `Field` + +###### to + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +#### Returns + +[`ProvableStateTransition`](ProvableStateTransition.md) + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).constructor `` + +## Properties + +### from + +> **from**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` + +Defined in: [packages/protocol/src/model/StateTransition.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L14) + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).from `` + +*** + +### path + +> **path**: `Field` = `Field` + +Defined in: [packages/protocol/src/model/StateTransition.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L11) + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).path `` + +*** + +### to + +> **to**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` + +Defined in: [packages/protocol/src/model/StateTransition.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L17) + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).to `` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, })._isStruct `` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### from + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +###### path + +`Field` = `Field` + +###### to + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +#### Returns + +`void` + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).check `` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### from + +> **from**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` + +##### path + +> **path**: `Field` = `Field` + +##### to + +> **to**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).empty `` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### from + +> **from**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` + +##### path + +> **path**: `Field` = `Field` + +##### to + +> **to**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).fromFields `` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### from + +\{ `isSome`: `boolean`; `value`: `string`; \} = `ProvableOption` + +###### from.isSome + +`boolean` = `Bool` + +###### from.value + +`string` = `Field` + +###### path + +`string` = `Field` + +###### to + +\{ `isSome`: `boolean`; `value`: `string`; \} = `ProvableOption` + +###### to.isSome + +`boolean` = `Bool` + +###### to.value + +`string` = `Field` + +#### Returns + +`object` + +##### from + +> **from**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` + +##### path + +> **path**: `Field` = `Field` + +##### to + +> **to**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).fromJSON `` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).fromValue `` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### from + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +###### path + +`Field` = `Field` + +###### to + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).toAuxiliary `` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### from + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +###### path + +`Field` = `Field` + +###### to + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).toFields `` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### from + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +###### path + +`Field` = `Field` + +###### to + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).toInput `` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### from + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +###### path + +`Field` = `Field` + +###### to + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +#### Returns + +`object` + +##### from + +> **from**: `object` = `ProvableOption` + +###### from.isSome + +> **from.isSome**: `boolean` = `Bool` + +###### from.value + +> **from.value**: `string` = `Field` + +##### path + +> **path**: `string` = `Field` + +##### to + +> **to**: `object` = `ProvableOption` + +###### to.isSome + +> **to.isSome**: `boolean` = `Bool` + +###### to.value + +> **to.value**: `string` = `Field` + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).toJSON `` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### from + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +###### path + +`Field` = `Field` + +###### to + +[`ProvableOption`](ProvableOption.md) = `ProvableOption` + +#### Returns + +`object` + +##### from + +> **from**: `object` = `ProvableOption` + +###### from.isSome + +> **from.isSome**: `boolean` = `Bool` + +###### from.value + +> **from.value**: `bigint` = `Field` + +##### path + +> **path**: `bigint` = `Field` + +##### to + +> **to**: `object` = `ProvableOption` + +###### to.isSome + +> **to.isSome**: `boolean` = `Bool` + +###### to.value + +> **to.value**: `bigint` = `Field` + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).toValue `` + +## Methods + +### dummy() + +> `static` **dummy**(): [`ProvableStateTransition`](ProvableStateTransition.md) + +Defined in: [packages/protocol/src/model/StateTransition.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L19) + +#### Returns + +[`ProvableStateTransition`](ProvableStateTransition.md) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).sizeInFields `` diff --git a/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md b/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md new file mode 100644 index 0000000..5c53774 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md @@ -0,0 +1,409 @@ +--- +title: ProvableStateTransitionType +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableStateTransitionType + +# Class: ProvableStateTransitionType + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L27) + +## Extends + +- `object` + +## Constructors + +### new ProvableStateTransitionType() + +> **new ProvableStateTransitionType**(`value`): [`ProvableStateTransitionType`](ProvableStateTransitionType.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### type + +`Bool` = `Bool` + +#### Returns + +[`ProvableStateTransitionType`](ProvableStateTransitionType.md) + +#### Inherited from + +`Struct({ type: Bool, }).constructor` + +## Properties + +### type + +> **type**: `Bool` = `Bool` + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L28) + +#### Inherited from + +`Struct({ type: Bool, }).type` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ type: Bool, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### type + +`Bool` = `Bool` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ type: Bool, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### type + +> **type**: `Bool` = `Bool` + +#### Inherited from + +`Struct({ type: Bool, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### type + +> **type**: `Bool` = `Bool` + +#### Inherited from + +`Struct({ type: Bool, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### type + +`boolean` = `Bool` + +#### Returns + +`object` + +##### type + +> **type**: `Bool` = `Bool` + +#### Inherited from + +`Struct({ type: Bool, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ type: Bool, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### type + +`Bool` = `Bool` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ type: Bool, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### type + +`Bool` = `Bool` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ type: Bool, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### type + +`Bool` = `Bool` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ type: Bool, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### type + +`Bool` = `Bool` + +#### Returns + +`object` + +##### type + +> **type**: `boolean` = `Bool` + +#### Inherited from + +`Struct({ type: Bool, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### type + +`Bool` = `Bool` + +#### Returns + +`object` + +##### type + +> **type**: `boolean` = `Bool` + +#### Inherited from + +`Struct({ type: Bool, }).toValue` + +## Accessors + +### normal + +#### Get Signature + +> **get** `static` **normal**(): [`ProvableStateTransitionType`](ProvableStateTransitionType.md) + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L30) + +##### Returns + +[`ProvableStateTransitionType`](ProvableStateTransitionType.md) + +*** + +### protocol + +#### Get Signature + +> **get** `static` **protocol**(): [`ProvableStateTransitionType`](ProvableStateTransitionType.md) + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L36) + +##### Returns + +[`ProvableStateTransitionType`](ProvableStateTransitionType.md) + +## Methods + +### isNormal() + +> **isNormal**(): `Bool` + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L42) + +#### Returns + +`Bool` + +*** + +### isProtocol() + +> **isProtocol**(): `Bool` + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L46) + +#### Returns + +`Bool` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ type: Bool, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md b/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md new file mode 100644 index 0000000..c042068 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md @@ -0,0 +1,187 @@ +--- +title: ProvableTransactionHook +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableTransactionHook + +# Class: `abstract` ProvableTransactionHook\ + +Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProvableTransactionHook.ts#L7) + +## Extends + +- `TransitioningProtocolModule`\<`Config`\> + +## Extended by + +- [`AccountStateHook`](AccountStateHook.md) +- [`TransactionFeeHook`](../../library/classes/TransactionFeeHook.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +## Constructors + +### new ProvableTransactionHook() + +> **new ProvableTransactionHook**\<`Config`\>(): [`ProvableTransactionHook`](ProvableTransactionHook.md)\<`Config`\> + +#### Returns + +[`ProvableTransactionHook`](ProvableTransactionHook.md)\<`Config`\> + +#### Inherited from + +`TransitioningProtocolModule.constructor` + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +`TransitioningProtocolModule.currentConfig` + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) + +#### Inherited from + +`TransitioningProtocolModule.name` + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Inherited from + +`TransitioningProtocolModule.protocol` + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +`TransitioningProtocolModule.areProofsEnabled` + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +`TransitioningProtocolModule.config` + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +`TransitioningProtocolModule.create` + +*** + +### onTransaction() + +> `abstract` **onTransaction**(`executionData`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProvableTransactionHook.ts#L10) + +#### Parameters + +##### executionData + +[`BlockProverExecutionData`](BlockProverExecutionData.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TransitioningProtocolModule.start` diff --git a/src/pages/docs/reference/protocol/classes/PublicKeyOption.md b/src/pages/docs/reference/protocol/classes/PublicKeyOption.md new file mode 100644 index 0000000..535fd35 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/PublicKeyOption.md @@ -0,0 +1,479 @@ +--- +title: PublicKeyOption +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / PublicKeyOption + +# Class: PublicKeyOption + +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L26) + +## Extends + +- `Generic`\<`PublicKey`, `this`\> + +## Constructors + +### new PublicKeyOption() + +> **new PublicKeyOption**(`value`): [`PublicKeyOption`](PublicKeyOption.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### isSome + +`Bool` = `Bool` + +###### value + +`PublicKey` = `valueType` + +#### Returns + +[`PublicKeyOption`](PublicKeyOption.md) + +#### Inherited from + +`genericOptionFactory( PublicKey ).constructor` + +## Properties + +### isSome + +> **isSome**: `Bool` = `Bool` + +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L5) + +#### Inherited from + +`genericOptionFactory( PublicKey ).isSome` + +*** + +### value + +> **value**: `PublicKey` = `valueType` + +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L6) + +#### Inherited from + +`genericOptionFactory( PublicKey ).value` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`genericOptionFactory( PublicKey )._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### isSome + +`Bool` = `Bool` + +###### value + +`PublicKey` = `valueType` + +#### Returns + +`void` + +#### Inherited from + +`genericOptionFactory( PublicKey ).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### isSome + +> **isSome**: `Bool` = `Bool` + +##### value + +> **value**: `PublicKey` = `valueType` + +#### Inherited from + +`genericOptionFactory( PublicKey ).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`, `aux`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 + +A function that returns an element of type `T` from the given provable and "auxiliary" data. + +This function is the reverse operation of calling [toFields](PublicKeyOption.md#tofields) and toAuxilary methods on an element of type `T`. + +#### Parameters + +##### fields + +`Field`[] + +an array of Field elements describing the provable data of the new `T` element. + +##### aux + +`any`[] + +an array of any type describing the "auxiliary" data of the new `T` element, optional. + +#### Returns + +`object` + +An element of type `T` generated from the given provable and "auxiliary" data. + +##### isSome + +> **isSome**: `Bool` = `Bool` + +##### value + +> **value**: `PublicKey` = `valueType` + +#### Inherited from + +`genericOptionFactory( PublicKey ).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### isSome + +`boolean` = `Bool` + +###### value + +`any` = `valueType` + +#### Returns + +`object` + +##### isSome + +> **isSome**: `Bool` = `Bool` + +##### value + +> **value**: `PublicKey` = `valueType` + +#### Inherited from + +`genericOptionFactory( PublicKey ).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`genericOptionFactory( PublicKey ).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### isSome + +`Bool` = `Bool` + +###### value + +`PublicKey` = `valueType` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`genericOptionFactory( PublicKey ).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### isSome + +`Bool` = `Bool` + +###### value + +`PublicKey` = `valueType` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`genericOptionFactory( PublicKey ).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### isSome + +`Bool` = `Bool` + +###### value + +`PublicKey` = `valueType` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`genericOptionFactory( PublicKey ).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### isSome + +`Bool` = `Bool` + +###### value + +`PublicKey` = `valueType` + +#### Returns + +`object` + +##### isSome + +> **isSome**: `boolean` = `Bool` + +##### value + +> **value**: `any` = `valueType` + +#### Inherited from + +`genericOptionFactory( PublicKey ).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### isSome + +`Bool` = `Bool` + +###### value + +`PublicKey` = `valueType` + +#### Returns + +`object` + +##### isSome + +> **isSome**: `boolean` = `Bool` + +##### value + +> **value**: `any` = `valueType` + +#### Inherited from + +`genericOptionFactory( PublicKey ).toValue` + +## Methods + +### fromSome() + +> `static` **fromSome**(`value`): `Generic`\<`PublicKey`\> + +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L8) + +#### Parameters + +##### value + +`PublicKey` + +#### Returns + +`Generic`\<`PublicKey`\> + +#### Inherited from + +`genericOptionFactory( PublicKey ).fromSome` + +*** + +### none() + +> `static` **none**(`value`): `Generic`\<`PublicKey`\> + +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L15) + +#### Parameters + +##### value + +`PublicKey` + +#### Returns + +`Generic`\<`PublicKey`\> + +#### Inherited from + +`genericOptionFactory( PublicKey ).none` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`genericOptionFactory( PublicKey ).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md new file mode 100644 index 0000000..1f32379 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md @@ -0,0 +1,398 @@ +--- +title: RuntimeMethodExecutionContext +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeMethodExecutionContext + +# Class: RuntimeMethodExecutionContext + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L54) + +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'. + +## Extends + +- [`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md) + +## Constructors + +### new RuntimeMethodExecutionContext() + +> **new RuntimeMethodExecutionContext**(): [`RuntimeMethodExecutionContext`](RuntimeMethodExecutionContext.md) + +#### Returns + +[`RuntimeMethodExecutionContext`](RuntimeMethodExecutionContext.md) + +#### Inherited from + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`constructor`](../../common/classes/ProvableMethodExecutionContext.md#constructors) + +## Properties + +### id + +> **id**: `string` + +Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:16 + +#### Inherited from + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`id`](../../common/classes/ProvableMethodExecutionContext.md#id) + +*** + +### input + +> **input**: `undefined` \| [`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md) + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L57) + +*** + +### methods + +> **methods**: `string`[] = `[]` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L55) + +#### Overrides + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`methods`](../../common/classes/ProvableMethodExecutionContext.md#methods) + +*** + +### result + +> **result**: [`RuntimeProvableMethodExecutionResult`](RuntimeProvableMethodExecutionResult.md) + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L62) + +#### Overrides + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`result`](../../common/classes/ProvableMethodExecutionContext.md#result) + +## Accessors + +### isFinished + +#### Get Signature + +> **get** **isFinished**(): `boolean` + +Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:41 + +##### Returns + +`boolean` + +#### Inherited from + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`isFinished`](../../common/classes/ProvableMethodExecutionContext.md#isfinished) + +*** + +### isTopLevel + +#### Get Signature + +> **get** **isTopLevel**(): `boolean` + +Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:40 + +##### Returns + +`boolean` + +#### Inherited from + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`isTopLevel`](../../common/classes/ProvableMethodExecutionContext.md#istoplevel) + +## Methods + +### addEvent() + +> **addEvent**(`eventType`, `event`, `eventName`, `condition`): `void` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L83) + +#### Parameters + +##### eventType + +`FlexibleProvablePure`\<`any`\> + +##### event + +`any` + +##### eventName + +`string` + +##### condition + +`Bool` = `...` + +#### Returns + +`void` + +*** + +### addStateTransition() + +> **addStateTransition**\<`Value`\>(`stateTransition`): `void` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L78) + +Adds an in-method generated state transition to the current context + +#### Type Parameters + +• **Value** + +#### Parameters + +##### stateTransition + +[`StateTransition`](StateTransition.md)\<`Value`\> + +State transition to add to the context + +#### Returns + +`void` + +*** + +### afterMethod() + +> **afterMethod**(): `void` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:152](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L152) + +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` + +#### Overrides + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`afterMethod`](../../common/classes/ProvableMethodExecutionContext.md#aftermethod) + +*** + +### beforeMethod() + +> **beforeMethod**(`moduleName`, `methodName`, `args`): `void` + +Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:33 + +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`](../../common/type-aliases/ArgumentTypes.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`beforeMethod`](../../common/classes/ProvableMethodExecutionContext.md#beforemethod) + +*** + +### clear() + +> **clear**(): `void` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:148](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L148) + +Manually clears/resets the execution context + +#### Returns + +`void` + +#### Overrides + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`clear`](../../common/classes/ProvableMethodExecutionContext.md#clear) + +*** + +### current() + +> **current**(): `object` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:166](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L166) + +Had to override current() otherwise it would not infer +the type of result correctly (parent type would be reused) + +#### Returns + +`object` + +##### input + +> **input**: `undefined` \| [`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md) + +##### isFinished + +> **isFinished**: `boolean` + +##### isSimulated + +> **isSimulated**: `boolean` + +##### result + +> **result**: [`RuntimeProvableMethodExecutionResult`](RuntimeProvableMethodExecutionResult.md) + +#### Overrides + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`current`](../../common/classes/ProvableMethodExecutionContext.md#current) + +*** + +### setProver() + +> **setProver**(`prover`): `void` + +Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:26 + +Adds a method prover to the current execution context, +which can be collected and ran asynchronously at a later point in time. + +#### Parameters + +##### prover + +() => `Promise`\<`Proof`\<`unknown`, `unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`setProver`](../../common/classes/ProvableMethodExecutionContext.md#setprover) + +*** + +### setSimulated() + +> **setSimulated**(`simulated`): `void` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:141](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L141) + +#### Parameters + +##### simulated + +`boolean` + +#### Returns + +`void` + +*** + +### setStatus() + +> **setStatus**(`status`): `void` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L114) + +#### Parameters + +##### status + +`Bool` + +Execution status of the current method + +#### Returns + +`void` + +*** + +### setStatusMessage() + +> **setStatusMessage**(`message`?, `stackTrace`?): `void` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L102) + +#### Parameters + +##### message? + +`string` + +Status message to acompany the current status + +##### stackTrace? + +`string` + +#### Returns + +`void` + +*** + +### setup() + +> **setup**(`input`): `void` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:125](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L125) + +#### Parameters + +##### input + +[`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md) + +Input witness data required for a runtime execution + +#### Returns + +`void` + +*** + +### witnessInput() + +> **witnessInput**(): [`RuntimeMethodExecutionDataStruct`](RuntimeMethodExecutionDataStruct.md) + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L129) + +#### Returns + +[`RuntimeMethodExecutionDataStruct`](RuntimeMethodExecutionDataStruct.md) diff --git a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md new file mode 100644 index 0000000..3c465f6 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md @@ -0,0 +1,591 @@ +--- +title: RuntimeMethodExecutionDataStruct +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeMethodExecutionDataStruct + +# Class: RuntimeMethodExecutionDataStruct + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L41) + +## Extends + +- `object` + +## Implements + +- [`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md) + +## Constructors + +### new RuntimeMethodExecutionDataStruct() + +> **new RuntimeMethodExecutionDataStruct**(`value`): [`RuntimeMethodExecutionDataStruct`](RuntimeMethodExecutionDataStruct.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +[`RuntimeMethodExecutionDataStruct`](RuntimeMethodExecutionDataStruct.md) + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).constructor` + +## Properties + +### networkState + +> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L44) + +#### Implementation of + +[`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md).[`networkState`](../interfaces/RuntimeMethodExecutionData.md#networkstate) + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).networkState` + +*** + +### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L43) + +#### Implementation of + +[`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md).[`transaction`](../interfaces/RuntimeMethodExecutionData.md#transaction) + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).transaction` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### networkState + +> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` + +##### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`, `aux`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 + +A function that returns an element of type `T` from the given provable and "auxiliary" data. + +This function is the reverse operation of calling [toFields](RuntimeMethodExecutionDataStruct.md#tofields) and toAuxilary methods on an element of type `T`. + +#### Parameters + +##### fields + +`Field`[] + +an array of Field elements describing the provable data of the new `T` element. + +##### aux + +`any`[] + +an array of any type describing the "auxiliary" data of the new `T` element, optional. + +#### Returns + +`object` + +An element of type `T` generated from the given provable and "auxiliary" data. + +##### networkState + +> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` + +##### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### networkState + +\{ `block`: \{ `height`: `string`; \}; `previous`: \{ `rootHash`: `string`; \}; \} = `NetworkState` + +###### networkState.block + +\{ `height`: `string`; \} = `CurrentBlock` + +###### networkState.block.height + +`string` = `UInt64` + +###### networkState.previous + +\{ `rootHash`: `string`; \} = `PreviousBlock` + +###### networkState.previous.rootHash + +`string` = `Field` + +###### transaction + +\{ `argsHash`: `string`; `methodId`: `string`; `nonce`: \{ `isSome`: `boolean`; `value`: `any`; \}; `sender`: \{ `isSome`: `boolean`; `value`: `any`; \}; \} = `RuntimeTransaction` + +###### transaction.argsHash + +`string` = `Field` + +###### transaction.methodId + +`string` = `Field` + +###### transaction.nonce + +\{ `isSome`: `boolean`; `value`: `any`; \} = `UInt64Option` + +###### transaction.nonce.isSome + +`boolean` = `Bool` + +###### transaction.nonce.value + +`any` = `valueType` + +###### transaction.sender + +\{ `isSome`: `boolean`; `value`: `any`; \} = `PublicKeyOption` + +###### transaction.sender.isSome + +`boolean` = `Bool` + +###### transaction.sender.value + +`any` = `valueType` + +#### Returns + +`object` + +##### networkState + +> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` + +##### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`object` + +##### networkState + +> **networkState**: `object` = `NetworkState` + +###### networkState.block + +> **networkState.block**: `object` = `CurrentBlock` + +###### networkState.block.height + +> **networkState.block.height**: `string` = `UInt64` + +###### networkState.previous + +> **networkState.previous**: `object` = `PreviousBlock` + +###### networkState.previous.rootHash + +> **networkState.previous.rootHash**: `string` = `Field` + +##### transaction + +> **transaction**: `object` = `RuntimeTransaction` + +###### transaction.argsHash + +> **transaction.argsHash**: `string` = `Field` + +###### transaction.methodId + +> **transaction.methodId**: `string` = `Field` + +###### transaction.nonce + +> **transaction.nonce**: `object` = `UInt64Option` + +###### transaction.nonce.isSome + +> **transaction.nonce.isSome**: `boolean` = `Bool` + +###### transaction.nonce.value + +> **transaction.nonce.value**: `any` = `valueType` + +###### transaction.sender + +> **transaction.sender**: `object` = `PublicKeyOption` + +###### transaction.sender.isSome + +> **transaction.sender.isSome**: `boolean` = `Bool` + +###### transaction.sender.value + +> **transaction.sender.value**: `any` = `valueType` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### networkState + +[`NetworkState`](NetworkState.md) = `NetworkState` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`object` + +##### networkState + +> **networkState**: `object` = `NetworkState` + +###### networkState.block + +> **networkState.block**: `object` = `CurrentBlock` + +###### networkState.block.height + +> **networkState.block.height**: `bigint` = `UInt64` + +###### networkState.previous + +> **networkState.previous**: `object` = `PreviousBlock` + +###### networkState.previous.rootHash + +> **networkState.previous.rootHash**: `bigint` = `Field` + +##### transaction + +> **transaction**: `object` = `RuntimeTransaction` + +###### transaction.argsHash + +> **transaction.argsHash**: `bigint` = `Field` + +###### transaction.methodId + +> **transaction.methodId**: `bigint` = `Field` + +###### transaction.nonce + +> **transaction.nonce**: `object` = `UInt64Option` + +###### transaction.nonce.isSome + +> **transaction.nonce.isSome**: `boolean` = `Bool` + +###### transaction.nonce.value + +> **transaction.nonce.value**: `any` = `valueType` + +###### transaction.sender + +> **transaction.sender**: `object` = `PublicKeyOption` + +###### transaction.sender.isSome + +> **transaction.sender.isSome**: `boolean` = `Bool` + +###### transaction.sender.value + +> **transaction.sender.value**: `any` = `valueType` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md b/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md new file mode 100644 index 0000000..574fc84 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md @@ -0,0 +1,159 @@ +--- +title: RuntimeProvableMethodExecutionResult +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeProvableMethodExecutionResult + +# Class: RuntimeProvableMethodExecutionResult + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L19) + +## Extends + +- [`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md) + +## Constructors + +### new RuntimeProvableMethodExecutionResult() + +> **new RuntimeProvableMethodExecutionResult**(): [`RuntimeProvableMethodExecutionResult`](RuntimeProvableMethodExecutionResult.md) + +#### Returns + +[`RuntimeProvableMethodExecutionResult`](RuntimeProvableMethodExecutionResult.md) + +#### Inherited from + +[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`constructor`](../../common/classes/ProvableMethodExecutionResult.md#constructors) + +## Properties + +### args? + +> `optional` **args**: [`ArgumentTypes`](../../common/type-aliases/ArgumentTypes.md) + +Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:6 + +#### Inherited from + +[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`args`](../../common/classes/ProvableMethodExecutionResult.md#args) + +*** + +### events + +> **events**: `object`[] = `[]` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L28) + +#### condition + +> **condition**: `Bool` + +#### event + +> **event**: `any` + +#### eventName + +> **eventName**: `string` + +#### eventType + +> **eventType**: `FlexibleProvablePure`\<`any`\> + +*** + +### methodName? + +> `optional` **methodName**: `string` + +Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:5 + +#### Inherited from + +[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`methodName`](../../common/classes/ProvableMethodExecutionResult.md#methodname) + +*** + +### moduleName? + +> `optional` **moduleName**: `string` + +Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:4 + +#### Inherited from + +[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`moduleName`](../../common/classes/ProvableMethodExecutionResult.md#modulename) + +*** + +### prover()? + +> `optional` **prover**: () => `Promise`\<`Proof`\<`unknown`, `unknown`\>\> + +Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:7 + +#### Returns + +`Promise`\<`Proof`\<`unknown`, `unknown`\>\> + +#### Inherited from + +[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`prover`](../../common/classes/ProvableMethodExecutionResult.md#prover) + +*** + +### stackTrace? + +> `optional` **stackTrace**: `string` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L26) + +*** + +### stateTransitions + +> **stateTransitions**: [`StateTransition`](StateTransition.md)\<`any`\>[] = `[]` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L20) + +*** + +### status + +> **status**: `Bool` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L22) + +*** + +### statusMessage? + +> `optional` **statusMessage**: `string` + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L24) + +## Methods + +### prove() + +> **prove**\<`ProofType`\>(): `Promise`\<`ProofType`\> + +Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:8 + +#### Type Parameters + +• **ProofType** *extends* `Proof`\<`unknown`, `unknown`\> + +#### Returns + +`Promise`\<`ProofType`\> + +#### Inherited from + +[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`prove`](../../common/classes/ProvableMethodExecutionResult.md#prove) diff --git a/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md b/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md new file mode 100644 index 0000000..725ef05 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md @@ -0,0 +1,743 @@ +--- +title: RuntimeTransaction +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeTransaction + +# Class: RuntimeTransaction + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L11) + +This struct is used to expose transaction information to the runtime method +execution. This class has not all data included in transactions on purpose. +For example, we don't want to expose the signature or args as fields. + +## Extends + +- `object` + +## Constructors + +### new RuntimeTransaction() + +> **new RuntimeTransaction**(`value`): [`RuntimeTransaction`](RuntimeTransaction.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### argsHash + +`Field` = `Field` + +###### methodId + +`Field` = `Field` + +###### nonce + +[`UInt64Option`](UInt64Option.md) = `UInt64Option` + +###### sender + +[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +#### Returns + +[`RuntimeTransaction`](RuntimeTransaction.md) + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).constructor` + +## Properties + +### argsHash + +> **argsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L13) + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).argsHash` + +*** + +### methodId + +> **methodId**: `Field` = `Field` + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L12) + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).methodId` + +*** + +### nonce + +> **nonce**: [`UInt64Option`](UInt64Option.md) = `UInt64Option` + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L14) + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).nonce` + +*** + +### sender + +> **sender**: [`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L15) + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).sender` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### argsHash + +`Field` = `Field` + +###### methodId + +`Field` = `Field` + +###### nonce + +[`UInt64Option`](UInt64Option.md) = `UInt64Option` + +###### sender + +[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### argsHash + +> **argsHash**: `Field` = `Field` + +##### methodId + +> **methodId**: `Field` = `Field` + +##### nonce + +> **nonce**: [`UInt64Option`](UInt64Option.md) = `UInt64Option` + +##### sender + +> **sender**: [`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`, `aux`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 + +A function that returns an element of type `T` from the given provable and "auxiliary" data. + +This function is the reverse operation of calling [toFields](RuntimeTransaction.md#tofields) and toAuxilary methods on an element of type `T`. + +#### Parameters + +##### fields + +`Field`[] + +an array of Field elements describing the provable data of the new `T` element. + +##### aux + +`any`[] + +an array of any type describing the "auxiliary" data of the new `T` element, optional. + +#### Returns + +`object` + +An element of type `T` generated from the given provable and "auxiliary" data. + +##### argsHash + +> **argsHash**: `Field` = `Field` + +##### methodId + +> **methodId**: `Field` = `Field` + +##### nonce + +> **nonce**: [`UInt64Option`](UInt64Option.md) = `UInt64Option` + +##### sender + +> **sender**: [`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### argsHash + +`string` = `Field` + +###### methodId + +`string` = `Field` + +###### nonce + +\{ `isSome`: `boolean`; `value`: `any`; \} = `UInt64Option` + +###### nonce.isSome + +`boolean` = `Bool` + +###### nonce.value + +`any` = `valueType` + +###### sender + +\{ `isSome`: `boolean`; `value`: `any`; \} = `PublicKeyOption` + +###### sender.isSome + +`boolean` = `Bool` + +###### sender.value + +`any` = `valueType` + +#### Returns + +`object` + +##### argsHash + +> **argsHash**: `Field` = `Field` + +##### methodId + +> **methodId**: `Field` = `Field` + +##### nonce + +> **nonce**: [`UInt64Option`](UInt64Option.md) = `UInt64Option` + +##### sender + +> **sender**: [`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### argsHash + +`Field` = `Field` + +###### methodId + +`Field` = `Field` + +###### nonce + +[`UInt64Option`](UInt64Option.md) = `UInt64Option` + +###### sender + +[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### argsHash + +`Field` = `Field` + +###### methodId + +`Field` = `Field` + +###### nonce + +[`UInt64Option`](UInt64Option.md) = `UInt64Option` + +###### sender + +[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### argsHash + +`Field` = `Field` + +###### methodId + +`Field` = `Field` + +###### nonce + +[`UInt64Option`](UInt64Option.md) = `UInt64Option` + +###### sender + +[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### argsHash + +`Field` = `Field` + +###### methodId + +`Field` = `Field` + +###### nonce + +[`UInt64Option`](UInt64Option.md) = `UInt64Option` + +###### sender + +[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +#### Returns + +`object` + +##### argsHash + +> **argsHash**: `string` = `Field` + +##### methodId + +> **methodId**: `string` = `Field` + +##### nonce + +> **nonce**: `object` = `UInt64Option` + +###### nonce.isSome + +> **nonce.isSome**: `boolean` = `Bool` + +###### nonce.value + +> **nonce.value**: `any` = `valueType` + +##### sender + +> **sender**: `object` = `PublicKeyOption` + +###### sender.isSome + +> **sender.isSome**: `boolean` = `Bool` + +###### sender.value + +> **sender.value**: `any` = `valueType` + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### argsHash + +`Field` = `Field` + +###### methodId + +`Field` = `Field` + +###### nonce + +[`UInt64Option`](UInt64Option.md) = `UInt64Option` + +###### sender + +[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` + +#### Returns + +`object` + +##### argsHash + +> **argsHash**: `bigint` = `Field` + +##### methodId + +> **methodId**: `bigint` = `Field` + +##### nonce + +> **nonce**: `object` = `UInt64Option` + +###### nonce.isSome + +> **nonce.isSome**: `boolean` = `Bool` + +###### nonce.value + +> **nonce.value**: `any` = `valueType` + +##### sender + +> **sender**: `object` = `PublicKeyOption` + +###### sender.isSome + +> **sender.isSome**: `boolean` = `Bool` + +###### sender.value + +> **sender.value**: `any` = `valueType` + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).toValue` + +## Methods + +### assertTransactionType() + +> **assertTransactionType**(`isMessage`): `void` + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L61) + +#### Parameters + +##### isMessage + +`Bool` + +#### Returns + +`void` + +*** + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:102](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L102) + +#### Returns + +`Field` + +*** + +### hashData() + +> **hashData**(): `Field`[] + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L76) + +#### Returns + +`Field`[] + +*** + +### dummyTransaction() + +> `static` **dummyTransaction**(): [`RuntimeTransaction`](RuntimeTransaction.md) + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L46) + +#### Returns + +[`RuntimeTransaction`](RuntimeTransaction.md) + +*** + +### fromHashData() + +> `static` **fromHashData**(`fields`): [`RuntimeTransaction`](RuntimeTransaction.md) + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L85) + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +[`RuntimeTransaction`](RuntimeTransaction.md) + +*** + +### fromMessage() + +> `static` **fromMessage**(`__namedParameters`): [`RuntimeTransaction`](RuntimeTransaction.md) + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L31) + +#### Parameters + +##### \_\_namedParameters + +###### argsHash + +`Field` + +###### methodId + +`Field` + +#### Returns + +[`RuntimeTransaction`](RuntimeTransaction.md) + +*** + +### fromTransaction() + +> `static` **fromTransaction**(`input`): [`RuntimeTransaction`](RuntimeTransaction.md) + +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L17) + +#### Parameters + +##### input + +###### argsHash + +`Field` + +###### methodId + +`Field` + +###### nonce + +`UInt64` + +###### sender + +`PublicKey` + +#### Returns + +[`RuntimeTransaction`](RuntimeTransaction.md) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md new file mode 100644 index 0000000..0af0f82 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md @@ -0,0 +1,467 @@ +--- +title: RuntimeVerificationKeyAttestation +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeVerificationKeyAttestation + +# Class: RuntimeVerificationKeyAttestation + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L8) + +## Extends + +- `object` + +## Constructors + +### new RuntimeVerificationKeyAttestation() + +> **new RuntimeVerificationKeyAttestation**(`value`): [`RuntimeVerificationKeyAttestation`](RuntimeVerificationKeyAttestation.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### verificationKey + +`VerificationKey` = `VerificationKey` + +###### witness + +[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +#### Returns + +[`RuntimeVerificationKeyAttestation`](RuntimeVerificationKeyAttestation.md) + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).constructor` + +## Properties + +### verificationKey + +> **verificationKey**: `VerificationKey` = `VerificationKey` + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L9) + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).verificationKey` + +*** + +### witness + +> **witness**: [`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L10) + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).witness` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### verificationKey + +`VerificationKey` = `VerificationKey` + +###### witness + +[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### verificationKey + +> **verificationKey**: `VerificationKey` = `VerificationKey` + +##### witness + +> **witness**: [`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`, `aux`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 + +A function that returns an element of type `T` from the given provable and "auxiliary" data. + +This function is the reverse operation of calling [toFields](RuntimeVerificationKeyAttestation.md#tofields) and toAuxilary methods on an element of type `T`. + +#### Parameters + +##### fields + +`Field`[] + +an array of Field elements describing the provable data of the new `T` element. + +##### aux + +`any`[] + +an array of any type describing the "auxiliary" data of the new `T` element, optional. + +#### Returns + +`object` + +An element of type `T` generated from the given provable and "auxiliary" data. + +##### verificationKey + +> **verificationKey**: `VerificationKey` = `VerificationKey` + +##### witness + +> **witness**: [`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### verificationKey + +`string` = `VerificationKey` + +###### witness + +\{ `isLeft`: `boolean`[]; `path`: `string`[]; \} = `VKTreeWitness` + +###### witness.isLeft + +`boolean`[] + +###### witness.path + +`string`[] + +#### Returns + +`object` + +##### verificationKey + +> **verificationKey**: `VerificationKey` = `VerificationKey` + +##### witness + +> **witness**: [`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### verificationKey + +`VerificationKey` = `VerificationKey` + +###### witness + +[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### verificationKey + +`VerificationKey` = `VerificationKey` + +###### witness + +[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### verificationKey + +`VerificationKey` = `VerificationKey` + +###### witness + +[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### verificationKey + +`VerificationKey` = `VerificationKey` + +###### witness + +[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +#### Returns + +`object` + +##### verificationKey + +> **verificationKey**: `string` = `VerificationKey` + +##### witness + +> **witness**: `object` = `VKTreeWitness` + +###### witness.isLeft + +> **witness.isLeft**: `boolean`[] + +###### witness.path + +> **witness.path**: `string`[] + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### verificationKey + +`VerificationKey` = `VerificationKey` + +###### witness + +[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` + +#### Returns + +`object` + +##### verificationKey + +> **verificationKey**: `object` = `VerificationKey` + +###### verificationKey.data + +> **verificationKey.data**: `string` + +###### verificationKey.hash + +> **verificationKey.hash**: `bigint` + +##### witness + +> **witness**: `object` = `VKTreeWitness` + +###### witness.isLeft + +> **witness.isLeft**: `boolean`[] + +###### witness.path + +> **witness.path**: `bigint`[] + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md new file mode 100644 index 0000000..a56158d --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md @@ -0,0 +1,61 @@ +--- +title: RuntimeVerificationKeyRootService +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeVerificationKeyRootService + +# Class: RuntimeVerificationKeyRootService + +Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L7) + +## Implements + +- [`MinimalVKTreeService`](../interfaces/MinimalVKTreeService.md) + +## Constructors + +### new RuntimeVerificationKeyRootService() + +> **new RuntimeVerificationKeyRootService**(): [`RuntimeVerificationKeyRootService`](RuntimeVerificationKeyRootService.md) + +#### Returns + +[`RuntimeVerificationKeyRootService`](RuntimeVerificationKeyRootService.md) + +## Methods + +### getRoot() + +> **getRoot**(): `bigint` + +Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L14) + +#### Returns + +`bigint` + +#### Implementation of + +[`MinimalVKTreeService`](../interfaces/MinimalVKTreeService.md).[`getRoot`](../interfaces/MinimalVKTreeService.md#getroot) + +*** + +### setRoot() + +> **setRoot**(`root`): `void` + +Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L10) + +#### Parameters + +##### root + +`bigint` + +#### Returns + +`void` diff --git a/src/pages/docs/reference/protocol/classes/SettlementContractModule.md b/src/pages/docs/reference/protocol/classes/SettlementContractModule.md new file mode 100644 index 0000000..f8baf5f --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/SettlementContractModule.md @@ -0,0 +1,793 @@ +--- +title: SettlementContractModule +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementContractModule + +# Class: SettlementContractModule\ + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L46) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`SettlementModules`\> + +## Type Parameters + +• **SettlementModules** *extends* [`SettlementModulesRecord`](../type-aliases/SettlementModulesRecord.md) & [`MandatorySettlementModulesRecord`](../type-aliases/MandatorySettlementModulesRecord.md) + +## Implements + +- [`ProtocolModule`](ProtocolModule.md)\<`unknown`\> + +## Constructors + +### new SettlementContractModule() + +> **new SettlementContractModule**\<`SettlementModules`\>(`definition`): [`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\> + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L53) + +#### Parameters + +##### definition + +###### modules + +`SettlementModules` + +#### Returns + +[`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\> + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`SettlementModules`\> + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Implementation of + +[`ProtocolModule`](ProtocolModule.md).[`currentConfig`](ProtocolModule.md#currentconfig) + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) + +*** + +### definition + +> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`SettlementModules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L94) + +#### Implementation of + +[`ProtocolModule`](ProtocolModule.md).[`protocol`](ProtocolModule.md#protocol) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:96](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L96) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Implementation of + +[`ProtocolModule`](ProtocolModule.md).[`areProofsEnabled`](ProtocolModule.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Implementation of + +[`ProtocolModule`](ProtocolModule.md).[`config`](ProtocolModule.md#config) + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`SettlementModules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`SettlementModules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:101](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L101) + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Implementation of + +[`ProtocolModule`](ProtocolModule.md).[`create`](ProtocolModule.md#create) + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) + +*** + +### createBridgeContract() + +> **createBridgeContract**(`address`, `tokenId`?): [`BridgeContractType`](../type-aliases/BridgeContractType.md) & `SmartContract` + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:137](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L137) + +#### Parameters + +##### address + +`PublicKey` + +##### tokenId? + +`Field` + +#### Returns + +[`BridgeContractType`](../type-aliases/BridgeContractType.md) & `SmartContract` + +*** + +### createContracts() + +> **createContracts**(`addresses`): `object` + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:119](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L119) + +#### Parameters + +##### addresses + +###### dispatch + +`PublicKey` + +###### settlement + +`PublicKey` + +#### Returns + +`object` + +##### dispatch + +> **dispatch**: [`DispatchContractType`](../interfaces/DispatchContractType.md) & `SmartContract` + +##### settlement + +> **settlement**: [`SettlementContractType`](../interfaces/SettlementContractType.md) & `SmartContract` + +*** + +### decorateModule() + +> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:134 + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`SettlementModules`\> + +##### containedModule + +`InstanceType`\<`SettlementModules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`SettlementModules`\>\]\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) + +*** + +### getContractClasses() + +> **getContractClasses**(): `GetContracts`\<`SettlementModules`\> + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L109) + +#### Returns + +`GetContracts`\<`SettlementModules`\> + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`SettlementModules`\>[] + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +`SettlementModules` + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`SettlementModules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +`SettlementModules` + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`SettlementModules`\>\[`KeyType`\]\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`SettlementModules`\>\[`KeyType`\]\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L105) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`ProtocolModule`](ProtocolModule.md).[`start`](ProtocolModule.md#start) + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`SettlementModules`\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`SettlementModules`\>(`modules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\>\> + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L57) + +#### Type Parameters + +• **SettlementModules** *extends* [`SettlementModulesRecord`](../type-aliases/SettlementModulesRecord.md) & [`MandatorySettlementModulesRecord`](../type-aliases/MandatorySettlementModulesRecord.md) + +#### Parameters + +##### modules + +`SettlementModules` + +#### Returns + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\>\> + +*** + +### fromDefaults() + +> `static` **fromDefaults**(): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<\{ `BridgeContract`: *typeof* [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md); `DispatchContract`: *typeof* [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md); `SettlementContract`: *typeof* [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md); \}\>\> + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L78) + +#### Returns + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<\{ `BridgeContract`: *typeof* [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md); `DispatchContract`: *typeof* [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md); `SettlementContract`: *typeof* [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md); \}\>\> + +*** + +### mandatoryModules() + +> `static` **mandatoryModules**(): `object` + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L70) + +#### Returns + +`object` + +##### BridgeContract + +> `readonly` **BridgeContract**: *typeof* [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md) = `BridgeContractProtocolModule` + +##### DispatchContract + +> `readonly` **DispatchContract**: *typeof* [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) = `DispatchContractProtocolModule` + +##### SettlementContract + +> `readonly` **SettlementContract**: *typeof* [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md) = `SettlementContractProtocolModule` + +*** + +### with() + +> `static` **with**\<`AdditionalModules`\>(`additionalModules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`object` & `AdditionalModules`\>\> + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L84) + +#### Type Parameters + +• **AdditionalModules** *extends* [`SettlementModulesRecord`](../type-aliases/SettlementModulesRecord.md) + +#### Parameters + +##### additionalModules + +`AdditionalModules` + +#### Returns + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`object` & `AdditionalModules`\>\> diff --git a/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md new file mode 100644 index 0000000..0704ca2 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md @@ -0,0 +1,171 @@ +--- +title: SettlementContractProtocolModule +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementContractProtocolModule + +# Class: SettlementContractProtocolModule + +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L34) + +This module type is used to define a contract module that can be used to +construct and inject smart contract instances. +It defines a method contractFactory, whose arguments can be configured via +the Argument generic. It returns a smart contract class that is a subclass +of SmartContract and implements a certain interface as specified by the +ContractType generic. + +## Extends + +- [`ContractModule`](ContractModule.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md), [`SettlementContractConfig`](../type-aliases/SettlementContractConfig.md)\> + +## Constructors + +### new SettlementContractProtocolModule() + +> **new SettlementContractProtocolModule**(`hooks`, `blockProver`, `dispatchContractModule`, `bridgeContractModule`, `childVerificationKeyService`): [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md) + +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L38) + +#### Parameters + +##### hooks + +[`ProvableSettlementHook`](ProvableSettlementHook.md)\<`unknown`\>[] + +##### blockProver + +[`BlockProvable`](../interfaces/BlockProvable.md) + +##### dispatchContractModule + +[`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) + +##### bridgeContractModule + +[`BridgeContractProtocolModule`](BridgeContractProtocolModule.md) + +##### childVerificationKeyService + +[`ChildVerificationKeyService`](../../common/classes/ChildVerificationKeyService.md) + +#### Returns + +[`SettlementContractProtocolModule`](SettlementContractProtocolModule.md) + +#### Overrides + +[`ContractModule`](ContractModule.md).[`constructor`](ContractModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`SettlementContractConfig`](../type-aliases/SettlementContractConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ContractModule`](ContractModule.md).[`currentConfig`](ContractModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ContractModule`](ContractModule.md).[`config`](ContractModule.md#config) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L82) + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +#### Overrides + +[`ContractModule`](ContractModule.md).[`compile`](ContractModule.md#compile) + +*** + +### contractFactory() + +> **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L52) + +#### Returns + +[`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> + +#### Overrides + +[`ContractModule`](ContractModule.md).[`contractFactory`](ContractModule.md#contractfactory) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ContractModule`](ContractModule.md).[`create`](ContractModule.md#create) diff --git a/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md b/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md new file mode 100644 index 0000000..f0b6f1f --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md @@ -0,0 +1,1736 @@ +--- +title: SettlementSmartContract +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementSmartContract + +# Class: SettlementSmartContract + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:433](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L433) + +## Extends + +- [`SettlementSmartContractBase`](SettlementSmartContractBase.md) + +## Implements + +- [`SettlementContractType`](../interfaces/SettlementContractType.md) + +## Constructors + +### new SettlementSmartContract() + +> **new SettlementSmartContract**(`address`, `tokenId`?): [`SettlementSmartContract`](SettlementSmartContract.md) + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 + +#### Parameters + +##### address + +`PublicKey` + +##### tokenId? + +`Field` + +#### Returns + +[`SettlementSmartContract`](SettlementSmartContract.md) + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`constructor`](SettlementSmartContractBase.md#constructors) + +## Properties + +### address + +> **address**: `PublicKey` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`address`](SettlementSmartContractBase.md#address-1) + +*** + +### authorizationField + +> **authorizationField**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:446](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L446) + +#### Implementation of + +[`SettlementContractType`](../interfaces/SettlementContractType.md).[`authorizationField`](../interfaces/SettlementContractType.md#authorizationfield) + +#### Overrides + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`authorizationField`](SettlementSmartContractBase.md#authorizationfield) + +*** + +### blockHashRoot + +> **blockHashRoot**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:442](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L442) + +#### Overrides + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`blockHashRoot`](SettlementSmartContractBase.md#blockhashroot) + +*** + +### dispatchContractAddressX + +> **dispatchContractAddressX**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:444](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L444) + +#### Overrides + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`dispatchContractAddressX`](SettlementSmartContractBase.md#dispatchcontractaddressx) + +*** + +### events + +> **events**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) + +A list of event types that can be emitted using this.emitEvent()`. + +#### token-bridge-deployed + +> **token-bridge-deployed**: *typeof* [`TokenMapping`](TokenMapping.md) = `TokenMapping` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`events`](SettlementSmartContractBase.md#events) + +*** + +### lastSettlementL1BlockHeight + +> **lastSettlementL1BlockHeight**: `State`\<`UInt32`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:438](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L438) + +#### Overrides + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`lastSettlementL1BlockHeight`](SettlementSmartContractBase.md#lastsettlementl1blockheight) + +*** + +### networkStateHash + +> **networkStateHash**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:441](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L441) + +#### Overrides + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`networkStateHash`](SettlementSmartContractBase.md#networkstatehash) + +*** + +### sender + +> **sender**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 + +#### self + +> **self**: `SmartContract` + +#### ~~getAndRequireSignature()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key. + +#### getAndRequireSignatureV2() + +Return a public key that is forced to sign this transaction. + +Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created +the transaction controls the private key associated with the returned public key. + +##### Returns + +`PublicKey` + +#### ~~getUnconstrained()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getUnconstrainedV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key, +which would cause an account update with that public key to not be included. + +#### getUnconstrainedV2() + +The public key of the current transaction's sender account. + +Throws an error if not inside a transaction, or the sender wasn't passed in. + +**Warning**: The fact that this public key equals the current sender is not part of the proof. +A malicious prover could use any other public key without affecting the validity of the proof. + +Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. + +##### Returns + +`PublicKey` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`sender`](SettlementSmartContractBase.md#sender) + +*** + +### sequencerKey + +> **sequencerKey**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:437](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L437) + +#### Overrides + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`sequencerKey`](SettlementSmartContractBase.md#sequencerkey) + +*** + +### stateRoot + +> **stateRoot**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:440](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L440) + +#### Overrides + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`stateRoot`](SettlementSmartContractBase.md#stateroot) + +*** + +### tokenId + +> **tokenId**: `Field` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`tokenId`](SettlementSmartContractBase.md#tokenid-1) + +*** + +### \_maxProofsVerified? + +> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`_maxProofsVerified`](SettlementSmartContractBase.md#_maxproofsverified) + +*** + +### \_methodMetadata? + +> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`_methodMetadata`](SettlementSmartContractBase.md#_methodmetadata) + +*** + +### \_methods? + +> `static` `optional` **\_methods**: `MethodInterface`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`_methods`](SettlementSmartContractBase.md#_methods) + +*** + +### \_provers? + +> `static` `optional` **\_provers**: `Prover`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`_provers`](SettlementSmartContractBase.md#_provers) + +*** + +### \_verificationKey? + +> `static` `optional` **\_verificationKey**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 + +#### data + +> **data**: `string` + +#### hash + +> **hash**: `Field` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`_verificationKey`](SettlementSmartContractBase.md#_verificationkey) + +*** + +### args + +> `static` **args**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) + +#### BridgeContract + +> **BridgeContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BridgeContractType`](../type-aliases/BridgeContractType.md)\> & *typeof* `SmartContract` + +#### BridgeContractPermissions + +> **BridgeContractPermissions**: `undefined` \| `Permissions` + +#### BridgeContractVerificationKey + +> **BridgeContractVerificationKey**: `undefined` \| `VerificationKey` + +#### ChildVerificationKeyService + +> **ChildVerificationKeyService**: [`ChildVerificationKeyService`](../../common/classes/ChildVerificationKeyService.md) + +#### DispatchContract + +> **DispatchContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md) & `SmartContract`\> + +#### escapeHatchSlotsInterval + +> **escapeHatchSlotsInterval**: `number` + +#### hooks + +> **hooks**: [`ProvableSettlementHook`](ProvableSettlementHook.md)\<`unknown`\>[] + +#### signedSettlements + +> **signedSettlements**: `undefined` \| `boolean` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`args`](SettlementSmartContractBase.md#args) + +*** + +### MAX\_ACCOUNT\_UPDATES + +> `static` **MAX\_ACCOUNT\_UPDATES**: `number` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:94 + +The maximum number of account updates using the token in a single +transaction that this contract supports. + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`MAX_ACCOUNT_UPDATES`](SettlementSmartContractBase.md#max_account_updates) + +## Accessors + +### account + +#### Get Signature + +> **get** **account**(): `Account` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 + +Current account of the SmartContract. + +##### Returns + +`Account` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`account`](SettlementSmartContractBase.md#account) + +*** + +### balance + +#### Get Signature + +> **get** **balance**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 + +Balance of this SmartContract. + +##### Returns + +`object` + +###### addInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +###### subInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`balance`](SettlementSmartContractBase.md#balance) + +*** + +### currentSlot + +#### Get Signature + +> **get** **currentSlot**(): `CurrentSlot` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 + +Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value +at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) +or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) + +##### Returns + +`CurrentSlot` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`currentSlot`](SettlementSmartContractBase.md#currentslot) + +*** + +### internal + +#### Get Signature + +> **get** **internal**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:47 + +Helper methods to use from within a token contract. + +##### Returns + +`object` + +###### burn() + +###### Parameters + +###### \_\_namedParameters + +###### address + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### Returns + +`AccountUpdate` + +###### mint() + +###### Parameters + +###### \_\_namedParameters + +###### address + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### Returns + +`AccountUpdate` + +###### send() + +###### Parameters + +###### \_\_namedParameters + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### from + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### to + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### Returns + +`AccountUpdate` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`internal`](SettlementSmartContractBase.md#internal) + +*** + +### network + +#### Get Signature + +> **get** **network**(): `Network` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 + +Current network state of the SmartContract. + +##### Returns + +`Network` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`network`](SettlementSmartContractBase.md#network) + +*** + +### self + +#### Get Signature + +> **get** **self**(): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 + +Returns the current AccountUpdate associated to this SmartContract. + +##### Returns + +`AccountUpdate` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`self`](SettlementSmartContractBase.md#self) + +## Methods + +### addTokenBridge() + +> **addTokenBridge**(`tokenId`, `address`, `dispatchContract`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:468](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L468) + +#### Parameters + +##### tokenId + +`Field` + +##### address + +`PublicKey` + +##### dispatchContract + +`PublicKey` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`SettlementContractType`](../interfaces/SettlementContractType.md).[`addTokenBridge`](../interfaces/SettlementContractType.md#addtokenbridge) + +*** + +### approve() + +> **approve**(`update`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 + +Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, +which allows you to read and use its content in a proof, make assertions about it, and modify it. + +```ts +`@method` myApprovingMethod(update: AccountUpdate) { + this.approve(update); + + // read balance on the account (for example) + let balance = update.account.balance.getAndRequireEquals(); +} +``` + +Under the hood, "approving" just means that the account update is made a child of the zkApp in the +tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, +the entire tree will become a subtree of the zkApp's account update. + +Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update +at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally +excluding important information from the public input. + +#### Parameters + +##### update + +`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` + +#### Returns + +`void` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`approve`](SettlementSmartContractBase.md#approve) + +*** + +### approveAccountUpdate() + +> **approveAccountUpdate**(`accountUpdate`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:78 + +Approve a single account update (with arbitrarily many children). + +#### Parameters + +##### accountUpdate + +`AccountUpdate` | `AccountUpdateTree` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`approveAccountUpdate`](SettlementSmartContractBase.md#approveaccountupdate) + +*** + +### approveAccountUpdates() + +> **approveAccountUpdates**(`accountUpdates`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:82 + +Approve a list of account updates (with arbitrarily many children). + +#### Parameters + +##### accountUpdates + +(`AccountUpdate` \| `AccountUpdateTree`)[] + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`approveAccountUpdates`](SettlementSmartContractBase.md#approveaccountupdates) + +*** + +### approveBase() + +> **approveBase**(`forest`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:448](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L448) + +#### Parameters + +##### forest + +`AccountUpdateForest` + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`approveBase`](SettlementSmartContractBase.md#approvebase) + +*** + +### assertStateRoot() + +> **assertStateRoot**(`root`): `AccountUpdate` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) + +#### Parameters + +##### root + +`Field` + +#### Returns + +`AccountUpdate` + +#### Implementation of + +[`SettlementContractType`](../interfaces/SettlementContractType.md).[`assertStateRoot`](../interfaces/SettlementContractType.md#assertstateroot) + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`assertStateRoot`](SettlementSmartContractBase.md#assertstateroot) + +*** + +### checkZeroBalanceChange() + +> **checkZeroBalanceChange**(`updates`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:74 + +Use `forEachUpdate()` to prove that the total balance change of child account updates is zero. + +This is provided out of the box as it is both a good example, and probably the most common implementation, of `approveBase()`. + +#### Parameters + +##### updates + +`AccountUpdateForest` + +#### Returns + +`void` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`checkZeroBalanceChange`](SettlementSmartContractBase.md#checkzerobalancechange) + +*** + +### deploy() + +> **deploy**(`args`?): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:39 + +Deploys a TokenContract. + +In addition to base smart contract deployment, this adds two steps: +- set the `access` permission to `proofOrSignature()`, to prevent against unauthorized token operations + - not doing this would imply that anyone can bypass token contract authorization and simply mint themselves tokens +- require the zkapp account to be new, using the `isNew` precondition. + this guarantees that the access permission is set from the very start of the existence of this account. + creating the zkapp account before deployment would otherwise be a security vulnerability that is too easy to introduce. + +Note that because of the `isNew` precondition, the zkapp account must not be created prior to calling `deploy()`. + +If the contract needs to be re-deployed, you can switch off this behaviour by overriding the `isNew` precondition: +```ts +async deploy() { + await super.deploy(); + // DON'T DO THIS ON THE INITIAL DEPLOYMENT! + this.account.isNew.requireNothing(); +} +``` + +#### Parameters + +##### args? + +`DeployArgs` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`deploy`](SettlementSmartContractBase.md#deploy) + +*** + +### deployTokenBridge() + +> `protected` **deployTokenBridge**(`tokenId`, `address`, `dispatchContractAddress`, `dispatchContractPreconditionEnforced`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) + +#### Parameters + +##### tokenId + +`Field` + +##### address + +`PublicKey` + +##### dispatchContractAddress + +`PublicKey` + +##### dispatchContractPreconditionEnforced + +`boolean` = `false` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`deployTokenBridge`](SettlementSmartContractBase.md#deploytokenbridge) + +*** + +### deriveTokenId() + +> **deriveTokenId**(): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:43 + +Returns the `tokenId` of the token managed by this contract. + +#### Returns + +`Field` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`deriveTokenId`](SettlementSmartContractBase.md#derivetokenid) + +*** + +### emitEvent() + +> **emitEvent**\<`K`\>(`type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 + +Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `"token-bridge-deployed"` + +#### Parameters + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`emitEvent`](SettlementSmartContractBase.md#emitevent) + +*** + +### emitEventIf() + +> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 + +Conditionally emits an event. + +Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `"token-bridge-deployed"` + +#### Parameters + +##### condition + +`Bool` + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`emitEventIf`](SettlementSmartContractBase.md#emiteventif) + +*** + +### fetchEvents() + +> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 + +Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. + +#### Parameters + +##### start? + +`UInt32` + +The start height of the events to fetch. + +##### end? + +`UInt32` + +The end height of the events to fetch. If not provided, fetches events up to the latest height. + +#### Returns + +`Promise`\<`object`[]\> + +A promise that resolves to an array of objects, each containing the event type and event data for the specified range. + +#### Async + +#### Throws + +If there is an error fetching events from the Mina network. + +#### Example + +```ts +const startHeight = UInt32.from(1000); +const endHeight = UInt32.from(2000); +const events = await myZkapp.fetchEvents(startHeight, endHeight); +console.log(events); +``` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`fetchEvents`](SettlementSmartContractBase.md#fetchevents) + +*** + +### forEachUpdate() + +> **forEachUpdate**(`updates`, `callback`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:68 + +Iterate through the account updates in `updates` and apply `callback` to each. + +This method is provable and is suitable as a base for implementing `approveUpdates()`. + +#### Parameters + +##### updates + +`AccountUpdateForest` + +##### callback + +(`update`, `usesToken`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`forEachUpdate`](SettlementSmartContractBase.md#foreachupdate) + +*** + +### init() + +> **init**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 + +`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. +This method can be overridden as follows +``` +class MyContract extends SmartContract { + init() { + super.init(); + this.account.permissions.set(...); + this.x.set(Field(1)); + } +} +``` + +#### Returns + +`void` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`init`](SettlementSmartContractBase.md#init) + +*** + +### initialize() + +> **initialize**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:453](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L453) + +#### Parameters + +##### sequencer + +`PublicKey` + +##### dispatchContract + +`PublicKey` + +##### bridgeContract + +`PublicKey` + +##### contractKey + +`PrivateKey` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`SettlementContractType`](../interfaces/SettlementContractType.md).[`initialize`](../interfaces/SettlementContractType.md#initialize) + +*** + +### initializeBase() + +> `protected` **initializeBase**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) + +#### Parameters + +##### sequencer + +`PublicKey` + +##### dispatchContract + +`PublicKey` + +##### bridgeContract + +`PublicKey` + +##### contractKey + +`PrivateKey` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`initializeBase`](SettlementSmartContractBase.md#initializebase) + +*** + +### newSelf() + +> **newSelf**(`methodName`?): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 + +Same as `SmartContract.self` but explicitly creates a new AccountUpdate. + +#### Parameters + +##### methodName? + +`string` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`newSelf`](SettlementSmartContractBase.md#newself) + +*** + +### requireSignature() + +> **requireSignature**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 + +Use this command if the account update created by this SmartContract should be signed by the account owner, +instead of authorized with a proof. + +Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. + +If you only want to avoid creating proofs for quicker testing, we advise you to +use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting +`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, +with the only difference being that quick mock proofs are filled in instead of real proofs. + +#### Returns + +`void` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`requireSignature`](SettlementSmartContractBase.md#requiresignature) + +*** + +### send() + +> **send**(`args`): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 + +#### Parameters + +##### args + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### to + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`send`](SettlementSmartContractBase.md#send-2) + +*** + +### settle() + +> **settle**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:477](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L477) + +#### Parameters + +##### blockProof + +[`DynamicBlockProof`](DynamicBlockProof.md) + +##### signature + +`Signature` + +##### dispatchContractAddress + +`PublicKey` + +##### publicKey + +`PublicKey` + +##### inputNetworkState + +[`NetworkState`](NetworkState.md) + +##### outputNetworkState + +[`NetworkState`](NetworkState.md) + +##### newPromisedMessagesHash + +`Field` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`SettlementContractType`](../interfaces/SettlementContractType.md).[`settle`](../interfaces/SettlementContractType.md#settle) + +*** + +### settleBase() + +> `protected` **settleBase**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) + +#### Parameters + +##### blockProof + +[`DynamicBlockProof`](DynamicBlockProof.md) + +##### signature + +`Signature` + +##### dispatchContractAddress + +`PublicKey` + +##### publicKey + +`PublicKey` + +##### inputNetworkState + +[`NetworkState`](NetworkState.md) + +##### outputNetworkState + +[`NetworkState`](NetworkState.md) + +##### newPromisedMessagesHash + +`Field` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`settleBase`](SettlementSmartContractBase.md#settlebase) + +*** + +### skipAuthorization() + +> **skipAuthorization**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 + +Use this command if the account update created by this SmartContract should have no authorization on it, +instead of being authorized with a proof. + +WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look +at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the +authorization flow. + +#### Returns + +`void` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`skipAuthorization`](SettlementSmartContractBase.md#skipauthorization) + +*** + +### transfer() + +> **transfer**(`from`, `to`, `amount`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:86 + +Transfer `amount` of tokens from `from` to `to`. + +#### Parameters + +##### from + +`PublicKey` | `AccountUpdate` + +##### to + +`PublicKey` | `AccountUpdate` + +##### amount + +`number` | `bigint` | `UInt64` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`transfer`](SettlementSmartContractBase.md#transfer) + +*** + +### analyzeMethods() + +> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 + +This function is run internally before compiling a smart contract, to collect metadata about what each of your +smart contract methods does. + +For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, +so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. + +`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), +which is a good indicator for circuit size and the time it will take to create proofs. +To inspect the created circuit in detail, you can look at the returned `gates`. + +Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. + +#### Parameters + +##### \_\_namedParameters? + +###### printSummary + +`boolean` + +#### Returns + +`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +an object, keyed by method name, each entry containing: + - `rows` the size of the constraint system created by this method + - `digest` a digest of the method circuit + - `actions` the number of actions the method dispatches + - `gates` the constraint system, represented as an array of gates + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`analyzeMethods`](SettlementSmartContractBase.md#analyzemethods) + +*** + +### compile() + +> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 + +Compile your smart contract. + +This generates both the prover functions, needed to create proofs for running `@method`s, +and the verification key, needed to deploy your zkApp. + +Although provers and verification key are returned by this method, they are also cached internally and used when needed, +so you don't actually have to use the return value of this function. + +Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to +create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps +it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, +up to several minutes if your circuit is large or your hardware is not optimal for these operations. + +#### Parameters + +##### \_\_namedParameters? + +###### cache + +`Cache` + +###### forceRecompile + +`boolean` + +#### Returns + +`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`compile`](SettlementSmartContractBase.md#compile) + +*** + +### digest() + +> `static` **digest**(): `Promise`\<`string`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 + +Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. +This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or +a cached verification key can be used. + +#### Returns + +`Promise`\<`string`\> + +the digest, as a hex string + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`digest`](SettlementSmartContractBase.md#digest) + +*** + +### Proof() + +> `static` **Proof**(): (`__namedParameters`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 + +Returns a Proof type that belongs to this SmartContract. + +#### Returns + +`Function` + +##### Parameters + +###### \_\_namedParameters + +###### maxProofsVerified + +`0` \| `1` \| `2` + +###### proof + +`unknown` + +###### publicInput + +`ZkappPublicInput` + +###### publicOutput + +`undefined` + +##### Returns + +`object` + +###### maxProofsVerified + +> **maxProofsVerified**: `0` \| `1` \| `2` + +###### proof + +> **proof**: `unknown` + +###### publicInput + +> **publicInput**: `ZkappPublicInput` + +###### publicOutput + +> **publicOutput**: `undefined` + +###### shouldVerify + +> **shouldVerify**: `Bool` + +###### toJSON() + +###### Returns + +`JsonProof` + +###### verify() + +###### Returns + +`void` + +###### verifyIf() + +###### Parameters + +###### condition + +`Bool` + +###### Returns + +`void` + +##### publicInputType + +> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` + +###### Type declaration + +###### fromFields() + +> **fromFields**: (`fields`) => `object` + +###### Parameters + +###### fields + +`Field`[] + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### Type declaration + +###### empty() + +> **empty**: () => `object` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### fromJSON() + +> **fromJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`string` + +###### calls + +`string` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### toInput() + +> **toInput**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### fields? + +> `optional` **fields**: `Field`[] + +###### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +###### toJSON() + +> **toJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `string` + +###### calls + +> **calls**: `string` + +##### publicOutputType + +> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> + +##### tag() + +> **tag**: () => *typeof* `SmartContract` + +###### Returns + +*typeof* `SmartContract` + +##### dummy() + +###### Type Parameters + +• **Input** + +• **OutPut** + +###### Parameters + +###### publicInput + +`Input` + +###### publicOutput + +`OutPut` + +###### maxProofsVerified + +`0` | `1` | `2` + +###### domainLog2? + +`number` + +###### Returns + +`Promise`\<`Proof`\<`Input`, `OutPut`\>\> + +##### fromJSON() + +###### Type Parameters + +• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` + +###### Parameters + +###### this + +`S` + +###### \_\_namedParameters + +`JsonProof` + +###### Returns + +`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`Proof`](SettlementSmartContractBase.md#proof) + +*** + +### runOutsideCircuit() + +> `static` **runOutsideCircuit**(`run`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 + +#### Parameters + +##### run + +() => `void` + +#### Returns + +`void` + +#### Inherited from + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`runOutsideCircuit`](SettlementSmartContractBase.md#runoutsidecircuit) diff --git a/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md b/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md new file mode 100644 index 0000000..0e403d3 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md @@ -0,0 +1,1570 @@ +--- +title: SettlementSmartContractBase +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementSmartContractBase + +# Class: `abstract` SettlementSmartContractBase + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L108) + +## Extends + +- `TokenContractV2` + +## Extended by + +- [`SettlementSmartContract`](SettlementSmartContract.md) + +## Constructors + +### new SettlementSmartContractBase() + +> **new SettlementSmartContractBase**(`address`, `tokenId`?): [`SettlementSmartContractBase`](SettlementSmartContractBase.md) + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 + +#### Parameters + +##### address + +`PublicKey` + +##### tokenId? + +`Field` + +#### Returns + +[`SettlementSmartContractBase`](SettlementSmartContractBase.md) + +#### Inherited from + +`TokenContractV2.constructor` + +## Properties + +### address + +> **address**: `PublicKey` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 + +#### Inherited from + +`TokenContractV2.address` + +*** + +### authorizationField + +> `abstract` **authorizationField**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:135](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L135) + +*** + +### blockHashRoot + +> `abstract` **blockHashRoot**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L132) + +*** + +### dispatchContractAddressX + +> `abstract` **dispatchContractAddressX**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:133](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L133) + +*** + +### events + +> **events**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) + +A list of event types that can be emitted using this.emitEvent()`. + +#### token-bridge-deployed + +> **token-bridge-deployed**: *typeof* [`TokenMapping`](TokenMapping.md) = `TokenMapping` + +#### Overrides + +`TokenContractV2.events` + +*** + +### lastSettlementL1BlockHeight + +> `abstract` **lastSettlementL1BlockHeight**: `State`\<`UInt32`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L129) + +*** + +### networkStateHash + +> `abstract` **networkStateHash**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:131](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L131) + +*** + +### sender + +> **sender**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 + +#### self + +> **self**: `SmartContract` + +#### ~~getAndRequireSignature()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key. + +#### getAndRequireSignatureV2() + +Return a public key that is forced to sign this transaction. + +Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created +the transaction controls the private key associated with the returned public key. + +##### Returns + +`PublicKey` + +#### ~~getUnconstrained()~~ + +##### Returns + +`PublicKey` + +##### Deprecated + +Deprecated in favor of `this.sender.getUnconstrainedV2()`. +This method is vulnerable because it allows the prover to return a dummy (empty) public key, +which would cause an account update with that public key to not be included. + +#### getUnconstrainedV2() + +The public key of the current transaction's sender account. + +Throws an error if not inside a transaction, or the sender wasn't passed in. + +**Warning**: The fact that this public key equals the current sender is not part of the proof. +A malicious prover could use any other public key without affecting the validity of the proof. + +Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. + +##### Returns + +`PublicKey` + +#### Inherited from + +`TokenContractV2.sender` + +*** + +### sequencerKey + +> `abstract` **sequencerKey**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:128](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L128) + +*** + +### stateRoot + +> `abstract` **stateRoot**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L130) + +*** + +### tokenId + +> **tokenId**: `Field` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 + +#### Inherited from + +`TokenContractV2.tokenId` + +*** + +### \_maxProofsVerified? + +> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 + +#### Inherited from + +`TokenContractV2._maxProofsVerified` + +*** + +### \_methodMetadata? + +> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 + +#### Inherited from + +`TokenContractV2._methodMetadata` + +*** + +### \_methods? + +> `static` `optional` **\_methods**: `MethodInterface`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 + +#### Inherited from + +`TokenContractV2._methods` + +*** + +### \_provers? + +> `static` `optional` **\_provers**: `Prover`[] + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 + +#### Inherited from + +`TokenContractV2._provers` + +*** + +### \_verificationKey? + +> `static` `optional` **\_verificationKey**: `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 + +#### data + +> **data**: `string` + +#### hash + +> **hash**: `Field` + +#### Inherited from + +`TokenContractV2._verificationKey` + +*** + +### args + +> `static` **args**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) + +#### BridgeContract + +> **BridgeContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BridgeContractType`](../type-aliases/BridgeContractType.md)\> & *typeof* `SmartContract` + +#### BridgeContractPermissions + +> **BridgeContractPermissions**: `undefined` \| `Permissions` + +#### BridgeContractVerificationKey + +> **BridgeContractVerificationKey**: `undefined` \| `VerificationKey` + +#### ChildVerificationKeyService + +> **ChildVerificationKeyService**: [`ChildVerificationKeyService`](../../common/classes/ChildVerificationKeyService.md) + +#### DispatchContract + +> **DispatchContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md) & `SmartContract`\> + +#### escapeHatchSlotsInterval + +> **escapeHatchSlotsInterval**: `number` + +#### hooks + +> **hooks**: [`ProvableSettlementHook`](ProvableSettlementHook.md)\<`unknown`\>[] + +#### signedSettlements + +> **signedSettlements**: `undefined` \| `boolean` + +*** + +### MAX\_ACCOUNT\_UPDATES + +> `static` **MAX\_ACCOUNT\_UPDATES**: `number` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:94 + +The maximum number of account updates using the token in a single +transaction that this contract supports. + +#### Inherited from + +`TokenContractV2.MAX_ACCOUNT_UPDATES` + +## Accessors + +### account + +#### Get Signature + +> **get** **account**(): `Account` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 + +Current account of the SmartContract. + +##### Returns + +`Account` + +#### Inherited from + +`TokenContractV2.account` + +*** + +### balance + +#### Get Signature + +> **get** **balance**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 + +Balance of this SmartContract. + +##### Returns + +`object` + +###### addInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +###### subInPlace() + +###### Parameters + +###### x + +`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` + +###### Returns + +`void` + +#### Inherited from + +`TokenContractV2.balance` + +*** + +### currentSlot + +#### Get Signature + +> **get** **currentSlot**(): `CurrentSlot` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 + +Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value +at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) +or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) + +##### Returns + +`CurrentSlot` + +#### Inherited from + +`TokenContractV2.currentSlot` + +*** + +### internal + +#### Get Signature + +> **get** **internal**(): `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:47 + +Helper methods to use from within a token contract. + +##### Returns + +`object` + +###### burn() + +###### Parameters + +###### \_\_namedParameters + +###### address + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### Returns + +`AccountUpdate` + +###### mint() + +###### Parameters + +###### \_\_namedParameters + +###### address + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### Returns + +`AccountUpdate` + +###### send() + +###### Parameters + +###### \_\_namedParameters + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### from + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### to + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +###### Returns + +`AccountUpdate` + +#### Inherited from + +`TokenContractV2.internal` + +*** + +### network + +#### Get Signature + +> **get** **network**(): `Network` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 + +Current network state of the SmartContract. + +##### Returns + +`Network` + +#### Inherited from + +`TokenContractV2.network` + +*** + +### self + +#### Get Signature + +> **get** **self**(): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 + +Returns the current AccountUpdate associated to this SmartContract. + +##### Returns + +`AccountUpdate` + +#### Inherited from + +`TokenContractV2.self` + +## Methods + +### approve() + +> **approve**(`update`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 + +Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, +which allows you to read and use its content in a proof, make assertions about it, and modify it. + +```ts +`@method` myApprovingMethod(update: AccountUpdate) { + this.approve(update); + + // read balance on the account (for example) + let balance = update.account.balance.getAndRequireEquals(); +} +``` + +Under the hood, "approving" just means that the account update is made a child of the zkApp in the +tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, +the entire tree will become a subtree of the zkApp's account update. + +Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update +at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally +excluding important information from the public input. + +#### Parameters + +##### update + +`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.approve` + +*** + +### approveAccountUpdate() + +> **approveAccountUpdate**(`accountUpdate`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:78 + +Approve a single account update (with arbitrarily many children). + +#### Parameters + +##### accountUpdate + +`AccountUpdate` | `AccountUpdateTree` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TokenContractV2.approveAccountUpdate` + +*** + +### approveAccountUpdates() + +> **approveAccountUpdates**(`accountUpdates`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:82 + +Approve a list of account updates (with arbitrarily many children). + +#### Parameters + +##### accountUpdates + +(`AccountUpdate` \| `AccountUpdateTree`)[] + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TokenContractV2.approveAccountUpdates` + +*** + +### approveBase() + +> `abstract` **approveBase**(`forest`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:62 + +#### Parameters + +##### forest + +`AccountUpdateForest` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TokenContractV2.approveBase` + +*** + +### assertStateRoot() + +> **assertStateRoot**(`root`): `AccountUpdate` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) + +#### Parameters + +##### root + +`Field` + +#### Returns + +`AccountUpdate` + +*** + +### checkZeroBalanceChange() + +> **checkZeroBalanceChange**(`updates`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:74 + +Use `forEachUpdate()` to prove that the total balance change of child account updates is zero. + +This is provided out of the box as it is both a good example, and probably the most common implementation, of `approveBase()`. + +#### Parameters + +##### updates + +`AccountUpdateForest` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.checkZeroBalanceChange` + +*** + +### deploy() + +> **deploy**(`args`?): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:39 + +Deploys a TokenContract. + +In addition to base smart contract deployment, this adds two steps: +- set the `access` permission to `proofOrSignature()`, to prevent against unauthorized token operations + - not doing this would imply that anyone can bypass token contract authorization and simply mint themselves tokens +- require the zkapp account to be new, using the `isNew` precondition. + this guarantees that the access permission is set from the very start of the existence of this account. + creating the zkapp account before deployment would otherwise be a security vulnerability that is too easy to introduce. + +Note that because of the `isNew` precondition, the zkapp account must not be created prior to calling `deploy()`. + +If the contract needs to be re-deployed, you can switch off this behaviour by overriding the `isNew` precondition: +```ts +async deploy() { + await super.deploy(); + // DON'T DO THIS ON THE INITIAL DEPLOYMENT! + this.account.isNew.requireNothing(); +} +``` + +#### Parameters + +##### args? + +`DeployArgs` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TokenContractV2.deploy` + +*** + +### deployTokenBridge() + +> `protected` **deployTokenBridge**(`tokenId`, `address`, `dispatchContractAddress`, `dispatchContractPreconditionEnforced`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) + +#### Parameters + +##### tokenId + +`Field` + +##### address + +`PublicKey` + +##### dispatchContractAddress + +`PublicKey` + +##### dispatchContractPreconditionEnforced + +`boolean` = `false` + +#### Returns + +`Promise`\<`void`\> + +*** + +### deriveTokenId() + +> **deriveTokenId**(): `Field` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:43 + +Returns the `tokenId` of the token managed by this contract. + +#### Returns + +`Field` + +#### Inherited from + +`TokenContractV2.deriveTokenId` + +*** + +### emitEvent() + +> **emitEvent**\<`K`\>(`type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 + +Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `"token-bridge-deployed"` + +#### Parameters + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.emitEvent` + +*** + +### emitEventIf() + +> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 + +Conditionally emits an event. + +Events will be emitted as a part of the transaction and can be collected by archive nodes. + +#### Type Parameters + +• **K** *extends* `"token-bridge-deployed"` + +#### Parameters + +##### condition + +`Bool` + +##### type + +`K` + +##### event + +`any` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.emitEventIf` + +*** + +### fetchEvents() + +> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 + +Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. + +#### Parameters + +##### start? + +`UInt32` + +The start height of the events to fetch. + +##### end? + +`UInt32` + +The end height of the events to fetch. If not provided, fetches events up to the latest height. + +#### Returns + +`Promise`\<`object`[]\> + +A promise that resolves to an array of objects, each containing the event type and event data for the specified range. + +#### Async + +#### Throws + +If there is an error fetching events from the Mina network. + +#### Example + +```ts +const startHeight = UInt32.from(1000); +const endHeight = UInt32.from(2000); +const events = await myZkapp.fetchEvents(startHeight, endHeight); +console.log(events); +``` + +#### Inherited from + +`TokenContractV2.fetchEvents` + +*** + +### forEachUpdate() + +> **forEachUpdate**(`updates`, `callback`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:68 + +Iterate through the account updates in `updates` and apply `callback` to each. + +This method is provable and is suitable as a base for implementing `approveUpdates()`. + +#### Parameters + +##### updates + +`AccountUpdateForest` + +##### callback + +(`update`, `usesToken`) => `void` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.forEachUpdate` + +*** + +### init() + +> **init**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 + +`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. +This method can be overridden as follows +``` +class MyContract extends SmartContract { + init() { + super.init(); + this.account.permissions.set(...); + this.x.set(Field(1)); + } +} +``` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.init` + +*** + +### initializeBase() + +> `protected` **initializeBase**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) + +#### Parameters + +##### sequencer + +`PublicKey` + +##### dispatchContract + +`PublicKey` + +##### bridgeContract + +`PublicKey` + +##### contractKey + +`PrivateKey` + +#### Returns + +`Promise`\<`void`\> + +*** + +### newSelf() + +> **newSelf**(`methodName`?): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 + +Same as `SmartContract.self` but explicitly creates a new AccountUpdate. + +#### Parameters + +##### methodName? + +`string` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +`TokenContractV2.newSelf` + +*** + +### requireSignature() + +> **requireSignature**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 + +Use this command if the account update created by this SmartContract should be signed by the account owner, +instead of authorized with a proof. + +Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. + +If you only want to avoid creating proofs for quicker testing, we advise you to +use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting +`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, +with the only difference being that quick mock proofs are filled in instead of real proofs. + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.requireSignature` + +*** + +### send() + +> **send**(`args`): `AccountUpdate` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 + +#### Parameters + +##### args + +###### amount + +`number` \| `bigint` \| `UInt64` + +###### to + +`PublicKey` \| `SmartContract` \| `AccountUpdate` + +#### Returns + +`AccountUpdate` + +#### Inherited from + +`TokenContractV2.send` + +*** + +### settleBase() + +> `protected` **settleBase**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) + +#### Parameters + +##### blockProof + +[`DynamicBlockProof`](DynamicBlockProof.md) + +##### signature + +`Signature` + +##### dispatchContractAddress + +`PublicKey` + +##### publicKey + +`PublicKey` + +##### inputNetworkState + +[`NetworkState`](NetworkState.md) + +##### outputNetworkState + +[`NetworkState`](NetworkState.md) + +##### newPromisedMessagesHash + +`Field` + +#### Returns + +`Promise`\<`void`\> + +*** + +### skipAuthorization() + +> **skipAuthorization**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 + +Use this command if the account update created by this SmartContract should have no authorization on it, +instead of being authorized with a proof. + +WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look +at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the +authorization flow. + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.skipAuthorization` + +*** + +### transfer() + +> **transfer**(`from`, `to`, `amount`): `Promise`\<`void`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:86 + +Transfer `amount` of tokens from `from` to `to`. + +#### Parameters + +##### from + +`PublicKey` | `AccountUpdate` + +##### to + +`PublicKey` | `AccountUpdate` + +##### amount + +`number` | `bigint` | `UInt64` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +`TokenContractV2.transfer` + +*** + +### analyzeMethods() + +> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 + +This function is run internally before compiling a smart contract, to collect metadata about what each of your +smart contract methods does. + +For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, +so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. + +`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), +which is a good indicator for circuit size and the time it will take to create proofs. +To inspect the created circuit in detail, you can look at the returned `gates`. + +Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. + +#### Parameters + +##### \_\_namedParameters? + +###### printSummary + +`boolean` + +#### Returns + +`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> + +an object, keyed by method name, each entry containing: + - `rows` the size of the constraint system created by this method + - `digest` a digest of the method circuit + - `actions` the number of actions the method dispatches + - `gates` the constraint system, represented as an array of gates + +#### Inherited from + +`TokenContractV2.analyzeMethods` + +*** + +### compile() + +> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 + +Compile your smart contract. + +This generates both the prover functions, needed to create proofs for running `@method`s, +and the verification key, needed to deploy your zkApp. + +Although provers and verification key are returned by this method, they are also cached internally and used when needed, +so you don't actually have to use the return value of this function. + +Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to +create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps +it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, +up to several minutes if your circuit is large or your hardware is not optimal for these operations. + +#### Parameters + +##### \_\_namedParameters? + +###### cache + +`Cache` + +###### forceRecompile + +`boolean` + +#### Returns + +`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> + +#### Inherited from + +`TokenContractV2.compile` + +*** + +### digest() + +> `static` **digest**(): `Promise`\<`string`\> + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 + +Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. +This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or +a cached verification key can be used. + +#### Returns + +`Promise`\<`string`\> + +the digest, as a hex string + +#### Inherited from + +`TokenContractV2.digest` + +*** + +### Proof() + +> `static` **Proof**(): (`__namedParameters`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 + +Returns a Proof type that belongs to this SmartContract. + +#### Returns + +`Function` + +##### Parameters + +###### \_\_namedParameters + +###### maxProofsVerified + +`0` \| `1` \| `2` + +###### proof + +`unknown` + +###### publicInput + +`ZkappPublicInput` + +###### publicOutput + +`undefined` + +##### Returns + +`object` + +###### maxProofsVerified + +> **maxProofsVerified**: `0` \| `1` \| `2` + +###### proof + +> **proof**: `unknown` + +###### publicInput + +> **publicInput**: `ZkappPublicInput` + +###### publicOutput + +> **publicOutput**: `undefined` + +###### shouldVerify + +> **shouldVerify**: `Bool` + +###### toJSON() + +###### Returns + +`JsonProof` + +###### verify() + +###### Returns + +`void` + +###### verifyIf() + +###### Parameters + +###### condition + +`Bool` + +###### Returns + +`void` + +##### publicInputType + +> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` + +###### Type declaration + +###### fromFields() + +> **fromFields**: (`fields`) => `object` + +###### Parameters + +###### fields + +`Field`[] + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### Type declaration + +###### empty() + +> **empty**: () => `object` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### fromJSON() + +> **fromJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`string` + +###### calls + +`string` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `Field` + +###### calls + +> **calls**: `Field` + +###### toInput() + +> **toInput**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### fields? + +> `optional` **fields**: `Field`[] + +###### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +###### toJSON() + +> **toJSON**: (`x`) => `object` + +###### Parameters + +###### x + +###### accountUpdate + +`Field` + +###### calls + +`Field` + +###### Returns + +`object` + +###### accountUpdate + +> **accountUpdate**: `string` + +###### calls + +> **calls**: `string` + +##### publicOutputType + +> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> + +##### tag() + +> **tag**: () => *typeof* `SmartContract` + +###### Returns + +*typeof* `SmartContract` + +##### dummy() + +###### Type Parameters + +• **Input** + +• **OutPut** + +###### Parameters + +###### publicInput + +`Input` + +###### publicOutput + +`OutPut` + +###### maxProofsVerified + +`0` | `1` | `2` + +###### domainLog2? + +`number` + +###### Returns + +`Promise`\<`Proof`\<`Input`, `OutPut`\>\> + +##### fromJSON() + +###### Type Parameters + +• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` + +###### Parameters + +###### this + +`S` + +###### \_\_namedParameters + +`JsonProof` + +###### Returns + +`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +#### Inherited from + +`TokenContractV2.Proof` + +*** + +### runOutsideCircuit() + +> `static` **runOutsideCircuit**(`run`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 + +#### Parameters + +##### run + +() => `void` + +#### Returns + +`void` + +#### Inherited from + +`TokenContractV2.runOutsideCircuit` diff --git a/src/pages/docs/reference/protocol/classes/SignedTransaction.md b/src/pages/docs/reference/protocol/classes/SignedTransaction.md new file mode 100644 index 0000000..a66dce7 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/SignedTransaction.md @@ -0,0 +1,607 @@ +--- +title: SignedTransaction +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SignedTransaction + +# Class: SignedTransaction + +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L5) + +## Extends + +- `object` + +## Constructors + +### new SignedTransaction() + +> **new SignedTransaction**(`value`): [`SignedTransaction`](SignedTransaction.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +[`SignedTransaction`](SignedTransaction.md) + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).constructor` + +## Properties + +### signature + +> **signature**: `Signature` = `Signature` + +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L7) + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).signature` + +*** + +### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L6) + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).transaction` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### signature + +> **signature**: `Signature` = `Signature` + +##### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`, `aux`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 + +A function that returns an element of type `T` from the given provable and "auxiliary" data. + +This function is the reverse operation of calling [toFields](SignedTransaction.md#tofields) and toAuxilary methods on an element of type `T`. + +#### Parameters + +##### fields + +`Field`[] + +an array of Field elements describing the provable data of the new `T` element. + +##### aux + +`any`[] + +an array of any type describing the "auxiliary" data of the new `T` element, optional. + +#### Returns + +`object` + +An element of type `T` generated from the given provable and "auxiliary" data. + +##### signature + +> **signature**: `Signature` = `Signature` + +##### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### signature + +`any` = `Signature` + +###### transaction + +\{ `argsHash`: `string`; `methodId`: `string`; `nonce`: \{ `isSome`: `boolean`; `value`: `any`; \}; `sender`: \{ `isSome`: `boolean`; `value`: `any`; \}; \} = `RuntimeTransaction` + +###### transaction.argsHash + +`string` = `Field` + +###### transaction.methodId + +`string` = `Field` + +###### transaction.nonce + +\{ `isSome`: `boolean`; `value`: `any`; \} = `UInt64Option` + +###### transaction.nonce.isSome + +`boolean` = `Bool` + +###### transaction.nonce.value + +`any` = `valueType` + +###### transaction.sender + +\{ `isSome`: `boolean`; `value`: `any`; \} = `PublicKeyOption` + +###### transaction.sender.isSome + +`boolean` = `Bool` + +###### transaction.sender.value + +`any` = `valueType` + +#### Returns + +`object` + +##### signature + +> **signature**: `Signature` = `Signature` + +##### transaction + +> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`object` + +##### signature + +> **signature**: `any` = `Signature` + +##### transaction + +> **transaction**: `object` = `RuntimeTransaction` + +###### transaction.argsHash + +> **transaction.argsHash**: `string` = `Field` + +###### transaction.methodId + +> **transaction.methodId**: `string` = `Field` + +###### transaction.nonce + +> **transaction.nonce**: `object` = `UInt64Option` + +###### transaction.nonce.isSome + +> **transaction.nonce.isSome**: `boolean` = `Bool` + +###### transaction.nonce.value + +> **transaction.nonce.value**: `any` = `valueType` + +###### transaction.sender + +> **transaction.sender**: `object` = `PublicKeyOption` + +###### transaction.sender.isSome + +> **transaction.sender.isSome**: `boolean` = `Bool` + +###### transaction.sender.value + +> **transaction.sender.value**: `any` = `valueType` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### signature + +`Signature` = `Signature` + +###### transaction + +[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` + +#### Returns + +`object` + +##### signature + +> **signature**: `any` = `Signature` + +##### transaction + +> **transaction**: `object` = `RuntimeTransaction` + +###### transaction.argsHash + +> **transaction.argsHash**: `bigint` = `Field` + +###### transaction.methodId + +> **transaction.methodId**: `bigint` = `Field` + +###### transaction.nonce + +> **transaction.nonce**: `object` = `UInt64Option` + +###### transaction.nonce.isSome + +> **transaction.nonce.isSome**: `boolean` = `Bool` + +###### transaction.nonce.value + +> **transaction.nonce.value**: `any` = `valueType` + +###### transaction.sender + +> **transaction.sender**: `object` = `PublicKeyOption` + +###### transaction.sender.isSome + +> **transaction.sender.isSome**: `boolean` = `Bool` + +###### transaction.sender.value + +> **transaction.sender.value**: `any` = `valueType` + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).toValue` + +## Methods + +### getSignatureData() + +> **getSignatureData**(): `Field`[] + +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L32) + +#### Returns + +`Field`[] + +*** + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L28) + +#### Returns + +`Field` + +*** + +### validateSignature() + +> **validateSignature**(): `Bool` + +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L41) + +#### Returns + +`Bool` + +*** + +### dummy() + +> `static` **dummy**(): [`SignedTransaction`](SignedTransaction.md) + +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L17) + +#### Returns + +[`SignedTransaction`](SignedTransaction.md) + +*** + +### getSignatureData() + +> `static` **getSignatureData**(`args`): `Field`[] + +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L9) + +#### Parameters + +##### args + +###### argsHash + +`Field` + +###### methodId + +`Field` + +###### nonce + +`UInt64` + +#### Returns + +`Field`[] + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ transaction: RuntimeTransaction, signature: Signature, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/State.md b/src/pages/docs/reference/protocol/classes/State.md new file mode 100644 index 0000000..e40f65e --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/State.md @@ -0,0 +1,182 @@ +--- +title: State +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / State + +# Class: State\ + +Defined in: [packages/protocol/src/state/State.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L42) + +Utilities for runtime module state, such as get/set + +## Extends + +- [`WithPath`](WithPath.md)\<`this`\> & [`WithStateServiceProvider`](WithStateServiceProvider.md)\<`this`\> + +## Type Parameters + +• **Value** + +## Constructors + +### new State() + +> **new State**\<`Value`\>(`valueType`): [`State`](State.md)\<`Value`\> + +Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L53) + +#### Parameters + +##### valueType + +`FlexibleProvablePure`\<`Value`\> + +#### Returns + +[`State`](State.md)\<`Value`\> + +#### Overrides + +`Mixin(WithPath, WithStateServiceProvider).constructor` + +## Properties + +### path? + +> `optional` **path**: `Field` + +Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L14) + +#### Inherited from + +`Mixin(WithPath, WithStateServiceProvider).path` + +*** + +### stateServiceProvider? + +> `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) + +Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L26) + +#### Inherited from + +`Mixin(WithPath, WithStateServiceProvider).stateServiceProvider` + +*** + +### valueType + +> **valueType**: `FlexibleProvablePure`\<`Value`\> + +Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L53) + +## Methods + +### get() + +> **get**(): `Promise`\<[`Option`](Option.md)\<`Value`\>\> + +Defined in: [packages/protocol/src/state/State.ts:133](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L133) + +Retrieves the current state and creates a state transition +anchoring the use of the current state value in the circuit. + +#### Returns + +`Promise`\<[`Option`](Option.md)\<`Value`\>\> + +Option representation of the current state. + +*** + +### hasPathOrFail() + +> **hasPathOrFail**(): `asserts this is { path: Path }` + +Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L16) + +#### Returns + +`asserts this is { path: Path }` + +#### Inherited from + +`Mixin(WithPath, WithStateServiceProvider).hasPathOrFail` + +*** + +### hasStateServiceOrFail() + +> **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` + +Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L28) + +#### Returns + +`asserts this is { stateServiceProvider: StateServiceProvider }` + +#### Inherited from + +`Mixin(WithPath, WithStateServiceProvider).hasStateServiceOrFail` + +*** + +### set() + +> **set**(`value`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/state/State.ts:158](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L158) + +Sets a new state value by creating a state transition from +the current value to the newly set value. + +The newly set value isn't available via state.get(), since the +state transitions are not applied within the same circuit. +You can however store and access your new value in +a separate circuit variable. + +#### Parameters + +##### value + +`Value` + +Value to be set as the current state + +#### Returns + +`Promise`\<`void`\> + +*** + +### from() + +> `static` **from**\<`Value`\>(`valueType`): [`State`](State.md)\<`Value`\> + +Defined in: [packages/protocol/src/state/State.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L49) + +Creates a new state wrapper for the provided value type. + +#### Type Parameters + +• **Value** + +#### Parameters + +##### valueType + +`FlexibleProvablePure`\<`Value`\> + +Type of value to be stored (e.g. UInt64, Struct, ...) + +#### Returns + +[`State`](State.md)\<`Value`\> + +New state for the given value type. diff --git a/src/pages/docs/reference/protocol/classes/StateMap.md b/src/pages/docs/reference/protocol/classes/StateMap.md new file mode 100644 index 0000000..bb91a26 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/StateMap.md @@ -0,0 +1,229 @@ +--- +title: StateMap +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateMap + +# Class: StateMap\ + +Defined in: [packages/protocol/src/state/StateMap.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L12) + +Map-like wrapper for state + +## Extends + +- [`WithPath`](WithPath.md)\<`this`\> & [`WithStateServiceProvider`](WithStateServiceProvider.md)\<`this`\> + +## Type Parameters + +• **KeyType** + +• **ValueType** + +## Constructors + +### new StateMap() + +> **new StateMap**\<`KeyType`, `ValueType`\>(`keyType`, `valueType`): [`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> + +Defined in: [packages/protocol/src/state/StateMap.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L30) + +#### Parameters + +##### keyType + +`FlexibleProvablePure`\<`KeyType`\> + +##### valueType + +`FlexibleProvablePure`\<`ValueType`\> + +#### Returns + +[`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> + +#### Overrides + +`Mixin( WithPath, WithStateServiceProvider ).constructor` + +## Properties + +### keyType + +> **keyType**: `FlexibleProvablePure`\<`KeyType`\> + +Defined in: [packages/protocol/src/state/StateMap.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L31) + +*** + +### path? + +> `optional` **path**: `Field` + +Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L14) + +#### Inherited from + +`Mixin( WithPath, WithStateServiceProvider ).path` + +*** + +### stateServiceProvider? + +> `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) + +Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L26) + +#### Inherited from + +`Mixin( WithPath, WithStateServiceProvider ).stateServiceProvider` + +*** + +### valueType + +> **valueType**: `FlexibleProvablePure`\<`ValueType`\> + +Defined in: [packages/protocol/src/state/StateMap.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L32) + +## Methods + +### get() + +> **get**(`key`): `Promise`\<[`Option`](Option.md)\<`ValueType`\>\> + +Defined in: [packages/protocol/src/state/StateMap.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L48) + +Obtains a value for the provided key in the current state map. + +#### Parameters + +##### key + +`KeyType` + +Key to obtain the state for + +#### Returns + +`Promise`\<[`Option`](Option.md)\<`ValueType`\>\> + +Value for the provided key. + +*** + +### getPath() + +> **getPath**(`key`): `Field` + +Defined in: [packages/protocol/src/state/StateMap.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L37) + +#### Parameters + +##### key + +`KeyType` + +#### Returns + +`Field` + +*** + +### hasPathOrFail() + +> **hasPathOrFail**(): `asserts this is { path: Path }` + +Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L16) + +#### Returns + +`asserts this is { path: Path }` + +#### Inherited from + +`Mixin( WithPath, WithStateServiceProvider ).hasPathOrFail` + +*** + +### hasStateServiceOrFail() + +> **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` + +Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L28) + +#### Returns + +`asserts this is { stateServiceProvider: StateServiceProvider }` + +#### Inherited from + +`Mixin( WithPath, WithStateServiceProvider ).hasStateServiceOrFail` + +*** + +### set() + +> **set**(`key`, `value`): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/state/StateMap.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L64) + +Sets a value for the given key in the current state map. + +#### Parameters + +##### key + +`KeyType` + +Key to store the value under + +##### value + +`ValueType` + +Value to be stored under the given key + +#### Returns + +`Promise`\<`void`\> + +*** + +### from() + +> `static` **from**\<`KeyType`, `ValueType`\>(`keyType`, `valueType`): [`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> + +Defined in: [packages/protocol/src/state/StateMap.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L23) + +Create a new state map with the given key and value types + +#### Type Parameters + +• **KeyType** + +• **ValueType** + +#### Parameters + +##### keyType + +`FlexibleProvablePure`\<`KeyType`\> + +Type to be used as a key + +##### valueType + +`FlexibleProvablePure`\<`ValueType`\> + +Type to be stored as a value + +#### Returns + +[`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> + +State map with provided key and value types. diff --git a/src/pages/docs/reference/protocol/classes/StateServiceProvider.md b/src/pages/docs/reference/protocol/classes/StateServiceProvider.md new file mode 100644 index 0000000..4b80496 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/StateServiceProvider.md @@ -0,0 +1,67 @@ +--- +title: StateServiceProvider +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateServiceProvider + +# Class: StateServiceProvider + +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateServiceProvider.ts#L14) + +## Constructors + +### new StateServiceProvider() + +> **new StateServiceProvider**(): [`StateServiceProvider`](StateServiceProvider.md) + +#### Returns + +[`StateServiceProvider`](StateServiceProvider.md) + +## Accessors + +### stateService + +#### Get Signature + +> **get** **stateService**(): [`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) + +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateServiceProvider.ts#L17) + +##### Returns + +[`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) + +## Methods + +### popCurrentStateService() + +> **popCurrentStateService**(): `void` + +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateServiceProvider.ts#L30) + +#### Returns + +`void` + +*** + +### setCurrentStateService() + +> **setCurrentStateService**(`service`): `void` + +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateServiceProvider.ts#L26) + +#### Parameters + +##### service + +[`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) + +#### Returns + +`void` diff --git a/src/pages/docs/reference/protocol/classes/StateTransition.md b/src/pages/docs/reference/protocol/classes/StateTransition.md new file mode 100644 index 0000000..965f8e8 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/StateTransition.md @@ -0,0 +1,229 @@ +--- +title: StateTransition +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransition + +# Class: StateTransition\ + +Defined in: [packages/protocol/src/model/StateTransition.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L32) + +Generic state transition that constraints the current method circuit +to external state, by providing a state anchor. + +## Type Parameters + +• **Value** + +## Constructors + +### new StateTransition() + +> **new StateTransition**\<`Value`\>(`path`, `fromValue`, `toValue`): [`StateTransition`](StateTransition.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/StateTransition.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L45) + +#### Parameters + +##### path + +`Field` + +##### fromValue + +[`Option`](Option.md)\<`Value`\> + +##### toValue + +[`Option`](Option.md)\<`Field`\> | [`Option`](Option.md)\<`Value`\> + +#### Returns + +[`StateTransition`](StateTransition.md)\<`Value`\> + +## Properties + +### fromValue + +> **fromValue**: [`Option`](Option.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/StateTransition.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L47) + +*** + +### path + +> **path**: `Field` + +Defined in: [packages/protocol/src/model/StateTransition.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L46) + +*** + +### toValue + +> **toValue**: [`Option`](Option.md)\<`Field`\> \| [`Option`](Option.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/StateTransition.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L48) + +## Accessors + +### from + +#### Get Signature + +> **get** **from**(): [`Option`](Option.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/StateTransition.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L51) + +##### Returns + +[`Option`](Option.md)\<`Value`\> + +*** + +### to + +#### Get Signature + +> **get** **to**(): [`Option`](Option.md)\<`Field`\> \| [`Option`](Option.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/StateTransition.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L57) + +##### Returns + +[`Option`](Option.md)\<`Field`\> \| [`Option`](Option.md)\<`Value`\> + +## Methods + +### toConstant() + +> **toConstant**(): [`StateTransition`](StateTransition.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/StateTransition.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L81) + +#### Returns + +[`StateTransition`](StateTransition.md)\<`Value`\> + +*** + +### toJSON() + +> **toJSON**(): `object` + +Defined in: [packages/protocol/src/model/StateTransition.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L73) + +#### Returns + +`object` + +##### from + +> **from**: `object` + +###### from.isForcedSome + +> **from.isForcedSome**: `boolean` + +###### from.isSome + +> **from.isSome**: `boolean` + +###### from.value + +> **from.value**: `string`[] + +##### path + +> **path**: `string` + +##### to + +> **to**: `object` + +###### to.isForcedSome + +> **to.isForcedSome**: `boolean` + +###### to.isSome + +> **to.isSome**: `boolean` + +###### to.value + +> **to.value**: `string`[] + +*** + +### toProvable() + +> **toProvable**(): [`ProvableStateTransition`](ProvableStateTransition.md) + +Defined in: [packages/protocol/src/model/StateTransition.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L65) + +Converts a StateTransition to a ProvableStateTransition, +while enforcing the 'from' property to be 'Some' in all cases. + +#### Returns + +[`ProvableStateTransition`](ProvableStateTransition.md) + +*** + +### from() + +> `static` **from**\<`Value`\>(`path`, `fromValue`): [`StateTransition`](StateTransition.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/StateTransition.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L33) + +#### Type Parameters + +• **Value** + +#### Parameters + +##### path + +`Field` + +##### fromValue + +[`Option`](Option.md)\<`Value`\> + +#### Returns + +[`StateTransition`](StateTransition.md)\<`Value`\> + +*** + +### fromTo() + +> `static` **fromTo**\<`Value`\>(`path`, `fromValue`, `toValue`): [`StateTransition`](StateTransition.md)\<`Value`\> + +Defined in: [packages/protocol/src/model/StateTransition.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L37) + +#### Type Parameters + +• **Value** + +#### Parameters + +##### path + +`Field` + +##### fromValue + +[`Option`](Option.md)\<`Value`\> + +##### toValue + +[`Option`](Option.md)\<`Value`\> + +#### Returns + +[`StateTransition`](StateTransition.md)\<`Value`\> diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md b/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md new file mode 100644 index 0000000..8b2a4fd --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md @@ -0,0 +1,507 @@ +--- +title: StateTransitionProvableBatch +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProvableBatch + +# Class: StateTransitionProvableBatch + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L58) + +A Batch of StateTransitions to be consumed by the StateTransitionProver +to prove multiple STs at once + +transitionType: +true == normal ST, false == protocol ST + +## Extends + +- `object` + +## Properties + +### batch + +> **batch**: [`ProvableStateTransition`](ProvableStateTransition.md)[] + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L59) + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).batch` + +*** + +### merkleWitnesses + +> **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L69) + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).merkleWitnesses` + +*** + +### transitionTypes + +> **transitionTypes**: [`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L64) + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).transitionTypes` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### batch + +[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` + +###### merkleWitnesses + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` + +###### transitionTypes + +[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### batch + +> **batch**: [`ProvableStateTransition`](ProvableStateTransition.md)[] + +##### merkleWitnesses + +> **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] + +##### transitionTypes + +> **transitionTypes**: [`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### batch + +> **batch**: [`ProvableStateTransition`](ProvableStateTransition.md)[] + +##### merkleWitnesses + +> **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] + +##### transitionTypes + +> **transitionTypes**: [`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### batch + +`object`[] = `...` + +###### merkleWitnesses + +`object`[] = `...` + +###### transitionTypes + +`object`[] = `...` + +#### Returns + +`object` + +##### batch + +> **batch**: [`ProvableStateTransition`](ProvableStateTransition.md)[] + +##### merkleWitnesses + +> **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] + +##### transitionTypes + +> **transitionTypes**: [`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### batch + +[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` + +###### merkleWitnesses + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` + +###### transitionTypes + +[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### batch + +[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` + +###### merkleWitnesses + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` + +###### transitionTypes + +[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### batch + +[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` + +###### merkleWitnesses + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` + +###### transitionTypes + +[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### batch + +[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` + +###### merkleWitnesses + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` + +###### transitionTypes + +[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` + +#### Returns + +`object` + +##### batch + +> **batch**: `object`[] + +##### merkleWitnesses + +> **merkleWitnesses**: `object`[] + +##### transitionTypes + +> **transitionTypes**: `object`[] + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### batch + +[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` + +###### merkleWitnesses + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` + +###### transitionTypes + +[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` + +#### Returns + +`object` + +##### batch + +> **batch**: `object`[] + +##### merkleWitnesses + +> **merkleWitnesses**: `object`[] + +##### transitionTypes + +> **transitionTypes**: `object`[] + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).toValue` + +## Methods + +### fromMappings() + +> `static` **fromMappings**(`transitions`, `merkleWitnesses`): [`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L74) + +#### Parameters + +##### transitions + +`object`[] + +##### merkleWitnesses + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] + +#### Returns + +[`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) + +*** + +### fromTransitions() + +> `static` **fromTransitions**(`transitions`, `protocolTransitions`, `merkleWitnesses`): [`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:111](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L111) + +#### Parameters + +##### transitions + +[`ProvableStateTransition`](ProvableStateTransition.md)[] + +##### protocolTransitions + +[`ProvableStateTransition`](ProvableStateTransition.md)[] + +##### merkleWitnesses + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] + +#### Returns + +[`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProver.md b/src/pages/docs/reference/protocol/classes/StateTransitionProver.md new file mode 100644 index 0000000..55f9cb0 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProver.md @@ -0,0 +1,272 @@ +--- +title: StateTransitionProver +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProver + +# Class: StateTransitionProver + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:343](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L343) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ProtocolModule`](ProtocolModule.md) + +## Implements + +- [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) +- [`StateTransitionProverType`](../interfaces/StateTransitionProverType.md) +- [`CompilableModule`](../../common/interfaces/CompilableModule.md) + +## Constructors + +### new StateTransitionProver() + +> **new StateTransitionProver**(): [`StateTransitionProver`](StateTransitionProver.md) + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:352](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L352) + +#### Returns + +[`StateTransitionProver`](StateTransitionProver.md) + +#### Overrides + +[`ProtocolModule`](ProtocolModule.md).[`constructor`](ProtocolModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Implementation of + +[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`currentConfig`](../interfaces/StateTransitionProverType.md#currentconfig) + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`currentConfig`](ProtocolModule.md#currentconfig) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Implementation of + +[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`protocol`](../interfaces/StateTransitionProverType.md#protocol) + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`protocol`](ProtocolModule.md#protocol) + +*** + +### zkProgrammable + +> **zkProgrammable**: [`StateTransitionProverProgrammable`](StateTransitionProverProgrammable.md) + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:350](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L350) + +#### Implementation of + +[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`zkProgrammable`](../interfaces/StateTransitionProverType.md#zkprogrammable) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Implementation of + +[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`areProofsEnabled`](../interfaces/StateTransitionProverType.md#areproofsenabled) + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`areProofsEnabled`](ProtocolModule.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Implementation of + +[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`config`](../interfaces/StateTransitionProverType.md#config) + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`config`](ProtocolModule.md#config) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:357](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L357) + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +#### Implementation of + +[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Implementation of + +[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`create`](../interfaces/StateTransitionProverType.md#create) + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`create`](ProtocolModule.md#create) + +*** + +### merge() + +> **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:370](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L370) + +#### Parameters + +##### publicInput + +[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) + +##### proof1 + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +##### proof2 + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +#### Returns + +`Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +#### Implementation of + +[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`merge`](../interfaces/StateTransitionProverType.md#merge) + +*** + +### runBatch() + +> **runBatch**(`publicInput`, `batch`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:363](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L363) + +#### Parameters + +##### publicInput + +[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) + +##### batch + +[`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) + +#### Returns + +`Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +#### Implementation of + +[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`runBatch`](../interfaces/StateTransitionProverType.md#runbatch) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`start`](../interfaces/StateTransitionProverType.md#start) + +#### Inherited from + +[`ProtocolModule`](ProtocolModule.md).[`start`](ProtocolModule.md#start) diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md new file mode 100644 index 0000000..a0bb2b2 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md @@ -0,0 +1,240 @@ +--- +title: StateTransitionProverProgrammable +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProverProgrammable + +# Class: StateTransitionProverProgrammable + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L74) + +StateTransitionProver is the prover that proves the application of some state +transitions and checks and updates their merkle-tree entries + +## Extends + +- [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +## Constructors + +### new StateTransitionProverProgrammable() + +> **new StateTransitionProverProgrammable**(`stateTransitionProver`): [`StateTransitionProverProgrammable`](StateTransitionProverProgrammable.md) + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L78) + +#### Parameters + +##### stateTransitionProver + +[`StateTransitionProver`](StateTransitionProver.md) + +#### Returns + +[`StateTransitionProverProgrammable`](StateTransitionProverProgrammable.md) + +#### Overrides + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`constructor`](../../common/classes/ZkProgrammable.md#constructors) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L84) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Overrides + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`areProofsEnabled`](../../common/classes/ZkProgrammable.md#areproofsenabled) + +*** + +### zkProgram + +#### Get Signature + +> **get** **zkProgram**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] + +Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:34 + +##### Returns + +[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] + +#### Inherited from + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgram`](../../common/classes/ZkProgrammable.md#zkprogram) + +## Methods + +### applyTransition() + +> **applyTransition**(`state`, `transition`, `type`, `merkleWitness`, `index`): `void` + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:197](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L197) + +Applies a single state transition to the given state +and mutates it in place + +#### Parameters + +##### state + +`StateTransitionProverExecutionState` + +##### transition + +[`ProvableStateTransition`](ProvableStateTransition.md) + +##### type + +[`ProvableStateTransitionType`](ProvableStateTransitionType.md) + +##### merkleWitness + +[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) + +##### index + +`number` = `0` + +#### Returns + +`void` + +*** + +### applyTransitions() + +> **applyTransitions**(`stateRoot`, `protocolStateRoot`, `stateTransitionCommitmentFrom`, `protocolTransitionCommitmentFrom`, `transitionBatch`): `StateTransitionProverExecutionState` + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:151](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L151) + +Applies the state transitions to the current stateRoot +and returns the new prover state + +#### Parameters + +##### stateRoot + +`Field` + +##### protocolStateRoot + +`Field` + +##### stateTransitionCommitmentFrom + +`Field` + +##### protocolTransitionCommitmentFrom + +`Field` + +##### transitionBatch + +[`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) + +#### Returns + +`StateTransitionProverExecutionState` + +*** + +### compile() + +> **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> + +Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:35 + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> + +#### Inherited from + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`compile`](../../common/classes/ZkProgrammable.md#compile) + +*** + +### merge() + +> **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:267](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L267) + +#### Parameters + +##### publicInput + +[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) + +##### proof1 + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +##### proof2 + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +#### Returns + +`Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +*** + +### runBatch() + +> **runBatch**(`publicInput`, `batch`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:246](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L246) + +Applies a whole batch of StateTransitions at once + +#### Parameters + +##### publicInput + +[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) + +##### batch + +[`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) + +#### Returns + +`Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> + +*** + +### zkProgramFactory() + +> **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\>[] + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L88) + +#### Returns + +[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\>[] + +#### Overrides + +[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgramFactory`](../../common/classes/ZkProgrammable.md#zkprogramfactory) diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md new file mode 100644 index 0000000..46fcae9 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md @@ -0,0 +1,549 @@ +--- +title: StateTransitionProverPublicInput +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProverPublicInput + +# Class: StateTransitionProverPublicInput + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L6) + +## Extends + +- `object` + +## Constructors + +### new StateTransitionProverPublicInput() + +> **new StateTransitionProverPublicInput**(`value`): [`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).constructor` + +## Properties + +### protocolStateRoot + +> **protocolStateRoot**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L10) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).protocolStateRoot` + +*** + +### protocolTransitionsHash + +> **protocolTransitionsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L8) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).protocolTransitionsHash` + +*** + +### stateRoot + +> **stateRoot**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L9) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).stateRoot` + +*** + +### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L7) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).stateTransitionsHash` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### protocolStateRoot + +> **protocolStateRoot**: `Field` = `Field` + +##### protocolTransitionsHash + +> **protocolTransitionsHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### protocolStateRoot + +> **protocolStateRoot**: `Field` = `Field` + +##### protocolTransitionsHash + +> **protocolTransitionsHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### protocolStateRoot + +`string` = `Field` + +###### protocolTransitionsHash + +`string` = `Field` + +###### stateRoot + +`string` = `Field` + +###### stateTransitionsHash + +`string` = `Field` + +#### Returns + +`object` + +##### protocolStateRoot + +> **protocolStateRoot**: `Field` = `Field` + +##### protocolTransitionsHash + +> **protocolTransitionsHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### protocolStateRoot + +> **protocolStateRoot**: `string` = `Field` + +##### protocolTransitionsHash + +> **protocolTransitionsHash**: `string` = `Field` + +##### stateRoot + +> **stateRoot**: `string` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `string` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### protocolStateRoot + +> **protocolStateRoot**: `bigint` = `Field` + +##### protocolTransitionsHash + +> **protocolTransitionsHash**: `bigint` = `Field` + +##### stateRoot + +> **stateRoot**: `bigint` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `bigint` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md new file mode 100644 index 0000000..3e361bc --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md @@ -0,0 +1,549 @@ +--- +title: StateTransitionProverPublicOutput +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProverPublicOutput + +# Class: StateTransitionProverPublicOutput + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L13) + +## Extends + +- `object` + +## Constructors + +### new StateTransitionProverPublicOutput() + +> **new StateTransitionProverPublicOutput**(`value`): [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).constructor` + +## Properties + +### protocolStateRoot + +> **protocolStateRoot**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L17) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).protocolStateRoot` + +*** + +### protocolTransitionsHash + +> **protocolTransitionsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L15) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).protocolTransitionsHash` + +*** + +### stateRoot + +> **stateRoot**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L16) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).stateRoot` + +*** + +### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L14) + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).stateTransitionsHash` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### protocolStateRoot + +> **protocolStateRoot**: `Field` = `Field` + +##### protocolTransitionsHash + +> **protocolTransitionsHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### protocolStateRoot + +> **protocolStateRoot**: `Field` = `Field` + +##### protocolTransitionsHash + +> **protocolTransitionsHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### protocolStateRoot + +`string` = `Field` + +###### protocolTransitionsHash + +`string` = `Field` + +###### stateRoot + +`string` = `Field` + +###### stateTransitionsHash + +`string` = `Field` + +#### Returns + +`object` + +##### protocolStateRoot + +> **protocolStateRoot**: `Field` = `Field` + +##### protocolTransitionsHash + +> **protocolTransitionsHash**: `Field` = `Field` + +##### stateRoot + +> **stateRoot**: `Field` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `Field` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### protocolStateRoot + +> **protocolStateRoot**: `string` = `Field` + +##### protocolTransitionsHash + +> **protocolTransitionsHash**: `string` = `Field` + +##### stateRoot + +> **stateRoot**: `string` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `string` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### protocolStateRoot + +`Field` = `Field` + +###### protocolTransitionsHash + +`Field` = `Field` + +###### stateRoot + +`Field` = `Field` + +###### stateTransitionsHash + +`Field` = `Field` + +#### Returns + +`object` + +##### protocolStateRoot + +> **protocolStateRoot**: `bigint` = `Field` + +##### protocolTransitionsHash + +> **protocolTransitionsHash**: `bigint` = `Field` + +##### stateRoot + +> **stateRoot**: `bigint` = `Field` + +##### stateTransitionsHash + +> **stateTransitionsHash**: `bigint` = `Field` + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md b/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md new file mode 100644 index 0000000..570a1f6 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md @@ -0,0 +1,236 @@ +--- +title: StateTransitionReductionList +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionReductionList + +# Class: StateTransitionReductionList + +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/StateTransitionReductionList.ts#L11) + +Utilities for creating a hash list from a given value type. + +## Extends + +- [`ProvableReductionHashList`](ProvableReductionHashList.md)\<[`ProvableStateTransition`](ProvableStateTransition.md)\> + +## Constructors + +### new StateTransitionReductionList() + +> **new StateTransitionReductionList**(`valueType`, `commitment`): [`StateTransitionReductionList`](StateTransitionReductionList.md) + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L7) + +#### Parameters + +##### valueType + +`ProvablePure`\<[`ProvableStateTransition`](ProvableStateTransition.md)\> + +##### commitment + +`Field` = `...` + +#### Returns + +[`StateTransitionReductionList`](StateTransitionReductionList.md) + +#### Inherited from + +[`ProvableReductionHashList`](ProvableReductionHashList.md).[`constructor`](ProvableReductionHashList.md#constructors) + +## Properties + +### commitment + +> **commitment**: `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) + +#### Inherited from + +[`ProvableReductionHashList`](ProvableReductionHashList.md).[`commitment`](ProvableReductionHashList.md#commitment-1) + +*** + +### unconstrainedList + +> **unconstrainedList**: [`ProvableStateTransition`](ProvableStateTransition.md)[] = `[]` + +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) + +#### Inherited from + +[`ProvableReductionHashList`](ProvableReductionHashList.md).[`unconstrainedList`](ProvableReductionHashList.md#unconstrainedlist) + +*** + +### valueType + +> `protected` `readonly` **valueType**: `ProvablePure`\<[`ProvableStateTransition`](ProvableStateTransition.md)\> + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) + +#### Inherited from + +[`ProvableReductionHashList`](ProvableReductionHashList.md).[`valueType`](ProvableReductionHashList.md#valuetype-1) + +## Methods + +### hash() + +> **hash**(`elements`): `Field` + +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) + +#### Parameters + +##### elements + +`Field`[] + +#### Returns + +`Field` + +#### Inherited from + +[`ProvableReductionHashList`](ProvableReductionHashList.md).[`hash`](ProvableReductionHashList.md#hash) + +*** + +### push() + +> **push**(`value`): [`StateTransitionReductionList`](StateTransitionReductionList.md) + +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/StateTransitionReductionList.ts#L12) + +Converts the provided value to Field[] and appends it to +the current hashlist. + +#### Parameters + +##### value + +[`ProvableStateTransition`](ProvableStateTransition.md) + +Value to be appended to the hash list + +#### Returns + +[`StateTransitionReductionList`](StateTransitionReductionList.md) + +Current hash list. + +#### Overrides + +[`ProvableReductionHashList`](ProvableReductionHashList.md).[`push`](ProvableReductionHashList.md#push) + +*** + +### pushAndReduce() + +> **pushAndReduce**(`value`, `reduce`): `object` + +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) + +#### Parameters + +##### value + +[`ProvableStateTransition`](ProvableStateTransition.md) + +##### reduce + +(`previous`) => \[[`ProvableStateTransition`](ProvableStateTransition.md), `Bool`\] + +#### Returns + +`object` + +##### popLast + +> **popLast**: `Bool` + +##### value + +> **value**: [`ProvableStateTransition`](ProvableStateTransition.md) + +#### Inherited from + +[`ProvableReductionHashList`](ProvableReductionHashList.md).[`pushAndReduce`](ProvableReductionHashList.md#pushandreduce) + +*** + +### pushIf() + +> **pushIf**(`value`, `condition`): [`StateTransitionReductionList`](StateTransitionReductionList.md) + +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) + +#### Parameters + +##### value + +[`ProvableStateTransition`](ProvableStateTransition.md) + +##### condition + +`Bool` + +#### Returns + +[`StateTransitionReductionList`](StateTransitionReductionList.md) + +#### Inherited from + +[`ProvableReductionHashList`](ProvableReductionHashList.md).[`pushIf`](ProvableReductionHashList.md#pushif) + +*** + +### pushWithMetadata() + +> **pushWithMetadata**(`value`): `object` + +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/StateTransitionReductionList.ts#L18) + +#### Parameters + +##### value + +[`ProvableStateTransition`](ProvableStateTransition.md) + +#### Returns + +`object` + +##### popLast + +> **popLast**: `Bool` + +##### value + +> **value**: [`ProvableStateTransition`](ProvableStateTransition.md) + +*** + +### toField() + +> **toField**(): `Field` + +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) + +#### Returns + +`Field` + +Traling hash of the current hashlist. + +#### Inherited from + +[`ProvableReductionHashList`](ProvableReductionHashList.md).[`toField`](ProvableReductionHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionType.md b/src/pages/docs/reference/protocol/classes/StateTransitionType.md new file mode 100644 index 0000000..5f2cfe5 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/StateTransitionType.md @@ -0,0 +1,75 @@ +--- +title: StateTransitionType +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionType + +# Class: StateTransitionType + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L13) + +## Constructors + +### new StateTransitionType() + +> **new StateTransitionType**(): [`StateTransitionType`](StateTransitionType.md) + +#### Returns + +[`StateTransitionType`](StateTransitionType.md) + +## Properties + +### normal + +> `readonly` `static` **normal**: `true` = `true` + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L14) + +*** + +### protocol + +> `readonly` `static` **protocol**: `false` = `false` + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L16) + +## Methods + +### isNormal() + +> `static` **isNormal**(`type`): `boolean` + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L18) + +#### Parameters + +##### type + +`boolean` + +#### Returns + +`boolean` + +*** + +### isProtocol() + +> `static` **isProtocol**(`type`): `boolean` + +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L22) + +#### Parameters + +##### type + +`boolean` + +#### Returns + +`boolean` diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md b/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md new file mode 100644 index 0000000..5c9120a --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md @@ -0,0 +1,445 @@ +--- +title: TokenBridgeAttestation +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeAttestation + +# Class: TokenBridgeAttestation + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L65) + +## Extends + +- `object` + +## Constructors + +### new TokenBridgeAttestation() + +> **new TokenBridgeAttestation**(`value`): [`TokenBridgeAttestation`](TokenBridgeAttestation.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### index + +`Field` = `Field` + +###### witness + +[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +#### Returns + +[`TokenBridgeAttestation`](TokenBridgeAttestation.md) + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).constructor` + +## Properties + +### index + +> **index**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L67) + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).index` + +*** + +### witness + +> **witness**: [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L66) + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).witness` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### index + +`Field` = `Field` + +###### witness + +[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### witness + +> **witness**: [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### witness + +> **witness**: [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### index + +`string` = `Field` + +###### witness + +\{ `isLeft`: `boolean`[]; `path`: `string`[]; \} = `TokenBridgeTreeWitness` + +###### witness.isLeft + +`boolean`[] + +###### witness.path + +`string`[] + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### witness + +> **witness**: [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### index + +`Field` = `Field` + +###### witness + +[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### index + +`Field` = `Field` + +###### witness + +[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### witness + +[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### witness + +[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +#### Returns + +`object` + +##### index + +> **index**: `string` = `Field` + +##### witness + +> **witness**: `object` = `TokenBridgeTreeWitness` + +###### witness.isLeft + +> **witness.isLeft**: `boolean`[] + +###### witness.path + +> **witness.path**: `string`[] + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### witness + +[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` + +#### Returns + +`object` + +##### index + +> **index**: `bigint` = `Field` + +##### witness + +> **witness**: `object` = `TokenBridgeTreeWitness` + +###### witness.isLeft + +> **witness.isLeft**: `boolean`[] + +###### witness.path + +> **witness.path**: `bigint`[] + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md b/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md new file mode 100644 index 0000000..3d9e373 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md @@ -0,0 +1,528 @@ +--- +title: TokenBridgeDeploymentAuth +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeDeploymentAuth + +# Class: TokenBridgeDeploymentAuth + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L5) + +Interface for cross-contract call authorization +See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 + +## Extends + +- `object` + +## Implements + +- [`ContractAuthorization`](../interfaces/ContractAuthorization.md) + +## Constructors + +### new TokenBridgeDeploymentAuth() + +> **new TokenBridgeDeploymentAuth**(`value`): [`TokenBridgeDeploymentAuth`](TokenBridgeDeploymentAuth.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### address + +`PublicKey` = `PublicKey` + +###### target + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +[`TokenBridgeDeploymentAuth`](TokenBridgeDeploymentAuth.md) + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).constructor` + +## Properties + +### address + +> **address**: `PublicKey` = `PublicKey` + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L9) + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).address` + +*** + +### target + +> **target**: `PublicKey` = `PublicKey` + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L7) + +#### Implementation of + +[`ContractAuthorization`](../interfaces/ContractAuthorization.md).[`target`](../interfaces/ContractAuthorization.md#target) + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).target` + +*** + +### tokenId + +> **tokenId**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L8) + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).tokenId` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### address + +`PublicKey` = `PublicKey` + +###### target + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### target + +> **target**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### target + +> **target**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### address + +`string` = `PublicKey` + +###### target + +`string` = `PublicKey` + +###### tokenId + +`string` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### target + +> **target**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### address + +`PublicKey` = `PublicKey` + +###### target + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### address + +`PublicKey` = `PublicKey` + +###### target + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### target + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### target + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `string` = `PublicKey` + +##### target + +> **target**: `string` = `PublicKey` + +##### tokenId + +> **tokenId**: `string` = `Field` + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### target + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `object` = `PublicKey` + +###### address.isOdd + +> **address.isOdd**: `boolean` + +###### address.x + +> **address.x**: `bigint` + +##### target + +> **target**: `object` = `PublicKey` + +###### target.isOdd + +> **target.isOdd**: `boolean` + +###### target.x + +> **target.x**: `bigint` + +##### tokenId + +> **tokenId**: `bigint` = `Field` + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).toValue` + +## Methods + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L13) + +#### Returns + +`Field` + +#### Implementation of + +[`ContractAuthorization`](../interfaces/ContractAuthorization.md).[`hash`](../interfaces/ContractAuthorization.md#hash) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md b/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md new file mode 100644 index 0000000..58fb2a6 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md @@ -0,0 +1,441 @@ +--- +title: TokenBridgeEntry +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeEntry + +# Class: TokenBridgeEntry + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L56) + +## Extends + +- `object` + +## Constructors + +### new TokenBridgeEntry() + +> **new TokenBridgeEntry**(`value`): [`TokenBridgeEntry`](TokenBridgeEntry.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +[`TokenBridgeEntry`](TokenBridgeEntry.md) + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).constructor` + +## Properties + +### address + +> **address**: `PublicKey` = `PublicKey` + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L57) + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).address` + +*** + +### tokenId + +> **tokenId**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L58) + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).tokenId` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### address + +`string` = `PublicKey` + +###### tokenId + +`string` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `string` = `PublicKey` + +##### tokenId + +> **tokenId**: `string` = `Field` + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `object` = `PublicKey` + +###### address.isOdd + +> **address.isOdd**: `boolean` + +###### address.x + +> **address.x**: `bigint` + +##### tokenId + +> **tokenId**: `bigint` = `Field` + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).toValue` + +## Methods + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L60) + +#### Returns + +`Field` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ address: PublicKey, tokenId: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md new file mode 100644 index 0000000..b5c97b5 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md @@ -0,0 +1,344 @@ +--- +title: TokenBridgeTree +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeTree + +# Class: TokenBridgeTree + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L15) + +Merkle tree that contains all the deployed token bridges as a mapping of +tokenId => PublicKey + +It should be used as an append-only tree with incremental indizes - this allows +us to reduce the height of it + +## Extends + +- [`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md) + +## Constructors + +### new TokenBridgeTree() + +> **new TokenBridgeTree**(`store`): [`TokenBridgeTree`](TokenBridgeTree.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:113 + +#### Parameters + +##### store + +[`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) + +#### Returns + +[`TokenBridgeTree`](TokenBridgeTree.md) + +#### Inherited from + +`createMerkleTree(256).constructor` + +## Properties + +### indizes + +> **indizes**: `Record`\<`string`, `bigint`\> = `{}` + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L16) + +*** + +### leafCount + +> `readonly` **leafCount**: `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:78 + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`leafCount`](../../common/interfaces/AbstractMerkleTree.md#leafcount) + +*** + +### store + +> **store**: [`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:77 + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`store`](../../common/interfaces/AbstractMerkleTree.md#store) + +*** + +### EMPTY\_ROOT + +> `static` **EMPTY\_ROOT**: `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:118 + +#### Inherited from + +`createMerkleTree(256).EMPTY_ROOT` + +*** + +### HEIGHT + +> `static` **HEIGHT**: `number` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:117 + +#### Inherited from + +`createMerkleTree(256).HEIGHT` + +*** + +### WITNESS + +> `static` **WITNESS**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:114 + +#### Type declaration + +##### dummy() + +> **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +###### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +#### Inherited from + +`createMerkleTree(256).WITNESS` + +## Accessors + +### leafCount + +#### Get Signature + +> **get** `static` **leafCount**(): `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:119 + +##### Returns + +`bigint` + +#### Inherited from + +`createMerkleTree(256).leafCount` + +## Methods + +### assertIndexRange() + +> **assertIndexRange**(`index`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:79 + +#### Parameters + +##### index + +`bigint` + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`assertIndexRange`](../../common/interfaces/AbstractMerkleTree.md#assertindexrange) + +*** + +### fill() + +> **fill**(`leaves`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:110 + +Fills all leaves of the tree. + +#### Parameters + +##### leaves + +`Field`[] + +Values to fill the leaves with. + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`fill`](../../common/interfaces/AbstractMerkleTree.md#fill) + +*** + +### getIndex() + +> **getIndex**(`tokenId`): `bigint` + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L49) + +#### Parameters + +##### tokenId + +`Field` + +#### Returns + +`bigint` + +*** + +### getNode() + +> **getNode**(`level`, `index`): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:86 + +Returns a node which lives at a given index and level. + +#### Parameters + +##### level + +`number` + +Level of the node. + +##### index + +`bigint` + +Index of the node. + +#### Returns + +`Field` + +The data of the node. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getNode`](../../common/interfaces/AbstractMerkleTree.md#getnode) + +*** + +### getRoot() + +> **getRoot**(): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:91 + +Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). + +#### Returns + +`Field` + +The root of the Merkle Tree. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getRoot`](../../common/interfaces/AbstractMerkleTree.md#getroot) + +*** + +### getWitness() + +> **getWitness**(`index`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:105 + +Returns the witness (also known as +[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) +for the leaf at the given index. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +#### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +The witness that belongs to the leaf. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getWitness`](../../common/interfaces/AbstractMerkleTree.md#getwitness) + +*** + +### setLeaf() + +> **setLeaf**(`index`, `leaf`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:97 + +Sets the value of a leaf node at a given index to a given value. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +##### leaf + +`Field` + +New value. + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`setLeaf`](../../common/interfaces/AbstractMerkleTree.md#setleaf) + +*** + +### buildTreeFromEvents() + +> `static` **buildTreeFromEvents**(`contract`): `Promise`\<[`TokenBridgeTree`](TokenBridgeTree.md)\> + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L22) + +Initializes and fills the tree based on all on-chain events that have been +emitted by every emit + +#### Parameters + +##### contract + +`SmartContract` & `object` + +#### Returns + +`Promise`\<[`TokenBridgeTree`](TokenBridgeTree.md)\> diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md new file mode 100644 index 0000000..ce76135 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md @@ -0,0 +1,453 @@ +--- +title: TokenBridgeTreeAddition +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeTreeAddition + +# Class: TokenBridgeTreeAddition + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L70) + +## Extends + +- `object` + +## Constructors + +### new TokenBridgeTreeAddition() + +> **new TokenBridgeTreeAddition**(`value`): [`TokenBridgeTreeAddition`](TokenBridgeTreeAddition.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### index + +`Field` = `Field` + +###### value + +[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +#### Returns + +[`TokenBridgeTreeAddition`](TokenBridgeTreeAddition.md) + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).constructor` + +## Properties + +### index + +> **index**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L71) + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).index` + +*** + +### value + +> **value**: [`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L72) + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).value` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### index + +`Field` = `Field` + +###### value + +[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### value + +> **value**: [`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### value + +> **value**: [`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### index + +`string` = `Field` + +###### value + +\{ `address`: `string`; `tokenId`: `string`; \} = `TokenBridgeEntry` + +###### value.address + +`string` = `PublicKey` + +###### value.tokenId + +`string` = `Field` + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### value + +> **value**: [`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### index + +`Field` = `Field` + +###### value + +[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### index + +`Field` = `Field` + +###### value + +[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### value + +[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### value + +[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +#### Returns + +`object` + +##### index + +> **index**: `string` = `Field` + +##### value + +> **value**: `object` = `TokenBridgeEntry` + +###### value.address + +> **value.address**: `string` = `PublicKey` + +###### value.tokenId + +> **value.tokenId**: `string` = `Field` + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### value + +[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` + +#### Returns + +`object` + +##### index + +> **index**: `bigint` = `Field` + +##### value + +> **value**: `object` = `TokenBridgeEntry` + +###### value.address + +> **value.address**: `object` = `PublicKey` + +###### value.address.isOdd + +> **value.address.isOdd**: `boolean` + +###### value.address.x + +> **value.address.x**: `bigint` + +###### value.tokenId + +> **value.tokenId**: `bigint` = `Field` + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ index: Field, value: TokenBridgeEntry, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md new file mode 100644 index 0000000..f5a67dc --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md @@ -0,0 +1,575 @@ +--- +title: TokenBridgeTreeWitness +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeTreeWitness + +# Class: TokenBridgeTreeWitness + +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L54) + +## Extends + +- [`WITNESS`](VKTree.md#witness) + +## Constructors + +### new TokenBridgeTreeWitness() + +> **new TokenBridgeTreeWitness**(`value`): [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:4 + +#### Parameters + +##### value + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) + +#### Inherited from + +`TokenBridgeTree.WITNESS.constructor` + +## Properties + +### isLeft + +> **isLeft**: `Bool`[] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:9 + +#### Inherited from + +`TokenBridgeTree.WITNESS.isLeft` + +*** + +### path + +> **path**: `Field`[] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:8 + +#### Inherited from + +`TokenBridgeTree.WITNESS.path` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:11 + +#### Inherited from + +`TokenBridgeTree.WITNESS._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`void` + +#### Inherited from + +`TokenBridgeTree.WITNESS.check` + +*** + +### dummy() + +> `static` **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:115 + +#### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +#### Inherited from + +`TokenBridgeTree.WITNESS.dummy` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:52 + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`TokenBridgeTree.WITNESS.empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:19 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`TokenBridgeTree.WITNESS.fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:45 + +#### Parameters + +##### x + +###### isLeft + +`boolean`[] + +###### path + +`string`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`TokenBridgeTree.WITNESS.fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`TokenBridgeTree.WITNESS.fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`TokenBridgeTree.WITNESS.toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`TokenBridgeTree.WITNESS.toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:31 + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`TokenBridgeTree.WITNESS.toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:38 + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `boolean`[] + +##### path + +> **path**: `string`[] + +#### Inherited from + +`TokenBridgeTree.WITNESS.toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `boolean`[] + +##### path + +> **path**: `bigint`[] + +#### Inherited from + +`TokenBridgeTree.WITNESS.toValue` + +## Methods + +### calculateIndex() + +> **calculateIndex**(): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:71 + +Calculates the index of the leaf node that belongs to this Witness. + +#### Returns + +`Field` + +Index of the leaf. + +#### Inherited from + +`TokenBridgeTree.WITNESS.calculateIndex` + +*** + +### calculateRoot() + +> **calculateRoot**(`hash`): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:66 + +Calculates a root depending on the leaf value. + +#### Parameters + +##### hash + +`Field` + +#### Returns + +`Field` + +The calculated root. + +#### Inherited from + +`TokenBridgeTree.WITNESS.calculateRoot` + +*** + +### checkMembership() + +> **checkMembership**(`root`, `key`, `value`): `Bool` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:72 + +#### Parameters + +##### root + +`Field` + +##### key + +`Field` + +##### value + +`Field` + +#### Returns + +`Bool` + +#### Inherited from + +`TokenBridgeTree.WITNESS.checkMembership` + +*** + +### checkMembershipGetRoots() + +> **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:73 + +#### Parameters + +##### root + +`Field` + +##### key + +`Field` + +##### value + +`Field` + +#### Returns + +\[`Bool`, `Field`, `Field`\] + +#### Inherited from + +`TokenBridgeTree.WITNESS.checkMembershipGetRoots` + +*** + +### height() + +> **height**(): `number` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:60 + +#### Returns + +`number` + +#### Inherited from + +`TokenBridgeTree.WITNESS.height` + +*** + +### toShortenedEntries() + +> **toShortenedEntries**(): `string`[] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:74 + +#### Returns + +`string`[] + +#### Inherited from + +`TokenBridgeTree.WITNESS.toShortenedEntries` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`TokenBridgeTree.WITNESS.sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TokenMapping.md b/src/pages/docs/reference/protocol/classes/TokenMapping.md new file mode 100644 index 0000000..4e5f6a2 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/TokenMapping.md @@ -0,0 +1,429 @@ +--- +title: TokenMapping +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenMapping + +# Class: TokenMapping + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L60) + +## Extends + +- `object` + +## Constructors + +### new TokenMapping() + +> **new TokenMapping**(`value`): [`TokenMapping`](TokenMapping.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### publicKey + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +[`TokenMapping`](TokenMapping.md) + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).constructor` + +## Properties + +### publicKey + +> **publicKey**: `PublicKey` = `PublicKey` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L62) + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).publicKey` + +*** + +### tokenId + +> **tokenId**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L61) + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).tokenId` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### publicKey + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### publicKey + +> **publicKey**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### publicKey + +> **publicKey**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### publicKey + +`string` = `PublicKey` + +###### tokenId + +`string` = `Field` + +#### Returns + +`object` + +##### publicKey + +> **publicKey**: `PublicKey` = `PublicKey` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### publicKey + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### publicKey + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### publicKey + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### publicKey + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### publicKey + +> **publicKey**: `string` = `PublicKey` + +##### tokenId + +> **tokenId**: `string` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### publicKey + +`PublicKey` = `PublicKey` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### publicKey + +> **publicKey**: `object` = `PublicKey` + +###### publicKey.isOdd + +> **publicKey.isOdd**: `boolean` + +###### publicKey.x + +> **publicKey.x**: `bigint` + +##### tokenId + +> **tokenId**: `bigint` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ tokenId: Field, publicKey: PublicKey, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md b/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md new file mode 100644 index 0000000..1a56235 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md @@ -0,0 +1,31 @@ +--- +title: TransitionMethodExecutionResult +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TransitionMethodExecutionResult + +# Class: TransitionMethodExecutionResult + +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L3) + +## Constructors + +### new TransitionMethodExecutionResult() + +> **new TransitionMethodExecutionResult**(): [`TransitionMethodExecutionResult`](TransitionMethodExecutionResult.md) + +#### Returns + +[`TransitionMethodExecutionResult`](TransitionMethodExecutionResult.md) + +## Properties + +### stateTransitions + +> **stateTransitions**: [`StateTransition`](StateTransition.md)\<`any`\>[] = `[]` + +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L4) diff --git a/src/pages/docs/reference/protocol/classes/UInt64Option.md b/src/pages/docs/reference/protocol/classes/UInt64Option.md new file mode 100644 index 0000000..24b68d6 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/UInt64Option.md @@ -0,0 +1,479 @@ +--- +title: UInt64Option +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / UInt64Option + +# Class: UInt64Option + +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L24) + +## Extends + +- `Generic`\<`UInt64`, `this`\> + +## Constructors + +### new UInt64Option() + +> **new UInt64Option**(`value`): [`UInt64Option`](UInt64Option.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### isSome + +`Bool` = `Bool` + +###### value + +`UInt64` = `valueType` + +#### Returns + +[`UInt64Option`](UInt64Option.md) + +#### Inherited from + +`genericOptionFactory(UInt64).constructor` + +## Properties + +### isSome + +> **isSome**: `Bool` = `Bool` + +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L5) + +#### Inherited from + +`genericOptionFactory(UInt64).isSome` + +*** + +### value + +> **value**: `UInt64` = `valueType` + +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L6) + +#### Inherited from + +`genericOptionFactory(UInt64).value` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`genericOptionFactory(UInt64)._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### isSome + +`Bool` = `Bool` + +###### value + +`UInt64` = `valueType` + +#### Returns + +`void` + +#### Inherited from + +`genericOptionFactory(UInt64).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### isSome + +> **isSome**: `Bool` = `Bool` + +##### value + +> **value**: `UInt64` = `valueType` + +#### Inherited from + +`genericOptionFactory(UInt64).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`, `aux`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 + +A function that returns an element of type `T` from the given provable and "auxiliary" data. + +This function is the reverse operation of calling [toFields](UInt64Option.md#tofields) and toAuxilary methods on an element of type `T`. + +#### Parameters + +##### fields + +`Field`[] + +an array of Field elements describing the provable data of the new `T` element. + +##### aux + +`any`[] + +an array of any type describing the "auxiliary" data of the new `T` element, optional. + +#### Returns + +`object` + +An element of type `T` generated from the given provable and "auxiliary" data. + +##### isSome + +> **isSome**: `Bool` = `Bool` + +##### value + +> **value**: `UInt64` = `valueType` + +#### Inherited from + +`genericOptionFactory(UInt64).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### isSome + +`boolean` = `Bool` + +###### value + +`any` = `valueType` + +#### Returns + +`object` + +##### isSome + +> **isSome**: `Bool` = `Bool` + +##### value + +> **value**: `UInt64` = `valueType` + +#### Inherited from + +`genericOptionFactory(UInt64).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`genericOptionFactory(UInt64).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### isSome + +`Bool` = `Bool` + +###### value + +`UInt64` = `valueType` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`genericOptionFactory(UInt64).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### isSome + +`Bool` = `Bool` + +###### value + +`UInt64` = `valueType` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`genericOptionFactory(UInt64).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### isSome + +`Bool` = `Bool` + +###### value + +`UInt64` = `valueType` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`genericOptionFactory(UInt64).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### isSome + +`Bool` = `Bool` + +###### value + +`UInt64` = `valueType` + +#### Returns + +`object` + +##### isSome + +> **isSome**: `boolean` = `Bool` + +##### value + +> **value**: `any` = `valueType` + +#### Inherited from + +`genericOptionFactory(UInt64).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### isSome + +`Bool` = `Bool` + +###### value + +`UInt64` = `valueType` + +#### Returns + +`object` + +##### isSome + +> **isSome**: `boolean` = `Bool` + +##### value + +> **value**: `any` = `valueType` + +#### Inherited from + +`genericOptionFactory(UInt64).toValue` + +## Methods + +### fromSome() + +> `static` **fromSome**(`value`): `Generic`\<`UInt64`\> + +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L8) + +#### Parameters + +##### value + +`UInt64` + +#### Returns + +`Generic`\<`UInt64`\> + +#### Inherited from + +`genericOptionFactory(UInt64).fromSome` + +*** + +### none() + +> `static` **none**(`value`): `Generic`\<`UInt64`\> + +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L15) + +#### Parameters + +##### value + +`UInt64` + +#### Returns + +`Generic`\<`UInt64`\> + +#### Inherited from + +`genericOptionFactory(UInt64).none` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`genericOptionFactory(UInt64).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md b/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md new file mode 100644 index 0000000..894c859 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md @@ -0,0 +1,520 @@ +--- +title: UpdateMessagesHashAuth +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / UpdateMessagesHashAuth + +# Class: UpdateMessagesHashAuth + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L5) + +Interface for cross-contract call authorization +See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 + +## Extends + +- `object` + +## Implements + +- [`ContractAuthorization`](../interfaces/ContractAuthorization.md) + +## Constructors + +### new UpdateMessagesHashAuth() + +> **new UpdateMessagesHashAuth**(`value`): [`UpdateMessagesHashAuth`](UpdateMessagesHashAuth.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### executedMessagesHash + +`Field` = `Field` + +###### newPromisedMessagesHash + +`Field` = `Field` + +###### target + +`PublicKey` = `PublicKey` + +#### Returns + +[`UpdateMessagesHashAuth`](UpdateMessagesHashAuth.md) + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).constructor` + +## Properties + +### executedMessagesHash + +> **executedMessagesHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L8) + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).executedMessagesHash` + +*** + +### newPromisedMessagesHash + +> **newPromisedMessagesHash**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L9) + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).newPromisedMessagesHash` + +*** + +### target + +> **target**: `PublicKey` = `PublicKey` + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L7) + +#### Implementation of + +[`ContractAuthorization`](../interfaces/ContractAuthorization.md).[`target`](../interfaces/ContractAuthorization.md#target) + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).target` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### executedMessagesHash + +`Field` = `Field` + +###### newPromisedMessagesHash + +`Field` = `Field` + +###### target + +`PublicKey` = `PublicKey` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### executedMessagesHash + +> **executedMessagesHash**: `Field` = `Field` + +##### newPromisedMessagesHash + +> **newPromisedMessagesHash**: `Field` = `Field` + +##### target + +> **target**: `PublicKey` = `PublicKey` + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### executedMessagesHash + +> **executedMessagesHash**: `Field` = `Field` + +##### newPromisedMessagesHash + +> **newPromisedMessagesHash**: `Field` = `Field` + +##### target + +> **target**: `PublicKey` = `PublicKey` + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### executedMessagesHash + +`string` = `Field` + +###### newPromisedMessagesHash + +`string` = `Field` + +###### target + +`string` = `PublicKey` + +#### Returns + +`object` + +##### executedMessagesHash + +> **executedMessagesHash**: `Field` = `Field` + +##### newPromisedMessagesHash + +> **newPromisedMessagesHash**: `Field` = `Field` + +##### target + +> **target**: `PublicKey` = `PublicKey` + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### executedMessagesHash + +`Field` = `Field` + +###### newPromisedMessagesHash + +`Field` = `Field` + +###### target + +`PublicKey` = `PublicKey` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### executedMessagesHash + +`Field` = `Field` + +###### newPromisedMessagesHash + +`Field` = `Field` + +###### target + +`PublicKey` = `PublicKey` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### executedMessagesHash + +`Field` = `Field` + +###### newPromisedMessagesHash + +`Field` = `Field` + +###### target + +`PublicKey` = `PublicKey` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### executedMessagesHash + +`Field` = `Field` + +###### newPromisedMessagesHash + +`Field` = `Field` + +###### target + +`PublicKey` = `PublicKey` + +#### Returns + +`object` + +##### executedMessagesHash + +> **executedMessagesHash**: `string` = `Field` + +##### newPromisedMessagesHash + +> **newPromisedMessagesHash**: `string` = `Field` + +##### target + +> **target**: `string` = `PublicKey` + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### executedMessagesHash + +`Field` = `Field` + +###### newPromisedMessagesHash + +`Field` = `Field` + +###### target + +`PublicKey` = `PublicKey` + +#### Returns + +`object` + +##### executedMessagesHash + +> **executedMessagesHash**: `bigint` = `Field` + +##### newPromisedMessagesHash + +> **newPromisedMessagesHash**: `bigint` = `Field` + +##### target + +> **target**: `object` = `PublicKey` + +###### target.isOdd + +> **target.isOdd**: `boolean` + +###### target.x + +> **target.x**: `bigint` + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).toValue` + +## Methods + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L13) + +#### Returns + +`Field` + +#### Implementation of + +[`ContractAuthorization`](../interfaces/ContractAuthorization.md).[`hash`](../interfaces/ContractAuthorization.md#hash) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/VKTree.md b/src/pages/docs/reference/protocol/classes/VKTree.md new file mode 100644 index 0000000..9a45c0a --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/VKTree.md @@ -0,0 +1,291 @@ +--- +title: VKTree +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / VKTree + +# Class: VKTree + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L5) + +## Extends + +- [`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md) + +## Constructors + +### new VKTree() + +> **new VKTree**(`store`): [`VKTree`](VKTree.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:113 + +#### Parameters + +##### store + +[`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) + +#### Returns + +[`VKTree`](VKTree.md) + +#### Inherited from + +`createMerkleTree(treeFeeHeight).constructor` + +## Properties + +### leafCount + +> `readonly` **leafCount**: `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:78 + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`leafCount`](../../common/interfaces/AbstractMerkleTree.md#leafcount) + +*** + +### store + +> **store**: [`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:77 + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`store`](../../common/interfaces/AbstractMerkleTree.md#store) + +*** + +### EMPTY\_ROOT + +> `static` **EMPTY\_ROOT**: `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:118 + +#### Inherited from + +`createMerkleTree(treeFeeHeight).EMPTY_ROOT` + +*** + +### HEIGHT + +> `static` **HEIGHT**: `number` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:117 + +#### Inherited from + +`createMerkleTree(treeFeeHeight).HEIGHT` + +*** + +### WITNESS + +> `static` **WITNESS**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:114 + +#### Type declaration + +##### dummy() + +> **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +###### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +#### Inherited from + +`createMerkleTree(treeFeeHeight).WITNESS` + +## Accessors + +### leafCount + +#### Get Signature + +> **get** `static` **leafCount**(): `bigint` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:119 + +##### Returns + +`bigint` + +#### Inherited from + +`createMerkleTree(treeFeeHeight).leafCount` + +## Methods + +### assertIndexRange() + +> **assertIndexRange**(`index`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:79 + +#### Parameters + +##### index + +`bigint` + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`assertIndexRange`](../../common/interfaces/AbstractMerkleTree.md#assertindexrange) + +*** + +### fill() + +> **fill**(`leaves`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:110 + +Fills all leaves of the tree. + +#### Parameters + +##### leaves + +`Field`[] + +Values to fill the leaves with. + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`fill`](../../common/interfaces/AbstractMerkleTree.md#fill) + +*** + +### getNode() + +> **getNode**(`level`, `index`): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:86 + +Returns a node which lives at a given index and level. + +#### Parameters + +##### level + +`number` + +Level of the node. + +##### index + +`bigint` + +Index of the node. + +#### Returns + +`Field` + +The data of the node. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getNode`](../../common/interfaces/AbstractMerkleTree.md#getnode) + +*** + +### getRoot() + +> **getRoot**(): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:91 + +Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). + +#### Returns + +`Field` + +The root of the Merkle Tree. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getRoot`](../../common/interfaces/AbstractMerkleTree.md#getroot) + +*** + +### getWitness() + +> **getWitness**(`index`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:105 + +Returns the witness (also known as +[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) +for the leaf at the given index. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +#### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +The witness that belongs to the leaf. + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getWitness`](../../common/interfaces/AbstractMerkleTree.md#getwitness) + +*** + +### setLeaf() + +> **setLeaf**(`index`, `leaf`): `void` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:97 + +Sets the value of a leaf node at a given index to a given value. + +#### Parameters + +##### index + +`bigint` + +Position of the leaf node. + +##### leaf + +`Field` + +New value. + +#### Returns + +`void` + +#### Inherited from + +[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`setLeaf`](../../common/interfaces/AbstractMerkleTree.md#setleaf) diff --git a/src/pages/docs/reference/protocol/classes/VKTreeWitness.md b/src/pages/docs/reference/protocol/classes/VKTreeWitness.md new file mode 100644 index 0000000..2196cc9 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/VKTreeWitness.md @@ -0,0 +1,575 @@ +--- +title: VKTreeWitness +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / VKTreeWitness + +# Class: VKTreeWitness + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L6) + +## Extends + +- [`WITNESS`](VKTree.md#witness) + +## Constructors + +### new VKTreeWitness() + +> **new VKTreeWitness**(`value`): [`VKTreeWitness`](VKTreeWitness.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:4 + +#### Parameters + +##### value + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +[`VKTreeWitness`](VKTreeWitness.md) + +#### Inherited from + +`VKTree.WITNESS.constructor` + +## Properties + +### isLeft + +> **isLeft**: `Bool`[] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:9 + +#### Inherited from + +`VKTree.WITNESS.isLeft` + +*** + +### path + +> **path**: `Field`[] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:8 + +#### Inherited from + +`VKTree.WITNESS.path` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:11 + +#### Inherited from + +`VKTree.WITNESS._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`void` + +#### Inherited from + +`VKTree.WITNESS.check` + +*** + +### dummy() + +> `static` **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:115 + +#### Returns + +[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +#### Inherited from + +`VKTree.WITNESS.dummy` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:52 + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`VKTree.WITNESS.empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:19 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`VKTree.WITNESS.fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:45 + +#### Parameters + +##### x + +###### isLeft + +`boolean`[] + +###### path + +`string`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `Bool`[] + +##### path + +> **path**: `Field`[] + +#### Inherited from + +`VKTree.WITNESS.fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`VKTree.WITNESS.fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`VKTree.WITNESS.toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`VKTree.WITNESS.toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:31 + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`VKTree.WITNESS.toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:38 + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `boolean`[] + +##### path + +> **path**: `string`[] + +#### Inherited from + +`VKTree.WITNESS.toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### isLeft + +`Bool`[] + +###### path + +`Field`[] + +#### Returns + +`object` + +##### isLeft + +> **isLeft**: `boolean`[] + +##### path + +> **path**: `bigint`[] + +#### Inherited from + +`VKTree.WITNESS.toValue` + +## Methods + +### calculateIndex() + +> **calculateIndex**(): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:71 + +Calculates the index of the leaf node that belongs to this Witness. + +#### Returns + +`Field` + +Index of the leaf. + +#### Inherited from + +`VKTree.WITNESS.calculateIndex` + +*** + +### calculateRoot() + +> **calculateRoot**(`hash`): `Field` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:66 + +Calculates a root depending on the leaf value. + +#### Parameters + +##### hash + +`Field` + +#### Returns + +`Field` + +The calculated root. + +#### Inherited from + +`VKTree.WITNESS.calculateRoot` + +*** + +### checkMembership() + +> **checkMembership**(`root`, `key`, `value`): `Bool` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:72 + +#### Parameters + +##### root + +`Field` + +##### key + +`Field` + +##### value + +`Field` + +#### Returns + +`Bool` + +#### Inherited from + +`VKTree.WITNESS.checkMembership` + +*** + +### checkMembershipGetRoots() + +> **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:73 + +#### Parameters + +##### root + +`Field` + +##### key + +`Field` + +##### value + +`Field` + +#### Returns + +\[`Bool`, `Field`, `Field`\] + +#### Inherited from + +`VKTree.WITNESS.checkMembershipGetRoots` + +*** + +### height() + +> **height**(): `number` + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:60 + +#### Returns + +`number` + +#### Inherited from + +`VKTree.WITNESS.height` + +*** + +### toShortenedEntries() + +> **toShortenedEntries**(): `string`[] + +Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:74 + +#### Returns + +`string`[] + +#### Inherited from + +`VKTree.WITNESS.toShortenedEntries` + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`VKTree.WITNESS.sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/WithPath.md b/src/pages/docs/reference/protocol/classes/WithPath.md new file mode 100644 index 0000000..fb34930 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/WithPath.md @@ -0,0 +1,43 @@ +--- +title: WithPath +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / WithPath + +# Class: WithPath + +Defined in: [packages/protocol/src/state/State.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L13) + +## Constructors + +### new WithPath() + +> **new WithPath**(): [`WithPath`](WithPath.md) + +#### Returns + +[`WithPath`](WithPath.md) + +## Properties + +### path? + +> `optional` **path**: `Field` + +Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L14) + +## Methods + +### hasPathOrFail() + +> **hasPathOrFail**(): `asserts this is { path: Path }` + +Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L16) + +#### Returns + +`asserts this is { path: Path }` diff --git a/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md b/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md new file mode 100644 index 0000000..cf8fa29 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md @@ -0,0 +1,43 @@ +--- +title: WithStateServiceProvider +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / WithStateServiceProvider + +# Class: WithStateServiceProvider + +Defined in: [packages/protocol/src/state/State.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L25) + +## Constructors + +### new WithStateServiceProvider() + +> **new WithStateServiceProvider**(): [`WithStateServiceProvider`](WithStateServiceProvider.md) + +#### Returns + +[`WithStateServiceProvider`](WithStateServiceProvider.md) + +## Properties + +### stateServiceProvider? + +> `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) + +Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L26) + +## Methods + +### hasStateServiceOrFail() + +> **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` + +Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L28) + +#### Returns + +`asserts this is { stateServiceProvider: StateServiceProvider }` diff --git a/src/pages/docs/reference/protocol/classes/Withdrawal.md b/src/pages/docs/reference/protocol/classes/Withdrawal.md new file mode 100644 index 0000000..6876043 --- /dev/null +++ b/src/pages/docs/reference/protocol/classes/Withdrawal.md @@ -0,0 +1,505 @@ +--- +title: Withdrawal +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Withdrawal + +# Class: Withdrawal + +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Withdrawal.ts#L4) + +## Extends + +- `object` + +## Constructors + +### new Withdrawal() + +> **new Withdrawal**(`value`): [`Withdrawal`](Withdrawal.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +[`Withdrawal`](Withdrawal.md) + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).constructor` + +## Properties + +### address + +> **address**: `PublicKey` = `PublicKey` + +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Withdrawal.ts#L6) + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).address` + +*** + +### amount + +> **amount**: `UInt64` = `UInt64` + +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Withdrawal.ts#L7) + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).amount` + +*** + +### tokenId + +> **tokenId**: `Field` = `Field` + +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Withdrawal.ts#L5) + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).tokenId` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### amount + +> **amount**: `UInt64` = `UInt64` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### amount + +> **amount**: `UInt64` = `UInt64` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### address + +`string` = `PublicKey` + +###### amount + +`string` = `UInt64` + +###### tokenId + +`string` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `PublicKey` = `PublicKey` + +##### amount + +> **amount**: `UInt64` = `UInt64` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `string` = `PublicKey` + +##### amount + +> **amount**: `string` = `UInt64` + +##### tokenId + +> **tokenId**: `string` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### address + +`PublicKey` = `PublicKey` + +###### amount + +`UInt64` = `UInt64` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### address + +> **address**: `object` = `PublicKey` + +###### address.isOdd + +> **address.isOdd**: `boolean` + +###### address.x + +> **address.x**: `bigint` + +##### amount + +> **amount**: `bigint` = `UInt64` + +##### tokenId + +> **tokenId**: `bigint` = `Field` + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toValue` + +## Methods + +### dummy() + +> `static` **dummy**(): [`Withdrawal`](Withdrawal.md) + +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Withdrawal.ts#L9) + +#### Returns + +[`Withdrawal`](Withdrawal.md) + +*** + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/functions/assert.md b/src/pages/docs/reference/protocol/functions/assert.md new file mode 100644 index 0000000..ae4362d --- /dev/null +++ b/src/pages/docs/reference/protocol/functions/assert.md @@ -0,0 +1,38 @@ +--- +title: assert +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / assert + +# Function: assert() + +> **assert**(`condition`, `message`?): `void` + +Defined in: [packages/protocol/src/state/assert/assert.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/assert/assert.ts#L16) + +Maintains an execution status of the current runtime module method, +while prioritizing one-time failures. The assertion won't change the +execution status if it has previously failed at least once within the +same method execution context. + +## Parameters + +### condition + +`Bool` + +Result of the assertion made about the execution status + +### message? + +Optional message describing the prior status + +`string` | () => `string` + +## Returns + +`void` diff --git a/src/pages/docs/reference/protocol/functions/emptyActions.md b/src/pages/docs/reference/protocol/functions/emptyActions.md new file mode 100644 index 0000000..fe817d7 --- /dev/null +++ b/src/pages/docs/reference/protocol/functions/emptyActions.md @@ -0,0 +1,19 @@ +--- +title: emptyActions +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / emptyActions + +# Function: emptyActions() + +> **emptyActions**(): `Field` + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L20) + +## Returns + +`Field` diff --git a/src/pages/docs/reference/protocol/functions/emptyEvents.md b/src/pages/docs/reference/protocol/functions/emptyEvents.md new file mode 100644 index 0000000..3ca9cd7 --- /dev/null +++ b/src/pages/docs/reference/protocol/functions/emptyEvents.md @@ -0,0 +1,19 @@ +--- +title: emptyEvents +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / emptyEvents + +# Function: emptyEvents() + +> **emptyEvents**(): `Field` + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L24) + +## Returns + +`Field` diff --git a/src/pages/docs/reference/protocol/functions/notInCircuit.md b/src/pages/docs/reference/protocol/functions/notInCircuit.md new file mode 100644 index 0000000..2caf9fd --- /dev/null +++ b/src/pages/docs/reference/protocol/functions/notInCircuit.md @@ -0,0 +1,19 @@ +--- +title: notInCircuit +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / notInCircuit + +# Function: notInCircuit() + +> **notInCircuit**(): `MethodDecorator` + +Defined in: [packages/protocol/src/utils/utils.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/utils.ts#L16) + +## Returns + +`MethodDecorator` diff --git a/src/pages/docs/reference/protocol/functions/protocolState.md b/src/pages/docs/reference/protocol/functions/protocolState.md new file mode 100644 index 0000000..3a30d96 --- /dev/null +++ b/src/pages/docs/reference/protocol/functions/protocolState.md @@ -0,0 +1,40 @@ +--- +title: protocolState +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / protocolState + +# Function: protocolState() + +> **protocolState**(): \<`TargetTransitioningModule`\>(`target`, `propertyKey`) => `void` + +Defined in: [packages/protocol/src/state/protocol/ProtocolState.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/protocol/ProtocolState.ts#L23) + +Decorates a runtime module property as state, passing down some +underlying values to improve developer experience. + +## Returns + +`Function` + +### Type Parameters + +• **TargetTransitioningModule** *extends* `TransitioningProtocolModule`\<`unknown`\> + +### Parameters + +#### target + +`TargetTransitioningModule` + +#### propertyKey + +`string` + +### Returns + +`void` diff --git a/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md b/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md new file mode 100644 index 0000000..77125de --- /dev/null +++ b/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md @@ -0,0 +1,25 @@ +--- +title: reduceStateTransitions +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / reduceStateTransitions + +# Function: reduceStateTransitions() + +> **reduceStateTransitions**(`transitions`): [`StateTransition`](../classes/StateTransition.md)\<`unknown`\>[] + +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/StateTransitionReductionList.ts#L61) + +## Parameters + +### transitions + +[`StateTransition`](../classes/StateTransition.md)\<`unknown`\>[] + +## Returns + +[`StateTransition`](../classes/StateTransition.md)\<`unknown`\>[] diff --git a/src/pages/docs/reference/protocol/functions/singleFieldToString.md b/src/pages/docs/reference/protocol/functions/singleFieldToString.md new file mode 100644 index 0000000..ad0cd75 --- /dev/null +++ b/src/pages/docs/reference/protocol/functions/singleFieldToString.md @@ -0,0 +1,25 @@ +--- +title: singleFieldToString +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / singleFieldToString + +# Function: singleFieldToString() + +> **singleFieldToString**(`value`): `string` + +Defined in: [packages/protocol/src/utils/utils.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/utils.ts#L69) + +## Parameters + +### value + +`bigint` | `Field` + +## Returns + +`string` diff --git a/src/pages/docs/reference/protocol/functions/stringToField.md b/src/pages/docs/reference/protocol/functions/stringToField.md new file mode 100644 index 0000000..4842a9e --- /dev/null +++ b/src/pages/docs/reference/protocol/functions/stringToField.md @@ -0,0 +1,25 @@ +--- +title: stringToField +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / stringToField + +# Function: stringToField() + +> **stringToField**(`value`): `Field` + +Defined in: [packages/protocol/src/utils/utils.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/utils.ts#L36) + +## Parameters + +### value + +`string` + +## Returns + +`Field` diff --git a/src/pages/docs/reference/protocol/globals.md b/src/pages/docs/reference/protocol/globals.md new file mode 100644 index 0000000..6520805 --- /dev/null +++ b/src/pages/docs/reference/protocol/globals.md @@ -0,0 +1,163 @@ +--- +title: "@proto-kit/protocol" +--- + +[**@proto-kit/protocol**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/protocol + +# @proto-kit/protocol + +## Classes + +- [AccountState](classes/AccountState.md) +- [AccountStateHook](classes/AccountStateHook.md) +- [BlockHashMerkleTree](classes/BlockHashMerkleTree.md) +- [BlockHashMerkleTreeWitness](classes/BlockHashMerkleTreeWitness.md) +- [BlockHashTreeEntry](classes/BlockHashTreeEntry.md) +- [BlockHeightHook](classes/BlockHeightHook.md) +- [BlockProver](classes/BlockProver.md) +- [BlockProverExecutionData](classes/BlockProverExecutionData.md) +- [BlockProverProgrammable](classes/BlockProverProgrammable.md) +- [BlockProverPublicInput](classes/BlockProverPublicInput.md) +- [BlockProverPublicOutput](classes/BlockProverPublicOutput.md) +- [BridgeContract](classes/BridgeContract.md) +- [BridgeContractBase](classes/BridgeContractBase.md) +- [BridgeContractProtocolModule](classes/BridgeContractProtocolModule.md) +- [ContractModule](classes/ContractModule.md) +- [CurrentBlock](classes/CurrentBlock.md) +- [DefaultProvableHashList](classes/DefaultProvableHashList.md) +- [Deposit](classes/Deposit.md) +- [DispatchContractProtocolModule](classes/DispatchContractProtocolModule.md) +- [DispatchSmartContract](classes/DispatchSmartContract.md) +- [DispatchSmartContractBase](classes/DispatchSmartContractBase.md) +- [DynamicBlockProof](classes/DynamicBlockProof.md) +- [DynamicRuntimeProof](classes/DynamicRuntimeProof.md) +- [LastStateRootBlockHook](classes/LastStateRootBlockHook.md) +- [MethodPublicOutput](classes/MethodPublicOutput.md) +- [MethodVKConfigData](classes/MethodVKConfigData.md) +- [MinaActions](classes/MinaActions.md) +- [MinaActionsHashList](classes/MinaActionsHashList.md) +- [MinaEvents](classes/MinaEvents.md) +- [MinaPrefixedProvableHashList](classes/MinaPrefixedProvableHashList.md) +- [NetworkState](classes/NetworkState.md) +- [NetworkStateSettlementModule](classes/NetworkStateSettlementModule.md) +- [Option](classes/Option.md) +- [OptionBase](classes/OptionBase.md) +- [OutgoingMessageArgument](classes/OutgoingMessageArgument.md) +- [OutgoingMessageArgumentBatch](classes/OutgoingMessageArgumentBatch.md) +- [OutgoingMessageKey](classes/OutgoingMessageKey.md) +- [Path](classes/Path.md) +- [PrefixedProvableHashList](classes/PrefixedProvableHashList.md) +- [PreviousBlock](classes/PreviousBlock.md) +- [Protocol](classes/Protocol.md) +- [ProtocolModule](classes/ProtocolModule.md) +- [ProvableBlockHook](classes/ProvableBlockHook.md) +- [ProvableHashList](classes/ProvableHashList.md) +- [ProvableOption](classes/ProvableOption.md) +- [ProvableReductionHashList](classes/ProvableReductionHashList.md) +- [ProvableSettlementHook](classes/ProvableSettlementHook.md) +- [ProvableStateTransition](classes/ProvableStateTransition.md) +- [ProvableStateTransitionType](classes/ProvableStateTransitionType.md) +- [ProvableTransactionHook](classes/ProvableTransactionHook.md) +- [PublicKeyOption](classes/PublicKeyOption.md) +- [RuntimeMethodExecutionContext](classes/RuntimeMethodExecutionContext.md) +- [RuntimeMethodExecutionDataStruct](classes/RuntimeMethodExecutionDataStruct.md) +- [RuntimeProvableMethodExecutionResult](classes/RuntimeProvableMethodExecutionResult.md) +- [RuntimeTransaction](classes/RuntimeTransaction.md) +- [RuntimeVerificationKeyAttestation](classes/RuntimeVerificationKeyAttestation.md) +- [RuntimeVerificationKeyRootService](classes/RuntimeVerificationKeyRootService.md) +- [SettlementContractModule](classes/SettlementContractModule.md) +- [SettlementContractProtocolModule](classes/SettlementContractProtocolModule.md) +- [SettlementSmartContract](classes/SettlementSmartContract.md) +- [SettlementSmartContractBase](classes/SettlementSmartContractBase.md) +- [SignedTransaction](classes/SignedTransaction.md) +- [State](classes/State.md) +- [StateMap](classes/StateMap.md) +- [StateServiceProvider](classes/StateServiceProvider.md) +- [StateTransition](classes/StateTransition.md) +- [StateTransitionProvableBatch](classes/StateTransitionProvableBatch.md) +- [StateTransitionProver](classes/StateTransitionProver.md) +- [StateTransitionProverProgrammable](classes/StateTransitionProverProgrammable.md) +- [StateTransitionProverPublicInput](classes/StateTransitionProverPublicInput.md) +- [StateTransitionProverPublicOutput](classes/StateTransitionProverPublicOutput.md) +- [StateTransitionReductionList](classes/StateTransitionReductionList.md) +- [StateTransitionType](classes/StateTransitionType.md) +- [TokenBridgeAttestation](classes/TokenBridgeAttestation.md) +- [TokenBridgeDeploymentAuth](classes/TokenBridgeDeploymentAuth.md) +- [TokenBridgeEntry](classes/TokenBridgeEntry.md) +- [TokenBridgeTree](classes/TokenBridgeTree.md) +- [TokenBridgeTreeAddition](classes/TokenBridgeTreeAddition.md) +- [TokenBridgeTreeWitness](classes/TokenBridgeTreeWitness.md) +- [TokenMapping](classes/TokenMapping.md) +- [TransitionMethodExecutionResult](classes/TransitionMethodExecutionResult.md) +- [UInt64Option](classes/UInt64Option.md) +- [UpdateMessagesHashAuth](classes/UpdateMessagesHashAuth.md) +- [VKTree](classes/VKTree.md) +- [VKTreeWitness](classes/VKTreeWitness.md) +- [Withdrawal](classes/Withdrawal.md) +- [WithPath](classes/WithPath.md) +- [WithStateServiceProvider](classes/WithStateServiceProvider.md) + +## Interfaces + +- [BlockProvable](interfaces/BlockProvable.md) +- [BlockProverState](interfaces/BlockProverState.md) +- [BlockProverType](interfaces/BlockProverType.md) +- [ContractAuthorization](interfaces/ContractAuthorization.md) +- [DispatchContractType](interfaces/DispatchContractType.md) +- [MinimalVKTreeService](interfaces/MinimalVKTreeService.md) +- [ProtocolDefinition](interfaces/ProtocolDefinition.md) +- [ProtocolEnvironment](interfaces/ProtocolEnvironment.md) +- [RuntimeLike](interfaces/RuntimeLike.md) +- [RuntimeMethodExecutionData](interfaces/RuntimeMethodExecutionData.md) +- [SettlementContractType](interfaces/SettlementContractType.md) +- [SimpleAsyncStateService](interfaces/SimpleAsyncStateService.md) +- [StateTransitionProvable](interfaces/StateTransitionProvable.md) +- [StateTransitionProverType](interfaces/StateTransitionProverType.md) +- [TransitionMethodExecutionContext](interfaces/TransitionMethodExecutionContext.md) + +## Type Aliases + +- [BlockProof](type-aliases/BlockProof.md) +- [BlockProverProof](type-aliases/BlockProverProof.md) +- [BridgeContractConfig](type-aliases/BridgeContractConfig.md) +- [BridgeContractType](type-aliases/BridgeContractType.md) +- [DispatchContractConfig](type-aliases/DispatchContractConfig.md) +- [InputBlockProof](type-aliases/InputBlockProof.md) +- [MandatoryProtocolModulesRecord](type-aliases/MandatoryProtocolModulesRecord.md) +- [MandatorySettlementModulesRecord](type-aliases/MandatorySettlementModulesRecord.md) +- [ProtocolModulesRecord](type-aliases/ProtocolModulesRecord.md) +- [ReturnType](type-aliases/ReturnType.md) +- [RuntimeMethodIdMapping](type-aliases/RuntimeMethodIdMapping.md) +- [RuntimeMethodInvocationType](type-aliases/RuntimeMethodInvocationType.md) +- [RuntimeProof](type-aliases/RuntimeProof.md) +- [SettlementContractConfig](type-aliases/SettlementContractConfig.md) +- [SettlementHookInputs](type-aliases/SettlementHookInputs.md) +- [SettlementModulesRecord](type-aliases/SettlementModulesRecord.md) +- [SettlementStateRecord](type-aliases/SettlementStateRecord.md) +- [SmartContractClassFromInterface](type-aliases/SmartContractClassFromInterface.md) +- [StateTransitionProof](type-aliases/StateTransitionProof.md) +- [Subclass](type-aliases/Subclass.md) + +## Variables + +- [ACTIONS\_EMPTY\_HASH](variables/ACTIONS_EMPTY_HASH.md) +- [BATCH\_SIGNATURE\_PREFIX](variables/BATCH_SIGNATURE_PREFIX.md) +- [MINA\_EVENT\_PREFIXES](variables/MINA_EVENT_PREFIXES.md) +- [OUTGOING\_MESSAGE\_BATCH\_SIZE](variables/OUTGOING_MESSAGE_BATCH_SIZE.md) +- [ProtocolConstants](variables/ProtocolConstants.md) +- [treeFeeHeight](variables/treeFeeHeight.md) + +## Functions + +- [assert](functions/assert.md) +- [emptyActions](functions/emptyActions.md) +- [emptyEvents](functions/emptyEvents.md) +- [notInCircuit](functions/notInCircuit.md) +- [protocolState](functions/protocolState.md) +- [reduceStateTransitions](functions/reduceStateTransitions.md) +- [singleFieldToString](functions/singleFieldToString.md) +- [stringToField](functions/stringToField.md) diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProvable.md b/src/pages/docs/reference/protocol/interfaces/BlockProvable.md new file mode 100644 index 0000000..f8f9447 --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/BlockProvable.md @@ -0,0 +1,145 @@ +--- +title: BlockProvable +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProvable + +# Interface: BlockProvable + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L75) + +## Extends + +- [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\>.[`CompilableModule`](../../common/interfaces/CompilableModule.md) + +## Extended by + +- [`BlockProverType`](BlockProverType.md) + +## Properties + +### merge() + +> **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L94) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) + +##### proof1 + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +##### proof2 + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +*** + +### proveBlock() + +> **proveBlock**: (`publicInput`, `networkState`, `blockWitness`, `transactionProof`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L86) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) + +##### networkState + +[`NetworkState`](../classes/NetworkState.md) + +##### blockWitness + +[`BlockHashMerkleTreeWitness`](../classes/BlockHashMerkleTreeWitness.md) + +##### transactionProof + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +*** + +### proveTransaction() + +> **proveTransaction**: (`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L78) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) + +##### stateProof + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +##### appProof + +[`DynamicRuntimeProof`](../classes/DynamicRuntimeProof.md) + +##### executionData + +[`BlockProverExecutionData`](../classes/BlockProverExecutionData.md) + +##### verificationKeyAttestation + +[`RuntimeVerificationKeyAttestation`](../classes/RuntimeVerificationKeyAttestation.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +*** + +### zkProgrammable + +> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 + +#### Inherited from + +[`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md).[`zkProgrammable`](../../common/interfaces/WithZkProgrammable.md#zkprogrammable) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +#### Inherited from + +[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProverState.md b/src/pages/docs/reference/protocol/interfaces/BlockProverState.md new file mode 100644 index 0000000..70b5faf --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/BlockProverState.md @@ -0,0 +1,76 @@ +--- +title: BlockProverState +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverState + +# Interface: BlockProverState + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L98) + +## Properties + +### blockHashRoot + +> **blockHashRoot**: `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:120](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L120) + +The root of the merkle tree encoding all block hashes, +see `BlockHashMerkleTree` + +*** + +### eternalTransactionsHash + +> **eternalTransactionsHash**: `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:127](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L127) + +A variant of the transactionsHash that is never reset. +Thought for usage in the sequence state mempool. +In comparison, transactionsHash restarts at 0 for every new block + +*** + +### incomingMessagesHash + +> **incomingMessagesHash**: `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L129) + +*** + +### networkStateHash + +> **networkStateHash**: `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L114) + +The network state which gives access to values such as blockHeight +This value is the same for the whole batch (L2 block) + +*** + +### stateRoot + +> **stateRoot**: `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:102](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L102) + +The current state root of the block prover + +*** + +### transactionsHash + +> **transactionsHash**: `Field` + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L108) + +The current commitment of the transaction-list which +will at the end equal the bundle hash diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProverType.md b/src/pages/docs/reference/protocol/interfaces/BlockProverType.md new file mode 100644 index 0000000..98aa2d1 --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/BlockProverType.md @@ -0,0 +1,272 @@ +--- +title: BlockProverType +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverType + +# Interface: BlockProverType + +Defined in: [packages/protocol/src/protocol/Protocol.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L41) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ProtocolModule`](../classes/ProtocolModule.md).[`BlockProvable`](BlockProvable.md) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`currentConfig`](../classes/ProtocolModule.md#currentconfig) + +*** + +### merge() + +> **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L94) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) + +##### proof1 + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +##### proof2 + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +#### Inherited from + +[`BlockProvable`](BlockProvable.md).[`merge`](BlockProvable.md#merge) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`protocol`](../classes/ProtocolModule.md#protocol) + +*** + +### proveBlock() + +> **proveBlock**: (`publicInput`, `networkState`, `blockWitness`, `transactionProof`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L86) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) + +##### networkState + +[`NetworkState`](../classes/NetworkState.md) + +##### blockWitness + +[`BlockHashMerkleTreeWitness`](../classes/BlockHashMerkleTreeWitness.md) + +##### transactionProof + +[`BlockProverProof`](../type-aliases/BlockProverProof.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +#### Inherited from + +[`BlockProvable`](BlockProvable.md).[`proveBlock`](BlockProvable.md#proveblock) + +*** + +### proveTransaction() + +> **proveTransaction**: (`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L78) + +#### Parameters + +##### publicInput + +[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) + +##### stateProof + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +##### appProof + +[`DynamicRuntimeProof`](../classes/DynamicRuntimeProof.md) + +##### executionData + +[`BlockProverExecutionData`](../classes/BlockProverExecutionData.md) + +##### verificationKeyAttestation + +[`RuntimeVerificationKeyAttestation`](../classes/RuntimeVerificationKeyAttestation.md) + +#### Returns + +`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +#### Inherited from + +[`BlockProvable`](BlockProvable.md).[`proveTransaction`](BlockProvable.md#provetransaction) + +*** + +### zkProgrammable + +> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 + +#### Inherited from + +[`BlockProvable`](BlockProvable.md).[`zkProgrammable`](BlockProvable.md#zkprogrammable) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`areProofsEnabled`](../classes/ProtocolModule.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`config`](../classes/ProtocolModule.md#config) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +#### Inherited from + +[`BlockProvable`](BlockProvable.md).[`compile`](BlockProvable.md#compile) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`create`](../classes/ProtocolModule.md#create) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`start`](../classes/ProtocolModule.md#start) diff --git a/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md b/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md new file mode 100644 index 0000000..046f13c --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md @@ -0,0 +1,36 @@ +--- +title: ContractAuthorization +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ContractAuthorization + +# Interface: ContractAuthorization + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L7) + +Interface for cross-contract call authorization +See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 + +## Properties + +### hash() + +> **hash**: () => `Field` + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L10) + +#### Returns + +`Field` + +*** + +### target + +> **target**: `PublicKey` + +Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L8) diff --git a/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md b/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md new file mode 100644 index 0000000..4804417 --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md @@ -0,0 +1,87 @@ +--- +title: DispatchContractType +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DispatchContractType + +# Interface: DispatchContractType + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L40) + +## Properties + +### enableTokenDeposits() + +> **enableTokenDeposits**: (`tokenId`, `bridgeContractAddress`, `settlementContractAddress`) => `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L46) + +#### Parameters + +##### tokenId + +`Field` + +##### bridgeContractAddress + +`PublicKey` + +##### settlementContractAddress + +`PublicKey` + +#### Returns + +`Promise`\<`void`\> + +*** + +### initialize() + +> **initialize**: (`settlementContract`) => `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L45) + +#### Parameters + +##### settlementContract + +`PublicKey` + +#### Returns + +`Promise`\<`void`\> + +*** + +### promisedMessagesHash + +> **promisedMessagesHash**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L52) + +*** + +### updateMessagesHash() + +> **updateMessagesHash**: (`executedMessagesHash`, `newPromisedMessagesHash`) => `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L41) + +#### Parameters + +##### executedMessagesHash + +`Field` + +##### newPromisedMessagesHash + +`Field` + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md b/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md new file mode 100644 index 0000000..e63f21f --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md @@ -0,0 +1,25 @@ +--- +title: MinimalVKTreeService +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MinimalVKTreeService + +# Interface: MinimalVKTreeService + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L22) + +## Properties + +### getRoot() + +> **getRoot**: () => `bigint` + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L23) + +#### Returns + +`bigint` diff --git a/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md b/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md new file mode 100644 index 0000000..3fa689e --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md @@ -0,0 +1,33 @@ +--- +title: ProtocolDefinition +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProtocolDefinition + +# Interface: ProtocolDefinition\ + +Defined in: [packages/protocol/src/protocol/Protocol.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L55) + +## Type Parameters + +• **Modules** *extends* [`ProtocolModulesRecord`](../type-aliases/ProtocolModulesRecord.md) + +## Properties + +### config? + +> `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: [packages/protocol/src/protocol/Protocol.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L57) + +*** + +### modules + +> **modules**: `Modules` + +Defined in: [packages/protocol/src/protocol/Protocol.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L56) diff --git a/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md b/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md new file mode 100644 index 0000000..8a651fe --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md @@ -0,0 +1,53 @@ +--- +title: ProtocolEnvironment +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProtocolEnvironment + +# Interface: ProtocolEnvironment + +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolEnvironment.ts#L6) + +## Accessors + +### stateService + +#### Get Signature + +> **get** **stateService**(): [`SimpleAsyncStateService`](SimpleAsyncStateService.md) + +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolEnvironment.ts#L7) + +##### Returns + +[`SimpleAsyncStateService`](SimpleAsyncStateService.md) + +*** + +### stateServiceProvider + +#### Get Signature + +> **get** **stateServiceProvider**(): [`StateServiceProvider`](../classes/StateServiceProvider.md) + +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolEnvironment.ts#L8) + +##### Returns + +[`StateServiceProvider`](../classes/StateServiceProvider.md) + +## Methods + +### getAreProofsEnabled() + +> **getAreProofsEnabled**(): [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolEnvironment.ts#L9) + +#### Returns + +[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) diff --git a/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md b/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md new file mode 100644 index 0000000..efa3750 --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md @@ -0,0 +1,35 @@ +--- +title: RuntimeLike +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeLike + +# Interface: RuntimeLike + +Defined in: [packages/protocol/src/model/RuntimeLike.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/RuntimeLike.ts#L8) + +## Accessors + +### methodIdResolver + +#### Get Signature + +> **get** **methodIdResolver**(): `object` + +Defined in: [packages/protocol/src/model/RuntimeLike.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/RuntimeLike.ts#L9) + +##### Returns + +`object` + +###### methodIdMap() + +> **methodIdMap**: () => [`RuntimeMethodIdMapping`](../type-aliases/RuntimeMethodIdMapping.md) + +###### Returns + +[`RuntimeMethodIdMapping`](../type-aliases/RuntimeMethodIdMapping.md) diff --git a/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md b/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md new file mode 100644 index 0000000..5147aec --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md @@ -0,0 +1,29 @@ +--- +title: RuntimeMethodExecutionData +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeMethodExecutionData + +# Interface: RuntimeMethodExecutionData + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L36) + +## Properties + +### networkState + +> **networkState**: [`NetworkState`](../classes/NetworkState.md) + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L38) + +*** + +### transaction + +> **transaction**: [`RuntimeTransaction`](../classes/RuntimeTransaction.md) + +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L37) diff --git a/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md b/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md new file mode 100644 index 0000000..33391cf --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md @@ -0,0 +1,137 @@ +--- +title: SettlementContractType +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementContractType + +# Interface: SettlementContractType + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L65) + +## Properties + +### addTokenBridge() + +> **addTokenBridge**: (`tokenId`, `address`, `dispatchContract`) => `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L84) + +#### Parameters + +##### tokenId + +`Field` + +##### address + +`PublicKey` + +##### dispatchContract + +`PublicKey` + +#### Returns + +`Promise`\<`void`\> + +*** + +### assertStateRoot() + +> **assertStateRoot**: (`root`) => `AccountUpdate` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L74) + +#### Parameters + +##### root + +`Field` + +#### Returns + +`AccountUpdate` + +*** + +### authorizationField + +> **authorizationField**: `State`\<`Field`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L66) + +*** + +### initialize() + +> **initialize**: (`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`) => `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L68) + +#### Parameters + +##### sequencer + +`PublicKey` + +##### dispatchContract + +`PublicKey` + +##### bridgeContract + +`PublicKey` + +##### contractKey + +`PrivateKey` + +#### Returns + +`Promise`\<`void`\> + +*** + +### settle() + +> **settle**: (`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`) => `Promise`\<`void`\> + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L75) + +#### Parameters + +##### blockProof + +[`DynamicBlockProof`](../classes/DynamicBlockProof.md) + +##### signature + +`Signature` + +##### dispatchContractAddress + +`PublicKey` + +##### publicKey + +`PublicKey` + +##### inputNetworkState + +[`NetworkState`](../classes/NetworkState.md) + +##### outputNetworkState + +[`NetworkState`](../classes/NetworkState.md) + +##### newPromisedMessagesHash + +`Field` + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md b/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md new file mode 100644 index 0000000..01f60c0 --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md @@ -0,0 +1,53 @@ +--- +title: SimpleAsyncStateService +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SimpleAsyncStateService + +# Interface: SimpleAsyncStateService + +Defined in: [packages/protocol/src/state/StateService.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateService.ts#L3) + +## Properties + +### get() + +> **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> + +Defined in: [packages/protocol/src/state/StateService.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateService.ts#L4) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| `Field`[]\> + +*** + +### set() + +> **set**: (`key`, `value`) => `Promise`\<`void`\> + +Defined in: [packages/protocol/src/state/StateService.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateService.ts#L5) + +#### Parameters + +##### key + +`Field` + +##### value + +`undefined` | `Field`[] + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md b/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md new file mode 100644 index 0000000..bdac9be --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md @@ -0,0 +1,103 @@ +--- +title: StateTransitionProvable +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProvable + +# Interface: StateTransitionProvable + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L25) + +## Extends + +- [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\>.[`CompilableModule`](../../common/interfaces/CompilableModule.md) + +## Extended by + +- [`StateTransitionProverType`](StateTransitionProverType.md) + +## Properties + +### merge() + +> **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) + +#### Parameters + +##### publicInput + +[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md) + +##### proof1 + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +##### proof2 + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +#### Returns + +`Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +*** + +### runBatch() + +> **runBatch**: (`publicInput`, `batch`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) + +#### Parameters + +##### publicInput + +[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md) + +##### batch + +[`StateTransitionProvableBatch`](../classes/StateTransitionProvableBatch.md) + +#### Returns + +`Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +*** + +### zkProgrammable + +> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 + +#### Inherited from + +[`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md).[`zkProgrammable`](../../common/interfaces/WithZkProgrammable.md#zkprogrammable) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +#### Inherited from + +[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) diff --git a/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md b/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md new file mode 100644 index 0000000..f43464a --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md @@ -0,0 +1,226 @@ +--- +title: StateTransitionProverType +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProverType + +# Interface: StateTransitionProverType + +Defined in: [packages/protocol/src/protocol/Protocol.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L43) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ProtocolModule`](../classes/ProtocolModule.md).[`StateTransitionProvable`](StateTransitionProvable.md) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`currentConfig`](../classes/ProtocolModule.md#currentconfig) + +*** + +### merge() + +> **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) + +#### Parameters + +##### publicInput + +[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md) + +##### proof1 + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +##### proof2 + +[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) + +#### Returns + +`Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +#### Inherited from + +[`StateTransitionProvable`](StateTransitionProvable.md).[`merge`](StateTransitionProvable.md#merge) + +*** + +### protocol? + +> `optional` **protocol**: [`ProtocolEnvironment`](ProtocolEnvironment.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`protocol`](../classes/ProtocolModule.md#protocol) + +*** + +### runBatch() + +> **runBatch**: (`publicInput`, `batch`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) + +#### Parameters + +##### publicInput + +[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md) + +##### batch + +[`StateTransitionProvableBatch`](../classes/StateTransitionProvableBatch.md) + +#### Returns + +`Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +#### Inherited from + +[`StateTransitionProvable`](StateTransitionProvable.md).[`runBatch`](StateTransitionProvable.md#runbatch) + +*** + +### zkProgrammable + +> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 + +#### Inherited from + +[`StateTransitionProvable`](StateTransitionProvable.md).[`zkProgrammable`](StateTransitionProvable.md#zkprogrammable) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) + +##### Returns + +`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`areProofsEnabled`](../classes/ProtocolModule.md#areproofsenabled) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`config`](../classes/ProtocolModule.md#config) + +## Methods + +### compile() + +> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 + +#### Parameters + +##### registry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +`Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> + +#### Inherited from + +[`StateTransitionProvable`](StateTransitionProvable.md).[`compile`](StateTransitionProvable.md#compile) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`create`](../classes/ProtocolModule.md#create) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`ProtocolModule`](../classes/ProtocolModule.md).[`start`](../classes/ProtocolModule.md#start) diff --git a/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md b/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md new file mode 100644 index 0000000..19783dc --- /dev/null +++ b/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md @@ -0,0 +1,72 @@ +--- +title: TransitionMethodExecutionContext +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TransitionMethodExecutionContext + +# Interface: TransitionMethodExecutionContext + +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L7) + +## Properties + +### addStateTransition() + +> **addStateTransition**: \<`Value`\>(`stateTransition`) => `void` + +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L12) + +Adds an in-method generated state transition to the current context + +#### Type Parameters + +• **Value** + +#### Parameters + +##### stateTransition + +[`StateTransition`](../classes/StateTransition.md)\<`Value`\> + +State transition to add to the context + +#### Returns + +`void` + +*** + +### clear() + +> **clear**: () => `void` + +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L17) + +Manually clears/resets the execution context + +#### Returns + +`void` + +*** + +### current() + +> **current**: () => `object` + +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L23) + +Had to override current() otherwise it would not infer +the type of result correctly (parent type would be reused) + +#### Returns + +`object` + +##### result + +> **result**: [`TransitionMethodExecutionResult`](../classes/TransitionMethodExecutionResult.md) diff --git a/src/pages/docs/reference/protocol/type-aliases/BlockProof.md b/src/pages/docs/reference/protocol/type-aliases/BlockProof.md new file mode 100644 index 0000000..f5f8b3f --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/BlockProof.md @@ -0,0 +1,15 @@ +--- +title: BlockProof +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProof + +# Type Alias: BlockProof + +> **BlockProof**: `Proof`\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L132) diff --git a/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md b/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md new file mode 100644 index 0000000..282cc65 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md @@ -0,0 +1,15 @@ +--- +title: BlockProverProof +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverProof + +# Type Alias: BlockProverProof + +> **BlockProverProof**: `Proof`\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L52) diff --git a/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md new file mode 100644 index 0000000..cbd075a --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md @@ -0,0 +1,25 @@ +--- +title: BridgeContractConfig +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BridgeContractConfig + +# Type Alias: BridgeContractConfig + +> **BridgeContractConfig**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L12) + +## Type declaration + +### withdrawalEventName + +> **withdrawalEventName**: `string` + +### withdrawalStatePath + +> **withdrawalStatePath**: `` `${string}.${string}` `` diff --git a/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md b/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md new file mode 100644 index 0000000..561325f --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md @@ -0,0 +1,93 @@ +--- +title: BridgeContractType +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BridgeContractType + +# Type Alias: BridgeContractType + +> **BridgeContractType**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L29) + +## Type declaration + +### deployProvable() + +> **deployProvable**: (`args`, `signedSettlement`, `permissions`, `settlementContractAddress`) => `Promise`\<`AccountUpdate`\> + +#### Parameters + +##### args + +`VerificationKey` | `undefined` + +##### signedSettlement + +`boolean` + +##### permissions + +`Permissions` + +##### settlementContractAddress + +`PublicKey` + +#### Returns + +`Promise`\<`AccountUpdate`\> + +### outgoingMessageCursor + +> **outgoingMessageCursor**: `State`\<`Field`\> + +### redeem() + +> **redeem**: (`additionUpdate`) => `Promise`\<`void`\> + +#### Parameters + +##### additionUpdate + +`AccountUpdate` + +#### Returns + +`Promise`\<`void`\> + +### rollupOutgoingMessages() + +> **rollupOutgoingMessages**: (`batch`) => `Promise`\<`Field`\> + +#### Parameters + +##### batch + +[`OutgoingMessageArgumentBatch`](../classes/OutgoingMessageArgumentBatch.md) + +#### Returns + +`Promise`\<`Field`\> + +### stateRoot + +> **stateRoot**: `State`\<`Field`\> + +### updateStateRoot() + +> **updateStateRoot**: (`root`) => `Promise`\<`void`\> + +#### Parameters + +##### root + +`Field` + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md new file mode 100644 index 0000000..12550f7 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md @@ -0,0 +1,21 @@ +--- +title: DispatchContractConfig +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DispatchContractConfig + +# Type Alias: DispatchContractConfig + +> **DispatchContractConfig**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L17) + +## Type declaration + +### incomingMessagesMethods + +> **incomingMessagesMethods**: `Record`\<`string`, `` `${string}.${string}` ``\> diff --git a/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md b/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md new file mode 100644 index 0000000..78a062b --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md @@ -0,0 +1,15 @@ +--- +title: InputBlockProof +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / InputBlockProof + +# Type Alias: InputBlockProof + +> **InputBlockProof**: [`InferProofBase`](../../common/type-aliases/InferProofBase.md)\<[`BlockProof`](BlockProof.md)\> + +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L9) diff --git a/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md new file mode 100644 index 0000000..543613c --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md @@ -0,0 +1,37 @@ +--- +title: MandatoryProtocolModulesRecord +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MandatoryProtocolModulesRecord + +# Type Alias: MandatoryProtocolModulesRecord + +> **MandatoryProtocolModulesRecord**: `object` + +Defined in: [packages/protocol/src/protocol/Protocol.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L47) + +## Type declaration + +### AccountState + +> **AccountState**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AccountStateHook`](../classes/AccountStateHook.md)\> + +### BlockHeight + +> **BlockHeight**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BlockHeightHook`](../classes/BlockHeightHook.md)\> + +### BlockProver + +> **BlockProver**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BlockProverType`](../interfaces/BlockProverType.md)\> + +### LastStateRoot + +> **LastStateRoot**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LastStateRootBlockHook`](../classes/LastStateRootBlockHook.md)\> + +### StateTransitionProver + +> **StateTransitionProver**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md)\> diff --git a/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md new file mode 100644 index 0000000..4983c47 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md @@ -0,0 +1,29 @@ +--- +title: MandatorySettlementModulesRecord +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MandatorySettlementModulesRecord + +# Type Alias: MandatorySettlementModulesRecord + +> **MandatorySettlementModulesRecord**: `object` + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L35) + +## Type declaration + +### BridgeContract + +> **BridgeContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ContractModule`](../classes/ContractModule.md)\<[`BridgeContractType`](BridgeContractType.md), [`BridgeContractConfig`](BridgeContractConfig.md)\>\> + +### DispatchContract + +> **DispatchContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ContractModule`](../classes/ContractModule.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md), `unknown`\>\> + +### SettlementContract + +> **SettlementContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ContractModule`](../classes/ContractModule.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md), [`SettlementContractConfig`](SettlementContractConfig.md)\>\> diff --git a/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md new file mode 100644 index 0000000..d68c342 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md @@ -0,0 +1,15 @@ +--- +title: ProtocolModulesRecord +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProtocolModulesRecord + +# Type Alias: ProtocolModulesRecord + +> **ProtocolModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ProtocolModule`](../classes/ProtocolModule.md)\<`unknown`\>\>\> + +Defined in: [packages/protocol/src/protocol/Protocol.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L37) diff --git a/src/pages/docs/reference/protocol/type-aliases/ReturnType.md b/src/pages/docs/reference/protocol/type-aliases/ReturnType.md new file mode 100644 index 0000000..005e937 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/ReturnType.md @@ -0,0 +1,19 @@ +--- +title: ReturnType +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ReturnType + +# Type Alias: ReturnType\ + +> **ReturnType**\<`FunctionType`\>: `FunctionType` *extends* (...`args`) => infer Return ? `Return` : `any` + +Defined in: [packages/protocol/src/utils/utils.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/utils.ts#L4) + +## Type Parameters + +• **FunctionType** *extends* `Function` diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md new file mode 100644 index 0000000..e9597fb --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md @@ -0,0 +1,15 @@ +--- +title: RuntimeMethodIdMapping +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeMethodIdMapping + +# Type Alias: RuntimeMethodIdMapping + +> **RuntimeMethodIdMapping**: `Record`\<`` `${string}.${string}` ``, \{ `methodId`: `bigint`; `type`: [`RuntimeMethodInvocationType`](RuntimeMethodInvocationType.md); \}\> + +Defined in: [packages/protocol/src/model/RuntimeLike.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/RuntimeLike.ts#L3) diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md new file mode 100644 index 0000000..8f2c0e2 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md @@ -0,0 +1,15 @@ +--- +title: RuntimeMethodInvocationType +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeMethodInvocationType + +# Type Alias: RuntimeMethodInvocationType + +> **RuntimeMethodInvocationType**: `"INCOMING_MESSAGE"` \| `"SIGNATURE"` + +Defined in: [packages/protocol/src/model/RuntimeLike.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/RuntimeLike.ts#L1) diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md new file mode 100644 index 0000000..1fe6484 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md @@ -0,0 +1,15 @@ +--- +title: RuntimeProof +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeProof + +# Type Alias: RuntimeProof + +> **RuntimeProof**: `Proof`\<`void`, [`MethodPublicOutput`](../classes/MethodPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:133](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L133) diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md new file mode 100644 index 0000000..dd14728 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md @@ -0,0 +1,21 @@ +--- +title: SettlementContractConfig +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementContractConfig + +# Type Alias: SettlementContractConfig + +> **SettlementContractConfig**: `object` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L26) + +## Type declaration + +### escapeHatchSlotsInterval? + +> `optional` **escapeHatchSlotsInterval**: `number` diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md b/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md new file mode 100644 index 0000000..65630b3 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md @@ -0,0 +1,41 @@ +--- +title: SettlementHookInputs +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementHookInputs + +# Type Alias: SettlementHookInputs + +> **SettlementHookInputs**: `object` + +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L20) + +## Type declaration + +### blockProof + +> **blockProof**: [`InputBlockProof`](InputBlockProof.md) + +### contractState + +> **contractState**: [`SettlementStateRecord`](SettlementStateRecord.md) + +### currentL1BlockHeight + +> **currentL1BlockHeight**: `UInt32` + +### fromNetworkState + +> **fromNetworkState**: [`NetworkState`](../classes/NetworkState.md) + +### newPromisedMessagesHash + +> **newPromisedMessagesHash**: `Field` + +### toNetworkState + +> **toNetworkState**: [`NetworkState`](../classes/NetworkState.md) diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md new file mode 100644 index 0000000..40bcfc0 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md @@ -0,0 +1,15 @@ +--- +title: SettlementModulesRecord +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementModulesRecord + +# Type Alias: SettlementModulesRecord + +> **SettlementModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ContractModule`](../classes/ContractModule.md)\<`unknown`, `unknown`\>\>\> + +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L31) diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md b/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md new file mode 100644 index 0000000..29762c9 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md @@ -0,0 +1,37 @@ +--- +title: SettlementStateRecord +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementStateRecord + +# Type Alias: SettlementStateRecord + +> **SettlementStateRecord**: `object` + +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L11) + +## Type declaration + +### blockHashRoot + +> **blockHashRoot**: `Field` + +### lastSettlementL1BlockHeight + +> **lastSettlementL1BlockHeight**: `UInt32` + +### networkStateHash + +> **networkStateHash**: `Field` + +### sequencerKey + +> **sequencerKey**: `PublicKey` + +### stateRoot + +> **stateRoot**: `Field` diff --git a/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md b/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md new file mode 100644 index 0000000..fbe546d --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md @@ -0,0 +1,19 @@ +--- +title: SmartContractClassFromInterface +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SmartContractClassFromInterface + +# Type Alias: SmartContractClassFromInterface\ + +> **SmartContractClassFromInterface**\<`Type`\>: *typeof* `SmartContract` & [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`Type`\> + +Defined in: [packages/protocol/src/settlement/ContractModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/ContractModule.ts#L11) + +## Type Parameters + +• **Type** diff --git a/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md b/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md new file mode 100644 index 0000000..f0b675f --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md @@ -0,0 +1,15 @@ +--- +title: StateTransitionProof +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProof + +# Type Alias: StateTransitionProof + +> **StateTransitionProof**: `Proof`\<[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> + +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L20) diff --git a/src/pages/docs/reference/protocol/type-aliases/Subclass.md b/src/pages/docs/reference/protocol/type-aliases/Subclass.md new file mode 100644 index 0000000..bc2ef70 --- /dev/null +++ b/src/pages/docs/reference/protocol/type-aliases/Subclass.md @@ -0,0 +1,25 @@ +--- +title: Subclass +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Subclass + +# Type Alias: Subclass\ + +> **Subclass**\<`Class`\>: (...`args`) => `InstanceType`\<`Class`\> & `{ [Key in keyof Class]: Class[Key] }` & `object` + +Defined in: [packages/protocol/src/utils/utils.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/utils.ts#L10) + +## Type declaration + +### prototype + +> **prototype**: `InstanceType`\<`Class`\> + +## Type Parameters + +• **Class** *extends* (...`args`) => `any` diff --git a/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md b/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md new file mode 100644 index 0000000..0b98716 --- /dev/null +++ b/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md @@ -0,0 +1,15 @@ +--- +title: ACTIONS_EMPTY_HASH +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ACTIONS\_EMPTY\_HASH + +# Variable: ACTIONS\_EMPTY\_HASH + +> `const` **ACTIONS\_EMPTY\_HASH**: `Field` = `Reducer.initialActionState` + +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L38) diff --git a/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md b/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md new file mode 100644 index 0000000..b9e82d8 --- /dev/null +++ b/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md @@ -0,0 +1,15 @@ +--- +title: BATCH_SIGNATURE_PREFIX +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BATCH\_SIGNATURE\_PREFIX + +# Variable: BATCH\_SIGNATURE\_PREFIX + +> `const` **BATCH\_SIGNATURE\_PREFIX**: `Field` + +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L92) diff --git a/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md b/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md new file mode 100644 index 0000000..c480708 --- /dev/null +++ b/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md @@ -0,0 +1,29 @@ +--- +title: MINA_EVENT_PREFIXES +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MINA\_EVENT\_PREFIXES + +# Variable: MINA\_EVENT\_PREFIXES + +> `const` **MINA\_EVENT\_PREFIXES**: `object` + +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L14) + +## Type declaration + +### event + +> `readonly` **event**: `"MinaZkappEvent******"` = `"MinaZkappEvent******"` + +### events + +> `readonly` **events**: `"MinaZkappEvents*****"` = `"MinaZkappEvents*****"` + +### sequenceEvents + +> `readonly` **sequenceEvents**: `"MinaZkappSeqEvents**"` = `"MinaZkappSeqEvents**"` diff --git a/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md b/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md new file mode 100644 index 0000000..bd54ab8 --- /dev/null +++ b/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md @@ -0,0 +1,15 @@ +--- +title: OUTGOING_MESSAGE_BATCH_SIZE +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / OUTGOING\_MESSAGE\_BATCH\_SIZE + +# Variable: OUTGOING\_MESSAGE\_BATCH\_SIZE + +> `const` **OUTGOING\_MESSAGE\_BATCH\_SIZE**: `1` = `1` + +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L6) diff --git a/src/pages/docs/reference/protocol/variables/ProtocolConstants.md b/src/pages/docs/reference/protocol/variables/ProtocolConstants.md new file mode 100644 index 0000000..1b5f459 --- /dev/null +++ b/src/pages/docs/reference/protocol/variables/ProtocolConstants.md @@ -0,0 +1,21 @@ +--- +title: ProtocolConstants +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProtocolConstants + +# Variable: ProtocolConstants + +> `const` **ProtocolConstants**: `object` + +Defined in: [packages/protocol/src/Constants.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/Constants.ts#L1) + +## Type declaration + +### stateTransitionProverBatchSize + +> **stateTransitionProverBatchSize**: `number` = `4` diff --git a/src/pages/docs/reference/protocol/variables/treeFeeHeight.md b/src/pages/docs/reference/protocol/variables/treeFeeHeight.md new file mode 100644 index 0000000..28fc9b6 --- /dev/null +++ b/src/pages/docs/reference/protocol/variables/treeFeeHeight.md @@ -0,0 +1,15 @@ +--- +title: treeFeeHeight +--- + +[**@proto-kit/protocol**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / treeFeeHeight + +# Variable: treeFeeHeight + +> `const` **treeFeeHeight**: `10` = `10` + +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L4) diff --git a/src/pages/docs/reference/sdk/README.md b/src/pages/docs/reference/sdk/README.md new file mode 100644 index 0000000..6056565 --- /dev/null +++ b/src/pages/docs/reference/sdk/README.md @@ -0,0 +1,57 @@ +--- +title: "@proto-kit/sdk" +--- + +**@proto-kit/sdk** + +*** + +[Documentation](../../README.md) / @proto-kit/sdk + +# YAB: SDK + +SDK for developing privacy enabled application chains. + +To use an appchain, you should use the following syntax as provided by this example: + +```typescript +const appChain = AppChain.from({ + sequencer: Sequencer.from({ + graphql: GraphQLServerModule, + }), + + runtime: Runtime.from({ + runtimeModules: { + admin: Admin, + }, + + state: new InMemoryStateService(), + }), +}); + +appChain.configure({ + sequencer: { + graphql: { + port: 8080, + }, + }, + + runtime: { + admin: { + publicKey: "123", + }, + }, +}); + +await appChain.start(); +``` + +The AppChain takes two arguments, a Runtime and a Sequencer. + +1. The Runtime holds all modules that have provable code. + In a nutshell, all "smart contract" logic that a developer wants to create for their rollup. + For more documentation on Runtime, please refer to @protokit/module + +2. The Sequencer definition. + A sequencer is responsible for all services that interact with the Runtime, but are not provable code itself. + That could be a GraphQL interface, P2P networking layer, database layer, ... diff --git a/src/pages/docs/reference/sdk/_meta.tsx b/src/pages/docs/reference/sdk/_meta.tsx new file mode 100644 index 0000000..c639525 --- /dev/null +++ b/src/pages/docs/reference/sdk/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/sdk/classes/AppChain.md b/src/pages/docs/reference/sdk/classes/AppChain.md new file mode 100644 index 0000000..3b0e304 --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/AppChain.md @@ -0,0 +1,754 @@ +--- +title: AppChain +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChain + +# Class: AppChain\ + +Defined in: [sdk/src/appChain/AppChain.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L112) + +AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer + +## Extends + +- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +## Extended by + +- [`TestingAppChain`](TestingAppChain.md) +- [`ClientAppChain`](ClientAppChain.md) + +## Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) + +## Constructors + +### new AppChain() + +> **new AppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L151) + +#### Parameters + +##### definition + +[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Returns + +[`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) + +*** + +### definition + +> **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L144) + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) + +*** + +### protocol + +#### Get Signature + +> **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L215) + +##### Returns + +[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> + +*** + +### query + +#### Get Signature + +> **get** **query**(): `object` + +Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L176) + +##### Returns + +`object` + +###### network + +> **network**: [`NetworkStateQuery`](../../sequencer/classes/NetworkStateQuery.md) + +###### protocol + +> **protocol**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`ProtocolModule`](../../protocol/classes/ProtocolModule.md)\<`unknown`\>, `ProtocolModules`\> + +###### runtime + +> **runtime**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`RuntimeModule`](../../module/classes/RuntimeModule.md)\<`unknown`\>, `RuntimeModules`\> + +*** + +### runtime + +#### Get Signature + +> **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L207) + +##### Returns + +[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> + +*** + +### sequencer + +#### Get Signature + +> **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L211) + +##### Returns + +[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf>` + +Defined in: common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf>` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L352) + +#### Returns + +`Promise`\<`void`\> + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:160 + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) + +*** + +### decorateModule() + +> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:134 + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +##### containedModule + +`InstanceType`\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\]\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>[] + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf>` + +Defined in: common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf>` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> + +Defined in: common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) + +*** + +### start() + +> **start**(`proofsEnabled`, `dependencyContainer`): `Promise`\<`void`\> + +Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L309) + +Starts the appchain and cross-registers runtime to sequencer + +#### Parameters + +##### proofsEnabled + +`boolean` = `false` + +##### dependencyContainer + +`DependencyContainer` = `container` + +#### Returns + +`Promise`\<`void`\> + +*** + +### transaction() + +> **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> + +Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L219) + +#### Parameters + +##### sender + +`PublicKey` + +##### callback + +() => `Promise`\<`void`\> + +##### options? + +###### nonce + +`number` + +#### Returns + +`Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L127) + +#### Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) + +#### Parameters + +##### definition + +[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Returns + +[`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> diff --git a/src/pages/docs/reference/sdk/classes/AppChainModule.md b/src/pages/docs/reference/sdk/classes/AppChainModule.md new file mode 100644 index 0000000..bebdbbf --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/AppChainModule.md @@ -0,0 +1,137 @@ +--- +title: AppChainModule +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChainModule + +# Class: AppChainModule\ + +Defined in: [sdk/src/appChain/AppChainModule.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L13) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> + +## Extended by + +- [`StateServiceQueryModule`](StateServiceQueryModule.md) +- [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md) +- [`InMemorySigner`](InMemorySigner.md) +- [`TransactionSender`](../interfaces/TransactionSender.md) +- [`InMemoryTransactionSender`](InMemoryTransactionSender.md) +- [`AuroSigner`](AuroSigner.md) +- [`GraphqlClient`](GraphqlClient.md) +- [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md) +- [`GraphqlTransactionSender`](GraphqlTransactionSender.md) +- [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +## Constructors + +### new AppChainModule() + +> **new AppChainModule**\<`Config`\>(): [`AppChainModule`](AppChainModule.md)\<`Config`\> + +#### Returns + +[`AppChainModule`](AppChainModule.md)\<`Config`\> + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) diff --git a/src/pages/docs/reference/sdk/classes/AppChainTransaction.md b/src/pages/docs/reference/sdk/classes/AppChainTransaction.md new file mode 100644 index 0000000..d9bc930 --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/AppChainTransaction.md @@ -0,0 +1,137 @@ +--- +title: AppChainTransaction +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChainTransaction + +# Class: AppChainTransaction + +Defined in: [sdk/src/transaction/AppChainTransaction.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L6) + +## Constructors + +### new AppChainTransaction() + +> **new AppChainTransaction**(`signer`, `transactionSender`): [`AppChainTransaction`](AppChainTransaction.md) + +Defined in: [sdk/src/transaction/AppChainTransaction.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L9) + +#### Parameters + +##### signer + +[`Signer`](../interfaces/Signer.md) + +##### transactionSender + +[`TransactionSender`](../interfaces/TransactionSender.md) + +#### Returns + +[`AppChainTransaction`](AppChainTransaction.md) + +## Properties + +### signer + +> **signer**: [`Signer`](../interfaces/Signer.md) + +Defined in: [sdk/src/transaction/AppChainTransaction.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L10) + +*** + +### transaction? + +> `optional` **transaction**: [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) \| [`UnsignedTransaction`](../../sequencer/classes/UnsignedTransaction.md) + +Defined in: [sdk/src/transaction/AppChainTransaction.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L7) + +*** + +### transactionSender + +> **transactionSender**: [`TransactionSender`](../interfaces/TransactionSender.md) + +Defined in: [sdk/src/transaction/AppChainTransaction.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L11) + +## Methods + +### hasPendingTransaction() + +> **hasPendingTransaction**(`transaction`?): `asserts transaction is PendingTransaction` + +Defined in: [sdk/src/transaction/AppChainTransaction.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L27) + +#### Parameters + +##### transaction? + +[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) | [`UnsignedTransaction`](../../sequencer/classes/UnsignedTransaction.md) + +#### Returns + +`asserts transaction is PendingTransaction` + +*** + +### hasUnsignedTransaction() + +> **hasUnsignedTransaction**(`transaction`?): `asserts transaction is UnsignedTransaction` + +Defined in: [sdk/src/transaction/AppChainTransaction.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L18) + +#### Parameters + +##### transaction? + +[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) | [`UnsignedTransaction`](../../sequencer/classes/UnsignedTransaction.md) + +#### Returns + +`asserts transaction is UnsignedTransaction` + +*** + +### send() + +> **send**(): `Promise`\<`void`\> + +Defined in: [sdk/src/transaction/AppChainTransaction.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L48) + +#### Returns + +`Promise`\<`void`\> + +*** + +### sign() + +> **sign**(): `Promise`\<`void`\> + +Defined in: [sdk/src/transaction/AppChainTransaction.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L36) + +#### Returns + +`Promise`\<`void`\> + +*** + +### withUnsignedTransaction() + +> **withUnsignedTransaction**(`unsignedTransaction`): `void` + +Defined in: [sdk/src/transaction/AppChainTransaction.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L14) + +#### Parameters + +##### unsignedTransaction + +[`UnsignedTransaction`](../../sequencer/classes/UnsignedTransaction.md) + +#### Returns + +`void` diff --git a/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md b/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md new file mode 100644 index 0000000..1895f70 --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md @@ -0,0 +1,62 @@ +--- +title: AreProofsEnabledFactory +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AreProofsEnabledFactory + +# Class: AreProofsEnabledFactory + +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L21) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Implements + +- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) + +## Constructors + +### new AreProofsEnabledFactory() + +> **new AreProofsEnabledFactory**(): [`AreProofsEnabledFactory`](AreProofsEnabledFactory.md) + +#### Returns + +[`AreProofsEnabledFactory`](AreProofsEnabledFactory.md) + +## Methods + +### dependencies() + +> **dependencies**(): `object` + +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L22) + +#### Returns + +`object` + +##### areProofsEnabled + +> **areProofsEnabled**: `object` + +###### areProofsEnabled.useClass + +> **areProofsEnabled.useClass**: *typeof* [`InMemoryAreProofsEnabled`](InMemoryAreProofsEnabled.md) = `InMemoryAreProofsEnabled` + +#### Implementation of + +[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) diff --git a/src/pages/docs/reference/sdk/classes/AuroSigner.md b/src/pages/docs/reference/sdk/classes/AuroSigner.md new file mode 100644 index 0000000..6d087f5 --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/AuroSigner.md @@ -0,0 +1,154 @@ +--- +title: AuroSigner +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AuroSigner + +# Class: AuroSigner + +Defined in: [sdk/src/transaction/AuroSigner.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AuroSigner.ts#L9) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`AppChainModule`](AppChainModule.md)\<`unknown`\> + +## Implements + +- [`Signer`](../interfaces/Signer.md) + +## Constructors + +### new AuroSigner() + +> **new AuroSigner**(): [`AuroSigner`](AuroSigner.md) + +#### Returns + +[`AuroSigner`](AuroSigner.md) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) + +*** + +### currentConfig + +> `protected` **currentConfig**: `unknown` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) + +*** + +### sign() + +> **sign**(`message`): `Promise`\<`Signature`\> + +Defined in: [sdk/src/transaction/AuroSigner.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AuroSigner.ts#L10) + +#### Parameters + +##### message + +`Field`[] + +#### Returns + +`Promise`\<`Signature`\> + +#### Implementation of + +[`Signer`](../interfaces/Signer.md).[`sign`](../interfaces/Signer.md#sign) diff --git a/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md b/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md new file mode 100644 index 0000000..598bb7e --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md @@ -0,0 +1,191 @@ +--- +title: BlockStorageNetworkStateModule +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / BlockStorageNetworkStateModule + +# Class: BlockStorageNetworkStateModule + +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L17) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`AppChainModule`](AppChainModule.md)\<`Record`\<`string`, `never`\>\> + +## Implements + +- [`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md) + +## Constructors + +### new BlockStorageNetworkStateModule() + +> **new BlockStorageNetworkStateModule**(`sequencer`): [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md) + +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L21) + +#### Parameters + +##### sequencer + +[`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> + +#### Returns + +[`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md) + +#### Overrides + +[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Record`\<`string`, `never`\> + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) + +*** + +### getProvenNetworkState() + +> **getProvenNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L58) + +#### Returns + +`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +#### Implementation of + +[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getProvenNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getprovennetworkstate) + +*** + +### getStagedNetworkState() + +> **getStagedNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L53) + +Staged network state is the networkstate after the latest unproven block +with afterBundle() hooks executed + +#### Returns + +`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +#### Implementation of + +[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getStagedNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getstagednetworkstate) + +*** + +### getUnprovenNetworkState() + +> **getUnprovenNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L44) + +#### Returns + +`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +#### Implementation of + +[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getUnprovenNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getunprovennetworkstate) diff --git a/src/pages/docs/reference/sdk/classes/ClientAppChain.md b/src/pages/docs/reference/sdk/classes/ClientAppChain.md new file mode 100644 index 0000000..b7aa61b --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/ClientAppChain.md @@ -0,0 +1,799 @@ +--- +title: ClientAppChain +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / ClientAppChain + +# Class: ClientAppChain\ + +Defined in: [sdk/src/appChain/ClientAppChain.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/ClientAppChain.ts#L30) + +AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer + +## Extends + +- [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +## Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) + +## Constructors + +### new ClientAppChain() + +> **new ClientAppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`ClientAppChain`](ClientAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L151) + +#### Parameters + +##### definition + +[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Returns + +[`ClientAppChain`](ClientAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`constructor`](AppChain.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AppChain`](AppChain.md).[`currentConfig`](AppChain.md#currentconfig) + +*** + +### definition + +> **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L144) + +#### Inherited from + +[`AppChain`](AppChain.md).[`definition`](AppChain.md#definition-1) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`config`](AppChain.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`AppChain`](AppChain.md).[`container`](AppChain.md#container) + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`events`](AppChain.md#events) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`AppChain`](AppChain.md).[`moduleNames`](AppChain.md#modulenames) + +*** + +### protocol + +#### Get Signature + +> **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L215) + +##### Returns + +[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`protocol`](AppChain.md#protocol) + +*** + +### query + +#### Get Signature + +> **get** **query**(): `object` + +Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L176) + +##### Returns + +`object` + +###### network + +> **network**: [`NetworkStateQuery`](../../sequencer/classes/NetworkStateQuery.md) + +###### protocol + +> **protocol**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`ProtocolModule`](../../protocol/classes/ProtocolModule.md)\<`unknown`\>, `ProtocolModules`\> + +###### runtime + +> **runtime**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`RuntimeModule`](../../module/classes/RuntimeModule.md)\<`unknown`\>, `RuntimeModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`query`](AppChain.md#query) + +*** + +### runtime + +#### Get Signature + +> **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L207) + +##### Returns + +[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`runtime`](AppChain.md#runtime-1) + +*** + +### sequencer + +#### Get Signature + +> **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L211) + +##### Returns + +[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`sequencer`](AppChain.md#sequencer) + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`AppChain`](AppChain.md).[`assertContainerInitialized`](AppChain.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf>` + +Defined in: common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf>` + +#### Inherited from + +[`AppChain`](AppChain.md).[`assertIsValidModuleName`](AppChain.md#assertisvalidmodulename) + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L352) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`close`](AppChain.md#close) + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`configure`](AppChain.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`configurePartial`](AppChain.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:160 + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`create`](AppChain.md#create) + +*** + +### decorateModule() + +> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:134 + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +##### containedModule + +`InstanceType`\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\]\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`decorateModule`](AppChain.md#decoratemodule) + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>[] + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`initializeDependencyFactories`](AppChain.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf>` + +Defined in: common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf>` + +#### Inherited from + +[`AppChain`](AppChain.md).[`isValidModuleName`](AppChain.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`onAfterModuleResolution`](AppChain.md#onaftermoduleresolution) + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`registerAliases`](AppChain.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`registerClasses`](AppChain.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`registerModules`](AppChain.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`registerValue`](AppChain.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> + +Defined in: common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`resolve`](AppChain.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`AppChain`](AppChain.md).[`resolveOrFail`](AppChain.md#resolveorfail) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [sdk/src/appChain/ClientAppChain.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/ClientAppChain.ts#L108) + +Starts the appchain and cross-registers runtime to sequencer + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`AppChain`](AppChain.md).[`start`](AppChain.md#start) + +*** + +### transaction() + +> **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> + +Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L219) + +#### Parameters + +##### sender + +`PublicKey` + +##### callback + +() => `Promise`\<`void`\> + +##### options? + +###### nonce + +`number` + +#### Returns + +`Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`transaction`](AppChain.md#transaction) + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`validateModule`](AppChain.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L127) + +#### Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) + +#### Parameters + +##### definition + +[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Returns + +[`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`from`](AppChain.md#from) + +*** + +### fromRuntime() + +> `static` **fromRuntime**\<`RuntimeModules`, `SignerType`\>(`runtimeModules`, `signer`): [`ClientAppChain`](ClientAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{\}, \{ `GraphqlClient`: *typeof* [`GraphqlClient`](GraphqlClient.md); `NetworkStateTransportModule`: *typeof* [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md); `QueryTransportModule`: *typeof* [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md); `Signer`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`SignerType`\>; `TransactionSender`: *typeof* [`GraphqlTransactionSender`](GraphqlTransactionSender.md); \}\> + +Defined in: [sdk/src/appChain/ClientAppChain.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/ClientAppChain.ts#L42) + +#### Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +• **SignerType** *extends* [`Signer`](../interfaces/Signer.md) & [`AppChainModule`](AppChainModule.md)\<`unknown`\> + +#### Parameters + +##### runtimeModules + +`RuntimeModules` + +##### signer + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`SignerType`\> + +#### Returns + +[`ClientAppChain`](ClientAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{\}, \{ `GraphqlClient`: *typeof* [`GraphqlClient`](GraphqlClient.md); `NetworkStateTransportModule`: *typeof* [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md); `QueryTransportModule`: *typeof* [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md); `Signer`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`SignerType`\>; `TransactionSender`: *typeof* [`GraphqlTransactionSender`](GraphqlTransactionSender.md); \}\> diff --git a/src/pages/docs/reference/sdk/classes/GraphqlClient.md b/src/pages/docs/reference/sdk/classes/GraphqlClient.md new file mode 100644 index 0000000..7b967ea --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/GraphqlClient.md @@ -0,0 +1,142 @@ +--- +title: GraphqlClient +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / GraphqlClient + +# Class: GraphqlClient + +Defined in: [sdk/src/graphql/GraphqlClient.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlClient.ts#L9) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`AppChainModule`](AppChainModule.md)\<[`GraphqlClientConfig`](../interfaces/GraphqlClientConfig.md)\> + +## Constructors + +### new GraphqlClient() + +> **new GraphqlClient**(): [`GraphqlClient`](GraphqlClient.md) + +#### Returns + +[`GraphqlClient`](GraphqlClient.md) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`GraphqlClientConfig`](../interfaces/GraphqlClientConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) + +## Accessors + +### client + +#### Get Signature + +> **get** **client**(): `Client` + +Defined in: [sdk/src/graphql/GraphqlClient.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlClient.ts#L20) + +##### Returns + +`Client` + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) diff --git a/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md b/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md new file mode 100644 index 0000000..60165f6 --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md @@ -0,0 +1,188 @@ +--- +title: GraphqlNetworkStateTransportModule +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / GraphqlNetworkStateTransportModule + +# Class: GraphqlNetworkStateTransportModule + +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L20) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`AppChainModule`](AppChainModule.md)\<`Record`\<`string`, `never`\>\> + +## Implements + +- [`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md) + +## Constructors + +### new GraphqlNetworkStateTransportModule() + +> **new GraphqlNetworkStateTransportModule**(`graphqlClient`): [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md) + +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L24) + +#### Parameters + +##### graphqlClient + +[`GraphqlClient`](GraphqlClient.md) + +#### Returns + +[`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md) + +#### Overrides + +[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Record`\<`string`, `never`\> + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) + +*** + +### getProvenNetworkState() + +> **getProvenNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L71) + +#### Returns + +`Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> + +#### Implementation of + +[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getProvenNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getprovennetworkstate) + +*** + +### getStagedNetworkState() + +> **getStagedNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L75) + +#### Returns + +`Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> + +#### Implementation of + +[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getStagedNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getstagednetworkstate) + +*** + +### getUnprovenNetworkState() + +> **getUnprovenNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L79) + +#### Returns + +`Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> + +#### Implementation of + +[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getUnprovenNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getunprovennetworkstate) diff --git a/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md b/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md new file mode 100644 index 0000000..f04f83e --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md @@ -0,0 +1,184 @@ +--- +title: GraphqlQueryTransportModule +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / GraphqlQueryTransportModule + +# Class: GraphqlQueryTransportModule + +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L30) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`AppChainModule`](AppChainModule.md) + +## Implements + +- [`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md) + +## Constructors + +### new GraphqlQueryTransportModule() + +> **new GraphqlQueryTransportModule**(`graphqlClient`): [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md) + +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L34) + +#### Parameters + +##### graphqlClient + +[`GraphqlClient`](GraphqlClient.md) + +#### Returns + +[`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md) + +#### Overrides + +[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) + +*** + +### get() + +> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> + +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L40) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| `Field`[]\> + +#### Implementation of + +[`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md).[`get`](../../sequencer/interfaces/QueryTransportModule.md#get) + +*** + +### merkleWitness() + +> **merkleWitness**(`key`): `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> + +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L65) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> + +#### Implementation of + +[`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md).[`merkleWitness`](../../sequencer/interfaces/QueryTransportModule.md#merklewitness) diff --git a/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md b/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md new file mode 100644 index 0000000..bbd9a1f --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md @@ -0,0 +1,178 @@ +--- +title: GraphqlTransactionSender +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / GraphqlTransactionSender + +# Class: GraphqlTransactionSender + +Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L11) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`AppChainModule`](AppChainModule.md) + +## Implements + +- [`TransactionSender`](../interfaces/TransactionSender.md) + +## Constructors + +### new GraphqlTransactionSender() + +> **new GraphqlTransactionSender**(`graphqlClient`): [`GraphqlTransactionSender`](GraphqlTransactionSender.md) + +Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L15) + +#### Parameters + +##### graphqlClient + +[`GraphqlClient`](GraphqlClient.md) + +#### Returns + +[`GraphqlTransactionSender`](GraphqlTransactionSender.md) + +#### Overrides + +[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +#### Implementation of + +[`TransactionSender`](../interfaces/TransactionSender.md).[`appChain`](../interfaces/TransactionSender.md#appchain) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Implementation of + +[`TransactionSender`](../interfaces/TransactionSender.md).[`currentConfig`](../interfaces/TransactionSender.md#currentconfig) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Implementation of + +[`TransactionSender`](../interfaces/TransactionSender.md).[`config`](../interfaces/TransactionSender.md#config) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Implementation of + +[`TransactionSender`](../interfaces/TransactionSender.md).[`create`](../interfaces/TransactionSender.md#create) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) + +*** + +### send() + +> **send**(`transaction`): `Promise`\<`void`\> + +Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L21) + +#### Parameters + +##### transaction + +[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`TransactionSender`](../interfaces/TransactionSender.md).[`send`](../interfaces/TransactionSender.md#send) diff --git a/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md b/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md new file mode 100644 index 0000000..b4bdd05 --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md @@ -0,0 +1,67 @@ +--- +title: InMemoryAreProofsEnabled +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / InMemoryAreProofsEnabled + +# Class: InMemoryAreProofsEnabled + +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L9) + +## Implements + +- [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +## Constructors + +### new InMemoryAreProofsEnabled() + +> **new InMemoryAreProofsEnabled**(): [`InMemoryAreProofsEnabled`](InMemoryAreProofsEnabled.md) + +#### Returns + +[`InMemoryAreProofsEnabled`](InMemoryAreProofsEnabled.md) + +## Accessors + +### areProofsEnabled + +#### Get Signature + +> **get** **areProofsEnabled**(): `boolean` + +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L12) + +##### Returns + +`boolean` + +#### Implementation of + +[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md).[`areProofsEnabled`](../../common/interfaces/AreProofsEnabled.md#areproofsenabled) + +## Methods + +### setProofsEnabled() + +> **setProofsEnabled**(`areProofsEnabled`): `void` + +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L16) + +#### Parameters + +##### areProofsEnabled + +`boolean` + +#### Returns + +`void` + +#### Implementation of + +[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md).[`setProofsEnabled`](../../common/interfaces/AreProofsEnabled.md#setproofsenabled) diff --git a/src/pages/docs/reference/sdk/classes/InMemorySigner.md b/src/pages/docs/reference/sdk/classes/InMemorySigner.md new file mode 100644 index 0000000..4fae6c3 --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/InMemorySigner.md @@ -0,0 +1,156 @@ +--- +title: InMemorySigner +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / InMemorySigner + +# Class: InMemorySigner + +Defined in: [sdk/src/transaction/InMemorySigner.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L15) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`AppChainModule`](AppChainModule.md)\<[`InMemorySignerConfig`](../interfaces/InMemorySignerConfig.md)\> + +## Implements + +- [`Signer`](../interfaces/Signer.md) + +## Constructors + +### new InMemorySigner() + +> **new InMemorySigner**(): [`InMemorySigner`](InMemorySigner.md) + +Defined in: [sdk/src/transaction/InMemorySigner.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L19) + +#### Returns + +[`InMemorySigner`](InMemorySigner.md) + +#### Overrides + +[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`InMemorySignerConfig`](../interfaces/InMemorySignerConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) + +*** + +### sign() + +> **sign**(`signatureData`): `Promise`\<`Signature`\> + +Defined in: [sdk/src/transaction/InMemorySigner.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L23) + +#### Parameters + +##### signatureData + +`Field`[] + +#### Returns + +`Promise`\<`Signature`\> + +#### Implementation of + +[`Signer`](../interfaces/Signer.md).[`sign`](../interfaces/Signer.md#sign) diff --git a/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md b/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md new file mode 100644 index 0000000..8aef76c --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md @@ -0,0 +1,194 @@ +--- +title: InMemoryTransactionSender +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / InMemoryTransactionSender + +# Class: InMemoryTransactionSender + +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L16) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`AppChainModule`](AppChainModule.md) + +## Implements + +- [`TransactionSender`](../interfaces/TransactionSender.md) + +## Constructors + +### new InMemoryTransactionSender() + +> **new InMemoryTransactionSender**(`sequencer`): [`InMemoryTransactionSender`](InMemoryTransactionSender.md) + +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L22) + +#### Parameters + +##### sequencer + +[`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> + +#### Returns + +[`InMemoryTransactionSender`](InMemoryTransactionSender.md) + +#### Overrides + +[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +#### Implementation of + +[`TransactionSender`](../interfaces/TransactionSender.md).[`appChain`](../interfaces/TransactionSender.md#appchain) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Implementation of + +[`TransactionSender`](../interfaces/TransactionSender.md).[`currentConfig`](../interfaces/TransactionSender.md#currentconfig) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) + +*** + +### mempool + +> **mempool**: [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md) + +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L20) + +*** + +### sequencer + +> **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> + +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L23) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Implementation of + +[`TransactionSender`](../interfaces/TransactionSender.md).[`config`](../interfaces/TransactionSender.md#config) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Implementation of + +[`TransactionSender`](../interfaces/TransactionSender.md).[`create`](../interfaces/TransactionSender.md#create) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) + +*** + +### send() + +> **send**(`transaction`): `Promise`\<`void`\> + +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L30) + +#### Parameters + +##### transaction + +[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`TransactionSender`](../interfaces/TransactionSender.md).[`send`](../interfaces/TransactionSender.md#send) diff --git a/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md b/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md new file mode 100644 index 0000000..f58568c --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md @@ -0,0 +1,54 @@ +--- +title: SharedDependencyFactory +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / SharedDependencyFactory + +# Class: SharedDependencyFactory + +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/SharedDependencyFactory.ts#L14) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Implements + +- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) + +## Constructors + +### new SharedDependencyFactory() + +> **new SharedDependencyFactory**(): [`SharedDependencyFactory`](SharedDependencyFactory.md) + +#### Returns + +[`SharedDependencyFactory`](SharedDependencyFactory.md) + +## Methods + +### dependencies() + +> **dependencies**(): [`SharedDependencyRecord`](../interfaces/SharedDependencyRecord.md) + +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/SharedDependencyFactory.ts#L15) + +#### Returns + +[`SharedDependencyRecord`](../interfaces/SharedDependencyRecord.md) + +#### Implementation of + +[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) diff --git a/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md b/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md new file mode 100644 index 0000000..d7a7638 --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md @@ -0,0 +1,220 @@ +--- +title: StateServiceQueryModule +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / StateServiceQueryModule + +# Class: StateServiceQueryModule + +Defined in: [sdk/src/query/StateServiceQueryModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L16) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`AppChainModule`](AppChainModule.md) + +## Implements + +- [`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md) + +## Constructors + +### new StateServiceQueryModule() + +> **new StateServiceQueryModule**(`sequencer`): [`StateServiceQueryModule`](StateServiceQueryModule.md) + +Defined in: [sdk/src/query/StateServiceQueryModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L20) + +#### Parameters + +##### sequencer + +[`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> + +#### Returns + +[`StateServiceQueryModule`](StateServiceQueryModule.md) + +#### Overrides + +[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) + +*** + +### sequencer + +> **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> + +Defined in: [sdk/src/query/StateServiceQueryModule.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L21) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) + +## Accessors + +### asyncStateService + +#### Get Signature + +> **get** **asyncStateService**(): [`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md) + +Defined in: [sdk/src/query/StateServiceQueryModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L26) + +##### Returns + +[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md) + +*** + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) + +*** + +### treeStore + +#### Get Signature + +> **get** **treeStore**(): [`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md) + +Defined in: [sdk/src/query/StateServiceQueryModule.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L32) + +##### Returns + +[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) + +*** + +### get() + +> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> + +Defined in: [sdk/src/query/StateServiceQueryModule.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L36) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| `Field`[]\> + +#### Implementation of + +[`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md).[`get`](../../sequencer/interfaces/QueryTransportModule.md#get) + +*** + +### merkleWitness() + +> **merkleWitness**(`path`): `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> + +Defined in: [sdk/src/query/StateServiceQueryModule.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L40) + +#### Parameters + +##### path + +`Field` + +#### Returns + +`Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> + +#### Implementation of + +[`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md).[`merkleWitness`](../../sequencer/interfaces/QueryTransportModule.md#merklewitness) diff --git a/src/pages/docs/reference/sdk/classes/TestingAppChain.md b/src/pages/docs/reference/sdk/classes/TestingAppChain.md new file mode 100644 index 0000000..f48515b --- /dev/null +++ b/src/pages/docs/reference/sdk/classes/TestingAppChain.md @@ -0,0 +1,845 @@ +--- +title: TestingAppChain +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / TestingAppChain + +# Class: TestingAppChain\ + +Defined in: [sdk/src/appChain/TestingAppChain.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L58) + +AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer + +## Extends + +- [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +## Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) & [`VanillaRuntimeModulesRecord`](../../library/type-aliases/VanillaRuntimeModulesRecord.md) + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) + +## Constructors + +### new TestingAppChain() + +> **new TestingAppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`TestingAppChain`](TestingAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L151) + +#### Parameters + +##### definition + +[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Returns + +[`TestingAppChain`](TestingAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`constructor`](AppChain.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AppChain`](AppChain.md).[`currentConfig`](AppChain.md#currentconfig) + +*** + +### definition + +> **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L144) + +#### Inherited from + +[`AppChain`](AppChain.md).[`definition`](AppChain.md#definition-1) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`config`](AppChain.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`AppChain`](AppChain.md).[`container`](AppChain.md#container) + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`events`](AppChain.md#events) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`AppChain`](AppChain.md).[`moduleNames`](AppChain.md#modulenames) + +*** + +### protocol + +#### Get Signature + +> **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L215) + +##### Returns + +[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`protocol`](AppChain.md#protocol) + +*** + +### query + +#### Get Signature + +> **get** **query**(): `object` + +Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L176) + +##### Returns + +`object` + +###### network + +> **network**: [`NetworkStateQuery`](../../sequencer/classes/NetworkStateQuery.md) + +###### protocol + +> **protocol**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`ProtocolModule`](../../protocol/classes/ProtocolModule.md)\<`unknown`\>, `ProtocolModules`\> + +###### runtime + +> **runtime**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`RuntimeModule`](../../module/classes/RuntimeModule.md)\<`unknown`\>, `RuntimeModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`query`](AppChain.md#query) + +*** + +### runtime + +#### Get Signature + +> **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L207) + +##### Returns + +[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`runtime`](AppChain.md#runtime-1) + +*** + +### sequencer + +#### Get Signature + +> **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L211) + +##### Returns + +[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`sequencer`](AppChain.md#sequencer) + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`AppChain`](AppChain.md).[`assertContainerInitialized`](AppChain.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf>` + +Defined in: common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf>` + +#### Inherited from + +[`AppChain`](AppChain.md).[`assertIsValidModuleName`](AppChain.md#assertisvalidmodulename) + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L352) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`close`](AppChain.md#close) + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`configure`](AppChain.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`configurePartial`](AppChain.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:160 + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`create`](AppChain.md#create) + +*** + +### decorateModule() + +> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:134 + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +##### containedModule + +`InstanceType`\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\]\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`decorateModule`](AppChain.md#decoratemodule) + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>[] + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`initializeDependencyFactories`](AppChain.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf>` + +Defined in: common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf>` + +#### Inherited from + +[`AppChain`](AppChain.md).[`isValidModuleName`](AppChain.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`onAfterModuleResolution`](AppChain.md#onaftermoduleresolution) + +*** + +### produceBlock() + +> **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> + +Defined in: [sdk/src/appChain/TestingAppChain.ts:135](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L135) + +#### Returns + +`Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> + +*** + +### produceBlockWithResult() + +> **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> + +Defined in: [sdk/src/appChain/TestingAppChain.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L144) + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`registerAliases`](AppChain.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`registerClasses`](AppChain.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`registerModules`](AppChain.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`registerValue`](AppChain.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> + +Defined in: common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`resolve`](AppChain.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`AppChain`](AppChain.md).[`resolveOrFail`](AppChain.md#resolveorfail) + +*** + +### setSigner() + +> **setSigner**(`signer`): `void` + +Defined in: [sdk/src/appChain/TestingAppChain.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L130) + +#### Parameters + +##### signer + +`PrivateKey` + +#### Returns + +`void` + +*** + +### start() + +> **start**(`proofsEnabled`, `dependencyContainer`): `Promise`\<`void`\> + +Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L309) + +Starts the appchain and cross-registers runtime to sequencer + +#### Parameters + +##### proofsEnabled + +`boolean` = `false` + +##### dependencyContainer + +`DependencyContainer` = `container` + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`start`](AppChain.md#start) + +*** + +### transaction() + +> **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> + +Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L219) + +#### Parameters + +##### sender + +`PublicKey` + +##### callback + +() => `Promise`\<`void`\> + +##### options? + +###### nonce + +`number` + +#### Returns + +`Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`transaction`](AppChain.md#transaction) + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`AppChain`](AppChain.md).[`validateModule`](AppChain.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L127) + +#### Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) + +#### Parameters + +##### definition + +[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Returns + +[`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +#### Inherited from + +[`AppChain`](AppChain.md).[`from`](AppChain.md#from) + +*** + +### fromRuntime() + +> `static` **fromRuntime**\<`RuntimeModules`\>(`runtimeModules`): [`TestingAppChain`](TestingAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](InMemoryTransactionSender.md); \}\> + +Defined in: [sdk/src/appChain/TestingAppChain.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L70) + +#### Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) & [`PartialVanillaRuntimeModulesRecord`](../type-aliases/PartialVanillaRuntimeModulesRecord.md) + +#### Parameters + +##### runtimeModules + +`RuntimeModules` + +#### Returns + +[`TestingAppChain`](TestingAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](InMemoryTransactionSender.md); \}\> diff --git a/src/pages/docs/reference/sdk/globals.md b/src/pages/docs/reference/sdk/globals.md new file mode 100644 index 0000000..be7f37e --- /dev/null +++ b/src/pages/docs/reference/sdk/globals.md @@ -0,0 +1,53 @@ +--- +title: "@proto-kit/sdk" +--- + +[**@proto-kit/sdk**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/sdk + +# @proto-kit/sdk + +## Classes + +- [AppChain](classes/AppChain.md) +- [AppChainModule](classes/AppChainModule.md) +- [AppChainTransaction](classes/AppChainTransaction.md) +- [AreProofsEnabledFactory](classes/AreProofsEnabledFactory.md) +- [AuroSigner](classes/AuroSigner.md) +- [BlockStorageNetworkStateModule](classes/BlockStorageNetworkStateModule.md) +- [ClientAppChain](classes/ClientAppChain.md) +- [GraphqlClient](classes/GraphqlClient.md) +- [GraphqlNetworkStateTransportModule](classes/GraphqlNetworkStateTransportModule.md) +- [GraphqlQueryTransportModule](classes/GraphqlQueryTransportModule.md) +- [GraphqlTransactionSender](classes/GraphqlTransactionSender.md) +- [InMemoryAreProofsEnabled](classes/InMemoryAreProofsEnabled.md) +- [InMemorySigner](classes/InMemorySigner.md) +- [InMemoryTransactionSender](classes/InMemoryTransactionSender.md) +- [SharedDependencyFactory](classes/SharedDependencyFactory.md) +- [StateServiceQueryModule](classes/StateServiceQueryModule.md) +- [TestingAppChain](classes/TestingAppChain.md) + +## Interfaces + +- [AppChainConfig](interfaces/AppChainConfig.md) +- [AppChainDefinition](interfaces/AppChainDefinition.md) +- [ExpandAppChainDefinition](interfaces/ExpandAppChainDefinition.md) +- [GraphqlClientConfig](interfaces/GraphqlClientConfig.md) +- [InMemorySignerConfig](interfaces/InMemorySignerConfig.md) +- [SharedDependencyRecord](interfaces/SharedDependencyRecord.md) +- [Signer](interfaces/Signer.md) +- [TransactionSender](interfaces/TransactionSender.md) + +## Type Aliases + +- [AppChainModulesRecord](type-aliases/AppChainModulesRecord.md) +- [ExpandAppChainModules](type-aliases/ExpandAppChainModules.md) +- [PartialVanillaRuntimeModulesRecord](type-aliases/PartialVanillaRuntimeModulesRecord.md) +- [TestingSequencerModulesRecord](type-aliases/TestingSequencerModulesRecord.md) + +## Variables + +- [randomFeeRecipient](variables/randomFeeRecipient.md) diff --git a/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md b/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md new file mode 100644 index 0000000..801e187 --- /dev/null +++ b/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md @@ -0,0 +1,57 @@ +--- +title: AppChainConfig +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChainConfig + +# Interface: AppChainConfig\ + +Defined in: [sdk/src/appChain/AppChain.ts:96](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L96) + +Definition of required arguments for AppChain + +## Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) + +## Properties + +### AppChain + +> **AppChain**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:106](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L106) + +*** + +### Protocol + +> **Protocol**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`ProtocolModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:104](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L104) + +*** + +### Runtime + +> **Runtime**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`RuntimeModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:103](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L103) + +*** + +### Sequencer + +> **Sequencer**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`SequencerModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L105) diff --git a/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md b/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md new file mode 100644 index 0000000..17b3cb9 --- /dev/null +++ b/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md @@ -0,0 +1,55 @@ +--- +title: AppChainDefinition +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChainDefinition + +# Interface: AppChainDefinition\ + +Defined in: [sdk/src/appChain/AppChain.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L53) + +## Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) + +## Properties + +### modules + +> **modules**: `AppChainModules` + +Defined in: [sdk/src/appChain/AppChain.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L63) + +*** + +### Protocol + +> **Protocol**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\>\> + +Defined in: [sdk/src/appChain/AppChain.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L61) + +*** + +### Runtime + +> **Runtime**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\>\> + +Defined in: [sdk/src/appChain/AppChain.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L60) + +*** + +### Sequencer + +> **Sequencer**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\>\> + +Defined in: [sdk/src/appChain/AppChain.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L62) diff --git a/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md b/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md new file mode 100644 index 0000000..f25d0af --- /dev/null +++ b/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md @@ -0,0 +1,31 @@ +--- +title: ExpandAppChainDefinition +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / ExpandAppChainDefinition + +# Interface: ExpandAppChainDefinition\ + +Defined in: [sdk/src/appChain/AppChain.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L78) + +## Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) + +## Properties + +### modules + +> **modules**: [`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> + +Defined in: [sdk/src/appChain/AppChain.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L85) diff --git a/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md b/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md new file mode 100644 index 0000000..ceea63d --- /dev/null +++ b/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md @@ -0,0 +1,21 @@ +--- +title: GraphqlClientConfig +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / GraphqlClientConfig + +# Interface: GraphqlClientConfig + +Defined in: [sdk/src/graphql/GraphqlClient.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlClient.ts#L5) + +## Properties + +### url + +> **url**: `string` + +Defined in: [sdk/src/graphql/GraphqlClient.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlClient.ts#L6) diff --git a/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md b/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md new file mode 100644 index 0000000..0ca779d --- /dev/null +++ b/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md @@ -0,0 +1,21 @@ +--- +title: InMemorySignerConfig +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / InMemorySignerConfig + +# Interface: InMemorySignerConfig + +Defined in: [sdk/src/transaction/InMemorySigner.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L10) + +## Properties + +### signer + +> **signer**: `PrivateKey` + +Defined in: [sdk/src/transaction/InMemorySigner.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L11) diff --git a/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md b/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md new file mode 100644 index 0000000..7d00a2f --- /dev/null +++ b/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md @@ -0,0 +1,37 @@ +--- +title: SharedDependencyRecord +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / SharedDependencyRecord + +# Interface: SharedDependencyRecord + +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/SharedDependencyFactory.ts#L9) + +## Extends + +- [`DependencyRecord`](../../common/type-aliases/DependencyRecord.md) + +## Indexable + +\[`key`: `string`\]: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<`unknown`\> & `object` + +## Properties + +### methodIdResolver + +> **methodIdResolver**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`MethodIdResolver`](../../module/classes/MethodIdResolver.md)\> + +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/SharedDependencyFactory.ts#L11) + +*** + +### stateServiceProvider + +> **stateServiceProvider**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md)\> + +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/SharedDependencyFactory.ts#L10) diff --git a/src/pages/docs/reference/sdk/interfaces/Signer.md b/src/pages/docs/reference/sdk/interfaces/Signer.md new file mode 100644 index 0000000..52e9140 --- /dev/null +++ b/src/pages/docs/reference/sdk/interfaces/Signer.md @@ -0,0 +1,31 @@ +--- +title: Signer +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / Signer + +# Interface: Signer + +Defined in: [sdk/src/transaction/InMemorySigner.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L6) + +## Properties + +### sign() + +> **sign**: (`signatureData`) => `Promise`\<`Signature`\> + +Defined in: [sdk/src/transaction/InMemorySigner.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L7) + +#### Parameters + +##### signatureData + +`Field`[] + +#### Returns + +`Promise`\<`Signature`\> diff --git a/src/pages/docs/reference/sdk/interfaces/TransactionSender.md b/src/pages/docs/reference/sdk/interfaces/TransactionSender.md new file mode 100644 index 0000000..71b2b9a --- /dev/null +++ b/src/pages/docs/reference/sdk/interfaces/TransactionSender.md @@ -0,0 +1,120 @@ +--- +title: TransactionSender +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / TransactionSender + +# Interface: TransactionSender + +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L11) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`AppChainModule`](../classes/AppChainModule.md)\<`unknown`\> + +## Properties + +### appChain? + +> `optional` **appChain**: [`AppChain`](../classes/AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> + +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) + +#### Inherited from + +[`AppChainModule`](../classes/AppChainModule.md).[`appChain`](../classes/AppChainModule.md#appchain) + +*** + +### currentConfig + +> `protected` **currentConfig**: `unknown` + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AppChainModule`](../classes/AppChainModule.md).[`currentConfig`](../classes/AppChainModule.md#currentconfig) + +*** + +### send() + +> **send**: (`transaction`) => `Promise`\<`void`\> + +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L12) + +#### Parameters + +##### transaction + +[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) + +#### Returns + +`Promise`\<`void`\> + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](../classes/AppChainModule.md).[`config`](../classes/AppChainModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AppChainModule`](../classes/AppChainModule.md).[`create`](../classes/AppChainModule.md#create) diff --git a/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md new file mode 100644 index 0000000..f7941d2 --- /dev/null +++ b/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md @@ -0,0 +1,15 @@ +--- +title: AppChainModulesRecord +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChainModulesRecord + +# Type Alias: AppChainModulesRecord + +> **AppChainModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AppChainModule`](../classes/AppChainModule.md)\<`unknown`\>\>\> + +Defined in: [sdk/src/appChain/AppChain.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L49) diff --git a/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md b/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md new file mode 100644 index 0000000..1c8f3bd --- /dev/null +++ b/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md @@ -0,0 +1,39 @@ +--- +title: ExpandAppChainModules +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / ExpandAppChainModules + +# Type Alias: ExpandAppChainModules\ + +> **ExpandAppChainModules**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>: `AppChainModules` & `object` + +Defined in: [sdk/src/appChain/AppChain.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L66) + +## Type declaration + +### Protocol + +> **Protocol**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\>\> + +### Runtime + +> **Runtime**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\>\> + +### Sequencer + +> **Sequencer**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\>\> + +## Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) + +• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) + +• **AppChainModules** *extends* [`AppChainModulesRecord`](AppChainModulesRecord.md) diff --git a/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md new file mode 100644 index 0000000..2b5c0ea --- /dev/null +++ b/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md @@ -0,0 +1,21 @@ +--- +title: PartialVanillaRuntimeModulesRecord +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / PartialVanillaRuntimeModulesRecord + +# Type Alias: PartialVanillaRuntimeModulesRecord + +> **PartialVanillaRuntimeModulesRecord**: `object` + +Defined in: [sdk/src/appChain/TestingAppChain.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L52) + +## Type declaration + +### Balances? + +> `optional` **Balances**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`MinimalBalances`](../../library/type-aliases/MinimalBalances.md)\> diff --git a/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md new file mode 100644 index 0000000..d173a2d --- /dev/null +++ b/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md @@ -0,0 +1,49 @@ +--- +title: TestingSequencerModulesRecord +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / TestingSequencerModulesRecord + +# Type Alias: TestingSequencerModulesRecord + +> **TestingSequencerModulesRecord**: `object` + +Defined in: [sdk/src/appChain/TestingAppChain.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L37) + +## Type declaration + +### BaseLayer + +> **BaseLayer**: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md) + +### BatchProducerModule + +> **BatchProducerModule**: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md) + +### BlockProducerModule + +> **BlockProducerModule**: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md) + +### BlockTrigger + +> **BlockTrigger**: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md) + +### Database + +> **Database**: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md) + +### LocalTaskWorkerModule + +> **LocalTaskWorkerModule**: *typeof* [`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md) + +### Mempool + +> **Mempool**: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md) + +### TaskQueue + +> **TaskQueue**: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md) diff --git a/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md b/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md new file mode 100644 index 0000000..bf83192 --- /dev/null +++ b/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md @@ -0,0 +1,15 @@ +--- +title: randomFeeRecipient +--- + +[**@proto-kit/sdk**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / randomFeeRecipient + +# Variable: randomFeeRecipient + +> `const` **randomFeeRecipient**: `string` + +Defined in: [sdk/src/appChain/TestingAppChain.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L56) diff --git a/src/pages/docs/reference/sequencer/README.md b/src/pages/docs/reference/sequencer/README.md new file mode 100644 index 0000000..a871b11 --- /dev/null +++ b/src/pages/docs/reference/sequencer/README.md @@ -0,0 +1,40 @@ +--- +title: "@proto-kit/sequencer" +--- + +**@proto-kit/sequencer** + +*** + +[Documentation](../../README.md) / @proto-kit/sequencer + +# YAB: Sequencer + +This package includes everything that is required to run a sequencer + +## Sequencer + +A Sequencer is structure similar to a Runtime. +It is given a list of SequencerModules, that are then dynamically instantiated and resolved by the Sequencer. +When calling `.start()` on a sequencer, the sequencer starts up all the modules and exposes the services provided by them. + +### Sequencer modules + +A Sequencer module is an abstract class that needs to be extended by any concrete sequencer module implementation(s). + +```typescript +export abstract class SequencerModule< + Config +> extends ConfigurableModule { + public abstract start(): Promise; + + // more properties +} +``` + +The generic type parameter `Config` refers to the configuration object a module consumes. +More on that below. + +The `start()` method is called by the sequencer when it gets started. +It returns a Promise that has to resolve after initialization, since it will block in the sequencer startup. +That means that you mustn't `await server.start()` for example. diff --git a/src/pages/docs/reference/sequencer/_meta.tsx b/src/pages/docs/reference/sequencer/_meta.tsx new file mode 100644 index 0000000..4d63940 --- /dev/null +++ b/src/pages/docs/reference/sequencer/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md b/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md new file mode 100644 index 0000000..e962497 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md @@ -0,0 +1,190 @@ +--- +title: AbstractTaskQueue +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / AbstractTaskQueue + +# Class: `abstract` AbstractTaskQueue\ + +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L5) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](SequencerModule.md)\<`Config`\> + +## Extended by + +- [`LocalTaskQueue`](LocalTaskQueue.md) +- [`BullQueue`](../../deployment/classes/BullQueue.md) + +## Type Parameters + +• **Config** + +## Constructors + +### new AbstractTaskQueue() + +> **new AbstractTaskQueue**\<`Config`\>(): [`AbstractTaskQueue`](AbstractTaskQueue.md)\<`Config`\> + +#### Returns + +[`AbstractTaskQueue`](AbstractTaskQueue.md)\<`Config`\> + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### queues + +> `protected` **queues**: `Record`\<`string`, [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> = `{}` + +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### closeQueues() + +> `protected` **closeQueues**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) + +#### Returns + +`Promise`\<`void`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### createOrGetQueue() + +> `protected` **createOrGetQueue**(`name`, `creator`): [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) + +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) + +#### Parameters + +##### name + +`string` + +##### creator + +(`name`) => [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) + +#### Returns + +[`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) + +*** + +### start() + +> `abstract` **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md b/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md new file mode 100644 index 0000000..3d49475 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md @@ -0,0 +1,59 @@ +--- +title: ArtifactRecordSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ArtifactRecordSerializer + +# Class: ArtifactRecordSerializer + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L10) + +## Constructors + +### new ArtifactRecordSerializer() + +> **new ArtifactRecordSerializer**(): [`ArtifactRecordSerializer`](ArtifactRecordSerializer.md) + +#### Returns + +[`ArtifactRecordSerializer`](ArtifactRecordSerializer.md) + +## Methods + +### fromJSON() + +> **fromJSON**(`json`): [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L27) + +#### Parameters + +##### json + +[`SerializedArtifactRecord`](../type-aliases/SerializedArtifactRecord.md) + +#### Returns + +[`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md) + +*** + +### toJSON() + +> **toJSON**(`input`): [`SerializedArtifactRecord`](../type-aliases/SerializedArtifactRecord.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L11) + +#### Parameters + +##### input + +[`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md) + +#### Returns + +[`SerializedArtifactRecord`](../type-aliases/SerializedArtifactRecord.md) diff --git a/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md b/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md new file mode 100644 index 0000000..867a1a6 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md @@ -0,0 +1,204 @@ +--- +title: BatchProducerModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BatchProducerModule + +# Class: BatchProducerModule + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L74) + +The BatchProducerModule has the resposiblity to oversee the block production +and combine all necessary parts for that to happen. The flow roughly follows +the following steps: + +1. BlockTrigger triggers and executes the startup function +2. + +## Extends + +- [`SequencerModule`](SequencerModule.md) + +## Constructors + +### new BatchProducerModule() + +> **new BatchProducerModule**(`asyncStateService`, `merkleStore`, `batchStorage`, `blockTreeStore`, `database`, `traceService`, `blockFlowService`, `blockProofSerializer`, `verificationKeyService`): [`BatchProducerModule`](BatchProducerModule.md) + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L77) + +#### Parameters + +##### asyncStateService + +[`AsyncStateService`](../interfaces/AsyncStateService.md) + +##### merkleStore + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) + +##### batchStorage + +[`BatchStorage`](../interfaces/BatchStorage.md) + +##### blockTreeStore + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) + +##### database + +[`Database`](../interfaces/Database.md) + +##### traceService + +[`TransactionTraceService`](TransactionTraceService.md) + +##### blockFlowService + +[`BlockTaskFlowService`](BlockTaskFlowService.md) + +##### blockProofSerializer + +[`BlockProofSerializer`](BlockProofSerializer.md) + +##### verificationKeyService + +`VerificationKeyService` + +#### Returns + +[`BatchProducerModule`](BatchProducerModule.md) + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### createBatch() + +> **createBatch**(`blocks`): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L108) + +Main function to call when wanting to create a new block based on the +transactions that are present in the mempool. This function should also +be the one called by BlockTriggers + +#### Parameters + +##### blocks + +[`BlockWithPreviousResult`](../interfaces/BlockWithPreviousResult.md)[] + +#### Returns + +`Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L132) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md b/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md new file mode 100644 index 0000000..331852b --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md @@ -0,0 +1,229 @@ +--- +title: BlockProducerModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockProducerModule + +# Class: BlockProducerModule + +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L39) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](SequencerModule.md)\<[`BlockConfig`](../interfaces/BlockConfig.md)\> + +## Constructors + +### new BlockProducerModule() + +> **new BlockProducerModule**(`mempool`, `messageStorage`, `unprovenStateService`, `unprovenMerkleStore`, `blockQueue`, `blockTreeStore`, `productionService`, `resultService`, `methodIdResolver`, `runtime`, `database`): [`BlockProducerModule`](BlockProducerModule.md) + +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L42) + +#### Parameters + +##### mempool + +[`Mempool`](../interfaces/Mempool.md) + +##### messageStorage + +[`MessageStorage`](../interfaces/MessageStorage.md) + +##### unprovenStateService + +[`AsyncStateService`](../interfaces/AsyncStateService.md) + +##### unprovenMerkleStore + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) + +##### blockQueue + +[`BlockQueue`](../interfaces/BlockQueue.md) + +##### blockTreeStore + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) + +##### productionService + +`BlockProductionService` + +##### resultService + +`BlockResultService` + +##### methodIdResolver + +[`MethodIdResolver`](../../module/classes/MethodIdResolver.md) + +##### runtime + +[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> + +##### database + +[`Database`](../interfaces/Database.md) + +#### Returns + +[`BlockProducerModule`](BlockProducerModule.md) + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`BlockConfig`](../interfaces/BlockConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### blockResultCompleteCheck() + +> **blockResultCompleteCheck**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:236](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L236) + +#### Returns + +`Promise`\<`void`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### generateMetadata() + +> **generateMetadata**(`block`): `Promise`\<[`BlockResult`](../interfaces/BlockResult.md)\> + +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:110](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L110) + +#### Parameters + +##### block + +[`Block`](../interfaces/Block.md) + +#### Returns + +`Promise`\<[`BlockResult`](../interfaces/BlockResult.md)\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:251](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L251) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) + +*** + +### tryProduceBlock() + +> **tryProduceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:128](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L128) + +#### Returns + +`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> diff --git a/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md b/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md new file mode 100644 index 0000000..64cd94c --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md @@ -0,0 +1,43 @@ +--- +title: BlockProofSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockProofSerializer + +# Class: BlockProofSerializer + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L13) + +## Constructors + +### new BlockProofSerializer() + +> **new BlockProofSerializer**(`protocol`): [`BlockProofSerializer`](BlockProofSerializer.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L19) + +#### Parameters + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> + +#### Returns + +[`BlockProofSerializer`](BlockProofSerializer.md) + +## Methods + +### getBlockProofSerializer() + +> **getBlockProofSerializer**(): [`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../../protocol/classes/BlockProverPublicOutput.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L24) + +#### Returns + +[`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../../protocol/classes/BlockProverPublicOutput.md)\> diff --git a/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md b/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md new file mode 100644 index 0000000..6162c01 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md @@ -0,0 +1,144 @@ +--- +title: BlockTaskFlowService +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockTaskFlowService + +# Class: BlockTaskFlowService + +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L56) + +We could rename this into BlockCreationStrategy and enable the injection of +different creation strategies. + +## Constructors + +### new BlockTaskFlowService() + +> **new BlockTaskFlowService**(`taskQueue`, `flowCreator`, `stateTransitionTask`, `stateTransitionReductionTask`, `runtimeProvingTask`, `transactionProvingTask`, `blockProvingTask`, `blockReductionTask`, `protocol`): [`BlockTaskFlowService`](BlockTaskFlowService.md) + +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L57) + +#### Parameters + +##### taskQueue + +[`TaskQueue`](../interfaces/TaskQueue.md) + +##### flowCreator + +[`FlowCreator`](FlowCreator.md) + +##### stateTransitionTask + +[`StateTransitionTask`](StateTransitionTask.md) + +##### stateTransitionReductionTask + +[`StateTransitionReductionTask`](StateTransitionReductionTask.md) + +##### runtimeProvingTask + +[`RuntimeProvingTask`](RuntimeProvingTask.md) + +##### transactionProvingTask + +[`TransactionProvingTask`](TransactionProvingTask.md) + +##### blockProvingTask + +[`NewBlockTask`](NewBlockTask.md) + +##### blockReductionTask + +`BlockReductionTask` + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> + +#### Returns + +[`BlockTaskFlowService`](BlockTaskFlowService.md) + +## Methods + +### executeFlow() + +> **executeFlow**(`blockTraces`, `batchId`): `Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> + +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:142](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L142) + +#### Parameters + +##### blockTraces + +[`BlockTrace`](../interfaces/BlockTrace.md)[] + +##### batchId + +`number` + +#### Returns + +`Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> + +*** + +### pushBlockPairing() + +> **pushBlockPairing**(`flow`, `blockReductionTask`, `index`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:93](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L93) + +#### Parameters + +##### flow + +[`Flow`](Flow.md)\<`BlockProductionFlowState`\> + +##### blockReductionTask + +[`ReductionTaskFlow`](ReductionTaskFlow.md)\<[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md), [`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> + +##### index + +`number` + +#### Returns + +`Promise`\<`void`\> + +*** + +### pushPairing() + +> **pushPairing**(`flow`, `transactionReductionTask`, `blockIndex`, `transactionIndex`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L70) + +#### Parameters + +##### flow + +[`Flow`](Flow.md)\<`BlockProductionFlowState`\> + +##### transactionReductionTask + +[`ReductionTaskFlow`](ReductionTaskFlow.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md), [`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> + +##### blockIndex + +`number` + +##### transactionIndex + +`number` + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md b/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md new file mode 100644 index 0000000..570dd47 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md @@ -0,0 +1,296 @@ +--- +title: BlockTriggerBase +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockTriggerBase + +# Class: BlockTriggerBase\ + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L35) + +A BlockTrigger is the primary method to start the production of a block and +all associated processes. + +## Extends + +- [`SequencerModule`](SequencerModule.md)\<`Config`\> + +## Extended by + +- [`ManualBlockTrigger`](ManualBlockTrigger.md) +- [`TimedBlockTrigger`](TimedBlockTrigger.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +• **Events** *extends* [`BlockEvents`](../type-aliases/BlockEvents.md) = [`BlockEvents`](../type-aliases/BlockEvents.md) + +## Implements + +- [`BlockTrigger`](../interfaces/BlockTrigger.md) +- [`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md)\<`Events`\> + +## Constructors + +### new BlockTriggerBase() + +> **new BlockTriggerBase**\<`Config`, `Events`\>(`blockProducerModule`, `batchProducerModule`, `settlementModule`, `blockQueue`, `batchQueue`, `settlementStorage`): [`BlockTriggerBase`](BlockTriggerBase.md)\<`Config`, `Events`\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L44) + +#### Parameters + +##### blockProducerModule + +[`BlockProducerModule`](BlockProducerModule.md) + +##### batchProducerModule + +`undefined` | [`BatchProducerModule`](BatchProducerModule.md) + +##### settlementModule + +`undefined` | [`SettlementModule`](SettlementModule.md) + +##### blockQueue + +[`BlockQueue`](../interfaces/BlockQueue.md) + +##### batchQueue + +[`BatchStorage`](../interfaces/BatchStorage.md) + +##### settlementStorage + +`undefined` | [`SettlementStorage`](../interfaces/SettlementStorage.md) + +#### Returns + +[`BlockTriggerBase`](BlockTriggerBase.md)\<`Config`, `Events`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### batchProducerModule + +> `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) + +*** + +### batchQueue + +> `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) + +*** + +### blockProducerModule + +> `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) + +*** + +### blockQueue + +> `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### events + +> `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<`Events`\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) + +#### Implementation of + +[`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md).[`events`](../../common/interfaces/EventEmittingComponent.md#events) + +*** + +### settlementModule + +> `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) + +*** + +### settlementStorage + +> `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### produceBatch() + +> `protected` **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) + +#### Returns + +`Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> + +*** + +### produceBlock() + +> `protected` **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) + +#### Returns + +`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +*** + +### produceBlockWithResult() + +> `protected` **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> + +*** + +### settle() + +> `protected` **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) + +#### Parameters + +##### batch + +[`SettleableBatch`](../interfaces/SettleableBatch.md) + +#### Returns + +`Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md new file mode 100644 index 0000000..7f0cfb2 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md @@ -0,0 +1,289 @@ +--- +title: CachedMerkleTreeStore +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / CachedMerkleTreeStore + +# Class: CachedMerkleTreeStore + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L14) + +## Extends + +- [`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md) + +## Implements + +- [`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) + +## Constructors + +### new CachedMerkleTreeStore() + +> **new CachedMerkleTreeStore**(`parent`): [`CachedMerkleTreeStore`](CachedMerkleTreeStore.md) + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L32) + +#### Parameters + +##### parent + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) + +#### Returns + +[`CachedMerkleTreeStore`](CachedMerkleTreeStore.md) + +#### Overrides + +[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`constructor`](../../common/classes/InMemoryMerkleTreeStorage.md#constructors) + +## Properties + +### nodes + +> `protected` **nodes**: `object` + +Defined in: packages/common/dist/trees/InMemoryMerkleTreeStorage.d.ts:3 + +#### Index Signature + +\[`key`: `number`\]: `object` + +#### Inherited from + +[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`nodes`](../../common/classes/InMemoryMerkleTreeStorage.md#nodes) + +## Methods + +### commit() + +> **commit**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L28) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`commit`](../interfaces/AsyncMerkleTreeStore.md#commit) + +*** + +### getNode() + +> **getNode**(`key`, `level`): `undefined` \| `bigint` + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L36) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +#### Returns + +`undefined` \| `bigint` + +#### Overrides + +[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`getNode`](../../common/classes/InMemoryMerkleTreeStorage.md#getnode) + +*** + +### getNodesAsync() + +> **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:148](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L148) + +#### Parameters + +##### nodes + +[`MerkleTreeNodeQuery`](../interfaces/MerkleTreeNodeQuery.md)[] + +#### Returns + +`Promise`\<(`undefined` \| `bigint`)[]\> + +#### Implementation of + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`getNodesAsync`](../interfaces/AsyncMerkleTreeStore.md#getnodesasync) + +*** + +### getWrittenNodes() + +> **getWrittenNodes**(): `object` + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L45) + +#### Returns + +`object` + +*** + +### mergeIntoParent() + +> **mergeIntoParent**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L112) + +#### Returns + +`Promise`\<`void`\> + +*** + +### openTransaction() + +> **openTransaction**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L24) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`openTransaction`](../interfaces/AsyncMerkleTreeStore.md#opentransaction) + +*** + +### preloadKey() + +> **preloadKey**(`index`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L108) + +#### Parameters + +##### index + +`bigint` + +#### Returns + +`Promise`\<`void`\> + +*** + +### preloadKeys() + +> **preloadKeys**(`keys`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L94) + +#### Parameters + +##### keys + +`bigint`[] + +#### Returns + +`Promise`\<`void`\> + +*** + +### resetWrittenNodes() + +> **resetWrittenNodes**(): `void` + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L53) + +#### Returns + +`void` + +*** + +### setNode() + +> **setNode**(`key`, `level`, `value`): `void` + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L40) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +##### value + +`bigint` + +#### Returns + +`void` + +#### Overrides + +[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`setNode`](../../common/classes/InMemoryMerkleTreeStorage.md#setnode) + +*** + +### setNodeAsync() + +> **setNodeAsync**(`key`, `level`, `value`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:140](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L140) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +##### value + +`bigint` + +#### Returns + +`Promise`\<`void`\> + +*** + +### writeNodes() + +> **writeNodes**(`nodes`): `void` + +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:176](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L176) + +#### Parameters + +##### nodes + +[`MerkleTreeNode`](../interfaces/MerkleTreeNode.md)[] + +#### Returns + +`void` + +#### Implementation of + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`writeNodes`](../interfaces/AsyncMerkleTreeStore.md#writenodes) diff --git a/src/pages/docs/reference/sequencer/classes/CachedStateService.md b/src/pages/docs/reference/sequencer/classes/CachedStateService.md new file mode 100644 index 0000000..ea6834d --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/CachedStateService.md @@ -0,0 +1,265 @@ +--- +title: CachedStateService +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / CachedStateService + +# Class: CachedStateService + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L12) + +This Interface should be implemented for services that store the state +in an external storage (like a DB). This can be used in conjunction with +CachedStateService to preload keys for In-Circuit usage. + +## Extends + +- [`InMemoryStateService`](../../module/classes/InMemoryStateService.md) + +## Implements + +- [`AsyncStateService`](../interfaces/AsyncStateService.md) +- [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) + +## Constructors + +### new CachedStateService() + +> **new CachedStateService**(`parent`): [`CachedStateService`](CachedStateService.md) + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L18) + +#### Parameters + +##### parent + +`undefined` | [`AsyncStateService`](../interfaces/AsyncStateService.md) + +#### Returns + +[`CachedStateService`](CachedStateService.md) + +#### Overrides + +[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`constructor`](../../module/classes/InMemoryStateService.md#constructors) + +## Properties + +### values + +> **values**: `Record`\<`string`, `null` \| `Field`[]\> + +Defined in: packages/module/dist/state/InMemoryStateService.d.ts:11 + +This mapping container null values if the specific entry has been deleted. +This is used by the CachedState service to keep track of deletions + +#### Inherited from + +[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`values`](../../module/classes/InMemoryStateService.md#values) + +## Methods + +### applyStateTransitions() + +> **applyStateTransitions**(`stateTransitions`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:99](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L99) + +#### Parameters + +##### stateTransitions + +[`StateTransition`](../../protocol/classes/StateTransition.md)\<`any`\>[] + +#### Returns + +`Promise`\<`void`\> + +*** + +### commit() + +> **commit**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L42) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`AsyncStateService`](../interfaces/AsyncStateService.md).[`commit`](../interfaces/AsyncStateService.md#commit) + +*** + +### get() + +> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L94) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| `Field`[]\> + +#### Implementation of + +[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`get`](../../protocol/interfaces/SimpleAsyncStateService.md#get) + +#### Overrides + +[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`get`](../../module/classes/InMemoryStateService.md#get) + +*** + +### getMany() + +> **getMany**(`keys`): `Promise`\<[`StateEntry`](../interfaces/StateEntry.md)[]\> + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L75) + +#### Parameters + +##### keys + +`Field`[] + +#### Returns + +`Promise`\<[`StateEntry`](../interfaces/StateEntry.md)[]\> + +#### Implementation of + +[`AsyncStateService`](../interfaces/AsyncStateService.md).[`getMany`](../interfaces/AsyncStateService.md#getmany) + +*** + +### mergeIntoParent() + +> **mergeIntoParent**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:118](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L118) + +Merges all caches set() operation into the parent and +resets this instance to the parent's state (by clearing the cache and +defaulting to the parent) + +#### Returns + +`Promise`\<`void`\> + +*** + +### openTransaction() + +> **openTransaction**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L48) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`AsyncStateService`](../interfaces/AsyncStateService.md).[`openTransaction`](../interfaces/AsyncStateService.md#opentransaction) + +*** + +### preloadKey() + +> **preloadKey**(`key`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L52) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`void`\> + +*** + +### preloadKeys() + +> **preloadKeys**(`keys`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L56) + +#### Parameters + +##### keys + +`Field`[] + +#### Returns + +`Promise`\<`void`\> + +*** + +### set() + +> **set**(`key`, `value`): `Promise`\<`void`\> + +Defined in: packages/module/dist/state/InMemoryStateService.d.ts:13 + +#### Parameters + +##### key + +`Field` + +##### value + +`undefined` | `Field`[] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`set`](../../protocol/interfaces/SimpleAsyncStateService.md#set) + +#### Inherited from + +[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`set`](../../module/classes/InMemoryStateService.md#set) + +*** + +### writeStates() + +> **writeStates**(`entries`): `void` + +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L38) + +#### Parameters + +##### entries + +[`StateEntry`](../interfaces/StateEntry.md)[] + +#### Returns + +`void` + +#### Implementation of + +[`AsyncStateService`](../interfaces/AsyncStateService.md).[`writeStates`](../interfaces/AsyncStateService.md#writestates) diff --git a/src/pages/docs/reference/sequencer/classes/CompressedSignature.md b/src/pages/docs/reference/sequencer/classes/CompressedSignature.md new file mode 100644 index 0000000..fdf9a67 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/CompressedSignature.md @@ -0,0 +1,84 @@ +--- +title: CompressedSignature +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / CompressedSignature + +# Class: CompressedSignature + +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L8) + +CompressedSignature compresses the s scalar of a Signature +(which is expanded to 256 Fields in snarkyjs) to a single string + +## Constructors + +### new CompressedSignature() + +> **new CompressedSignature**(`r`, `s`): [`CompressedSignature`](CompressedSignature.md) + +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L15) + +#### Parameters + +##### r + +`Field` + +##### s + +`string` + +#### Returns + +[`CompressedSignature`](CompressedSignature.md) + +## Properties + +### r + +> `readonly` **r**: `Field` + +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L16) + +*** + +### s + +> `readonly` **s**: `string` + +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L17) + +## Methods + +### toSignature() + +> **toSignature**(): `Signature` + +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L21) + +#### Returns + +`Signature` + +*** + +### fromSignature() + +> `static` **fromSignature**(`sig`): [`CompressedSignature`](CompressedSignature.md) + +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L10) + +#### Parameters + +##### sig + +`Signature` + +#### Returns + +[`CompressedSignature`](CompressedSignature.md) diff --git a/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md b/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md new file mode 100644 index 0000000..8027c3b --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md @@ -0,0 +1,147 @@ +--- +title: DatabasePruneModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / DatabasePruneModule + +# Class: DatabasePruneModule + +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/DatabasePruneModule.ts#L16) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](SequencerModule.md)\<[`DatabasePruneConfig`](../type-aliases/DatabasePruneConfig.md)\> + +## Constructors + +### new DatabasePruneModule() + +> **new DatabasePruneModule**(`database`): [`DatabasePruneModule`](DatabasePruneModule.md) + +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/DatabasePruneModule.ts#L17) + +#### Parameters + +##### database + +[`Database`](../interfaces/Database.md) + +#### Returns + +[`DatabasePruneModule`](DatabasePruneModule.md) + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`DatabasePruneConfig`](../type-aliases/DatabasePruneConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/DatabasePruneModule.ts#L21) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md b/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md new file mode 100644 index 0000000..94998ae --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md @@ -0,0 +1,59 @@ +--- +title: DecodedStateSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / DecodedStateSerializer + +# Class: DecodedStateSerializer + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L6) + +## Constructors + +### new DecodedStateSerializer() + +> **new DecodedStateSerializer**(): [`DecodedStateSerializer`](DecodedStateSerializer.md) + +#### Returns + +[`DecodedStateSerializer`](DecodedStateSerializer.md) + +## Methods + +### fromJSON() + +> `static` **fromJSON**(`json`): [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L7) + +#### Parameters + +##### json + +[`JSONEncodableState`](../type-aliases/JSONEncodableState.md) + +#### Returns + +[`TaskStateRecord`](../type-aliases/TaskStateRecord.md) + +*** + +### toJSON() + +> `static` **toJSON**(`input`): [`JSONEncodableState`](../type-aliases/JSONEncodableState.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L16) + +#### Parameters + +##### input + +[`TaskStateRecord`](../type-aliases/TaskStateRecord.md) + +#### Returns + +[`JSONEncodableState`](../type-aliases/JSONEncodableState.md) diff --git a/src/pages/docs/reference/sequencer/classes/DummyStateService.md b/src/pages/docs/reference/sequencer/classes/DummyStateService.md new file mode 100644 index 0000000..800bc7f --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/DummyStateService.md @@ -0,0 +1,75 @@ +--- +title: DummyStateService +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / DummyStateService + +# Class: DummyStateService + +Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/DummyStateService.ts#L5) + +## Implements + +- [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) + +## Constructors + +### new DummyStateService() + +> **new DummyStateService**(): [`DummyStateService`](DummyStateService.md) + +#### Returns + +[`DummyStateService`](DummyStateService.md) + +## Methods + +### get() + +> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> + +Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/DummyStateService.ts#L6) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| `Field`[]\> + +#### Implementation of + +[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`get`](../../protocol/interfaces/SimpleAsyncStateService.md#get) + +*** + +### set() + +> **set**(`key`, `value`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/DummyStateService.ts#L10) + +#### Parameters + +##### key + +`Field` + +##### value + +`undefined` | `Field`[] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`set`](../../protocol/interfaces/SimpleAsyncStateService.md#set) diff --git a/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md new file mode 100644 index 0000000..7261cec --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md @@ -0,0 +1,167 @@ +--- +title: DynamicProofTaskSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / DynamicProofTaskSerializer + +# Class: DynamicProofTaskSerializer\ + +Defined in: [packages/sequencer/src/helpers/utils.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L130) + +## Extends + +- `ProofTaskSerializerBase`\<`PublicInputType`, `PublicOutputType`\> + +## Type Parameters + +• **PublicInputType** + +• **PublicOutputType** + +## Implements + +- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> + +## Constructors + +### new DynamicProofTaskSerializer() + +> **new DynamicProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`DynamicProofTaskSerializer`](DynamicProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> + +Defined in: [packages/sequencer/src/helpers/utils.ts:134](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L134) + +#### Parameters + +##### proofClass + +[`Subclass`](../../protocol/type-aliases/Subclass.md)\<*typeof* `DynamicProof`\> + +#### Returns + +[`DynamicProofTaskSerializer`](DynamicProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> + +#### Overrides + +`ProofTaskSerializerBase.constructor` + +## Methods + +### fromJSON() + +> **fromJSON**(`json`): `Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> + +Defined in: [packages/sequencer/src/helpers/utils.ts:142](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L142) + +#### Parameters + +##### json + +`string` + +#### Returns + +`Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) + +*** + +### fromJSONProof() + +> **fromJSONProof**(`jsonProof`): `Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> + +Defined in: [packages/sequencer/src/helpers/utils.ts:149](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L149) + +#### Parameters + +##### jsonProof + +`JsonProof` + +#### Returns + +`Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> + +*** + +### getDummy() + +> `protected` **getDummy**\<`T`\>(`c`, `jsonProof`): `T` + +Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L41) + +#### Type Parameters + +• **T** *extends* `DynamicProof`\<`PublicInputType`, `PublicOutputType`\> \| `Proof`\<`PublicInputType`, `PublicOutputType`\> + +#### Parameters + +##### c + +[`TypedClass`](../type-aliases/TypedClass.md)\<`T`\> + +##### jsonProof + +`JsonProof` + +#### Returns + +`T` + +#### Inherited from + +`ProofTaskSerializerBase.getDummy` + +*** + +### toJSON() + +> **toJSON**(`proof`): `string` + +Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L65) + +#### Parameters + +##### proof + +`DynamicProof`\<`PublicInputType`, `PublicOutputType`\> | `Proof`\<`PublicInputType`, `PublicOutputType`\> + +#### Returns + +`string` + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) + +#### Inherited from + +`ProofTaskSerializerBase.toJSON` + +*** + +### toJSONProof() + +> **toJSONProof**(`proof`): `JsonProof` + +Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L73) + +#### Parameters + +##### proof + +`DynamicProof`\<`PublicInputType`, `PublicOutputType`\> | `Proof`\<`PublicInputType`, `PublicOutputType`\> + +#### Returns + +`JsonProof` + +#### Inherited from + +`ProofTaskSerializerBase.toJSONProof` diff --git a/src/pages/docs/reference/sequencer/classes/Flow.md b/src/pages/docs/reference/sequencer/classes/Flow.md new file mode 100644 index 0000000..e095e93 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/Flow.md @@ -0,0 +1,213 @@ +--- +title: Flow +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Flow + +# Class: Flow\ + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L20) + +## Type Parameters + +• **State** + +## Implements + +- [`Closeable`](../interfaces/Closeable.md) + +## Constructors + +### new Flow() + +> **new Flow**\<`State`\>(`queueImpl`, `flowId`, `state`): [`Flow`](Flow.md)\<`State`\> + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L42) + +#### Parameters + +##### queueImpl + +[`TaskQueue`](../interfaces/TaskQueue.md) + +##### flowId + +`string` + +##### state + +`State` + +#### Returns + +[`Flow`](Flow.md)\<`State`\> + +## Properties + +### flowId + +> `readonly` **flowId**: `string` + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L44) + +*** + +### state + +> **state**: `State` + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L45) + +*** + +### tasksInProgress + +> **tasksInProgress**: `number` = `0` + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L40) + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:166](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L166) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Closeable`](../interfaces/Closeable.md).[`close`](../interfaces/Closeable.md#close) + +*** + +### forEach() + +> **forEach**\<`Type`\>(`inputs`, `fun`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:145](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L145) + +#### Type Parameters + +• **Type** + +#### Parameters + +##### inputs + +`Type`[] + +##### fun + +(`input`, `index`, `array`) => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### pushTask() + +> **pushTask**\<`Input`, `Result`\>(`task`, `input`, `completed`?, `overrides`?): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:102](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L102) + +#### Type Parameters + +• **Input** + +• **Result** + +#### Parameters + +##### task + +[`Task`](../interfaces/Task.md)\<`Input`, `Result`\> + +##### input + +`Input` + +##### completed? + +`CompletedCallback`\<`Input`, `Result`\> + +##### overrides? + +###### taskName + +`string` + +#### Returns + +`Promise`\<`void`\> + +*** + +### reject() + +> **reject**(`error`): `void` + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L75) + +#### Parameters + +##### error + +`Error` + +#### Returns + +`void` + +*** + +### resolve() + +> **resolve**\<`Result`\>(`result`): `void` + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L68) + +#### Type Parameters + +• **Result** + +#### Parameters + +##### result + +`Result` + +#### Returns + +`void` + +*** + +### withFlow() + +> **withFlow**\<`Result`\>(`executor`): `Promise`\<`Result`\> + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:153](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L153) + +#### Type Parameters + +• **Result** + +#### Parameters + +##### executor + +(`resolve`, `reject`) => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`Result`\> diff --git a/src/pages/docs/reference/sequencer/classes/FlowCreator.md b/src/pages/docs/reference/sequencer/classes/FlowCreator.md new file mode 100644 index 0000000..b9514fe --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/FlowCreator.md @@ -0,0 +1,57 @@ +--- +title: FlowCreator +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / FlowCreator + +# Class: FlowCreator + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:178](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L178) + +## Constructors + +### new FlowCreator() + +> **new FlowCreator**(`queueImpl`): [`FlowCreator`](FlowCreator.md) + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:179](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L179) + +#### Parameters + +##### queueImpl + +[`TaskQueue`](../interfaces/TaskQueue.md) + +#### Returns + +[`FlowCreator`](FlowCreator.md) + +## Methods + +### createFlow() + +> **createFlow**\<`State`\>(`flowId`, `state`): [`Flow`](Flow.md)\<`State`\> + +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L183) + +#### Type Parameters + +• **State** + +#### Parameters + +##### flowId + +`string` + +##### state + +`State` + +#### Returns + +[`Flow`](Flow.md)\<`State`\> diff --git a/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md b/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md new file mode 100644 index 0000000..f521dc3 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md @@ -0,0 +1,121 @@ +--- +title: FlowTaskWorker +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / FlowTaskWorker + +# Class: FlowTaskWorker\ + +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L15) + +## Type Parameters + +• **Tasks** *extends* [`Task`](../interfaces/Task.md)\<`any`, `any`\>[] + +## Implements + +- [`Closeable`](../interfaces/Closeable.md) + +## Constructors + +### new FlowTaskWorker() + +> **new FlowTaskWorker**\<`Tasks`\>(`mq`, `tasks`): [`FlowTaskWorker`](FlowTaskWorker.md)\<`Tasks`\> + +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L22) + +#### Parameters + +##### mq + +[`TaskQueue`](../interfaces/TaskQueue.md) + +##### tasks + +`Tasks` + +#### Returns + +[`FlowTaskWorker`](FlowTaskWorker.md)\<`Tasks`\> + +## Properties + +### preparePromise? + +> `optional` **preparePromise**: `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L78) + +*** + +### prepareResolve()? + +> `optional` **prepareResolve**: () => `void` + +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L80) + +#### Returns + +`void` + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:165](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L165) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Closeable`](../interfaces/Closeable.md).[`close`](../interfaces/Closeable.md#close) + +*** + +### prepareTasks() + +> **prepareTasks**(`tasks`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L86) + +#### Parameters + +##### tasks + +[`Task`](../interfaces/Task.md)\<`unknown`, `unknown`\>[] + +#### Returns + +`Promise`\<`void`\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L112) + +#### Returns + +`Promise`\<`void`\> + +*** + +### waitForPrepared() + +> **waitForPrepared**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L82) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md new file mode 100644 index 0000000..d4c0f24 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md @@ -0,0 +1,103 @@ +--- +title: InMemoryAsyncMerkleTreeStore +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryAsyncMerkleTreeStore + +# Class: InMemoryAsyncMerkleTreeStore + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L9) + +## Implements + +- [`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) + +## Constructors + +### new InMemoryAsyncMerkleTreeStore() + +> **new InMemoryAsyncMerkleTreeStore**(): [`InMemoryAsyncMerkleTreeStore`](InMemoryAsyncMerkleTreeStore.md) + +#### Returns + +[`InMemoryAsyncMerkleTreeStore`](InMemoryAsyncMerkleTreeStore.md) + +## Methods + +### commit() + +> **commit**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L18) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`commit`](../interfaces/AsyncMerkleTreeStore.md#commit) + +*** + +### getNodesAsync() + +> **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L26) + +#### Parameters + +##### nodes + +[`MerkleTreeNodeQuery`](../interfaces/MerkleTreeNodeQuery.md)[] + +#### Returns + +`Promise`\<(`undefined` \| `bigint`)[]\> + +#### Implementation of + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`getNodesAsync`](../interfaces/AsyncMerkleTreeStore.md#getnodesasync) + +*** + +### openTransaction() + +> **openTransaction**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L22) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`openTransaction`](../interfaces/AsyncMerkleTreeStore.md#opentransaction) + +*** + +### writeNodes() + +> **writeNodes**(`nodes`): `void` + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L12) + +#### Parameters + +##### nodes + +[`MerkleTreeNode`](../interfaces/MerkleTreeNode.md)[] + +#### Returns + +`void` + +#### Implementation of + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`writeNodes`](../interfaces/AsyncMerkleTreeStore.md#writenodes) diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md new file mode 100644 index 0000000..37da454 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md @@ -0,0 +1,104 @@ +--- +title: InMemoryBatchStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryBatchStorage + +# Class: InMemoryBatchStorage + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L9) + +## Implements + +- [`BatchStorage`](../interfaces/BatchStorage.md) +- [`HistoricalBatchStorage`](../interfaces/HistoricalBatchStorage.md) + +## Constructors + +### new InMemoryBatchStorage() + +> **new InMemoryBatchStorage**(): [`InMemoryBatchStorage`](InMemoryBatchStorage.md) + +#### Returns + +[`InMemoryBatchStorage`](InMemoryBatchStorage.md) + +## Methods + +### getBatchAt() + +> **getBatchAt**(`height`): `Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L18) + +#### Parameters + +##### height + +`number` + +#### Returns + +`Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> + +#### Implementation of + +[`HistoricalBatchStorage`](../interfaces/HistoricalBatchStorage.md).[`getBatchAt`](../interfaces/HistoricalBatchStorage.md#getbatchat) + +*** + +### getCurrentBatchHeight() + +> **getCurrentBatchHeight**(): `Promise`\<`number`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L14) + +#### Returns + +`Promise`\<`number`\> + +#### Implementation of + +[`BatchStorage`](../interfaces/BatchStorage.md).[`getCurrentBatchHeight`](../interfaces/BatchStorage.md#getcurrentbatchheight) + +*** + +### getLatestBatch() + +> **getLatestBatch**(): `Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L27) + +#### Returns + +`Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> + +#### Implementation of + +[`BatchStorage`](../interfaces/BatchStorage.md).[`getLatestBatch`](../interfaces/BatchStorage.md#getlatestbatch) + +*** + +### pushBatch() + +> **pushBatch**(`batch`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L22) + +#### Parameters + +##### batch + +[`Batch`](../interfaces/Batch.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`BatchStorage`](../interfaces/BatchStorage.md).[`pushBatch`](../interfaces/BatchStorage.md#pushbatch) diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md new file mode 100644 index 0000000..d5e5316 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md @@ -0,0 +1,201 @@ +--- +title: InMemoryBlockStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryBlockStorage + +# Class: InMemoryBlockStorage + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L18) + +## Implements + +- [`BlockStorage`](../interfaces/BlockStorage.md) +- [`HistoricalBlockStorage`](../interfaces/HistoricalBlockStorage.md) +- [`BlockQueue`](../interfaces/BlockQueue.md) + +## Constructors + +### new InMemoryBlockStorage() + +> **new InMemoryBlockStorage**(`batchStorage`): [`InMemoryBlockStorage`](InMemoryBlockStorage.md) + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L21) + +#### Parameters + +##### batchStorage + +[`BatchStorage`](../interfaces/BatchStorage.md) + +#### Returns + +[`InMemoryBlockStorage`](InMemoryBlockStorage.md) + +## Methods + +### getBlock() + +> **getBlock**(`hash`): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L112) + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +#### Implementation of + +[`HistoricalBlockStorage`](../interfaces/HistoricalBlockStorage.md).[`getBlock`](../interfaces/HistoricalBlockStorage.md#getblock) + +*** + +### getBlockAt() + +> **getBlockAt**(`height`): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L29) + +#### Parameters + +##### height + +`number` + +#### Returns + +`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +#### Implementation of + +[`HistoricalBlockStorage`](../interfaces/HistoricalBlockStorage.md).[`getBlockAt`](../interfaces/HistoricalBlockStorage.md#getblockat) + +*** + +### getCurrentBlockHeight() + +> **getCurrentBlockHeight**(): `Promise`\<`number`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L33) + +#### Returns + +`Promise`\<`number`\> + +#### Implementation of + +[`BlockStorage`](../interfaces/BlockStorage.md).[`getCurrentBlockHeight`](../interfaces/BlockStorage.md#getcurrentblockheight) + +*** + +### getLatestBlock() + +> **getLatestBlock**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L52) + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> + +#### Implementation of + +[`BlockStorage`](../interfaces/BlockStorage.md).[`getLatestBlock`](../interfaces/BlockStorage.md#getlatestblock) + +*** + +### getLatestBlockAndResult() + +> **getLatestBlockAndResult**(): `Promise`\<`undefined` \| [`BlockWithMaybeResult`](../interfaces/BlockWithMaybeResult.md)\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L37) + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithMaybeResult`](../interfaces/BlockWithMaybeResult.md)\> + +#### Implementation of + +[`BlockQueue`](../interfaces/BlockQueue.md).[`getLatestBlockAndResult`](../interfaces/BlockQueue.md#getlatestblockandresult) + +*** + +### getNewBlocks() + +> **getNewBlocks**(): `Promise`\<[`BlockWithPreviousResult`](../interfaces/BlockWithPreviousResult.md)[]\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L68) + +#### Returns + +`Promise`\<[`BlockWithPreviousResult`](../interfaces/BlockWithPreviousResult.md)[]\> + +#### Implementation of + +[`BlockQueue`](../interfaces/BlockQueue.md).[`getNewBlocks`](../interfaces/BlockQueue.md#getnewblocks) + +*** + +### getNewestResult() + +> **getNewestResult**(): `Promise`\<`undefined` \| [`BlockResult`](../interfaces/BlockResult.md)\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:104](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L104) + +#### Returns + +`Promise`\<`undefined` \| [`BlockResult`](../interfaces/BlockResult.md)\> + +*** + +### pushBlock() + +> **pushBlock**(`block`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:100](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L100) + +#### Parameters + +##### block + +[`Block`](../interfaces/Block.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`BlockQueue`](../interfaces/BlockQueue.md).[`pushBlock`](../interfaces/BlockQueue.md#pushblock) + +*** + +### pushResult() + +> **pushResult**(`result`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L108) + +#### Parameters + +##### result + +[`BlockResult`](../interfaces/BlockResult.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`BlockQueue`](../interfaces/BlockQueue.md).[`pushResult`](../interfaces/BlockQueue.md#pushresult) diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md b/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md new file mode 100644 index 0000000..2841907 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md @@ -0,0 +1,217 @@ +--- +title: InMemoryDatabase +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryDatabase + +# Class: InMemoryDatabase + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L21) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](SequencerModule.md) + +## Implements + +- [`Database`](../interfaces/Database.md) + +## Constructors + +### new InMemoryDatabase() + +> **new InMemoryDatabase**(): [`InMemoryDatabase`](InMemoryDatabase.md) + +#### Returns + +[`InMemoryDatabase`](InMemoryDatabase.md) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L64) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Database`](../interfaces/Database.md).[`close`](../interfaces/Database.md#close) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### dependencies() + +> **dependencies**(): [`StorageDependencyMinimumDependencies`](../interfaces/StorageDependencyMinimumDependencies.md) + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L22) + +#### Returns + +[`StorageDependencyMinimumDependencies`](../interfaces/StorageDependencyMinimumDependencies.md) + +#### Implementation of + +[`Database`](../interfaces/Database.md).[`dependencies`](../interfaces/Database.md#dependencies) + +*** + +### executeInTransaction() + +> **executeInTransaction**(`f`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L75) + +#### Parameters + +##### f + +() => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Database`](../interfaces/Database.md).[`executeInTransaction`](../interfaces/Database.md#executeintransaction) + +*** + +### pruneDatabase() + +> **pruneDatabase**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L68) + +Prunes all data from the database connection. +Note: This function should only be called immediately at startup, +everything else will lead to unexpected behaviour and errors + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Database`](../interfaces/Database.md).[`pruneDatabase`](../interfaces/Database.md#prunedatabase) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L60) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md new file mode 100644 index 0000000..c1133a9 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md @@ -0,0 +1,81 @@ +--- +title: InMemoryMessageStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryMessageStorage + +# Class: InMemoryMessageStorage + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L7) + +Interface to store Messages previously fetched by a IncomingMessageadapter + +## Implements + +- [`MessageStorage`](../interfaces/MessageStorage.md) + +## Constructors + +### new InMemoryMessageStorage() + +> **new InMemoryMessageStorage**(): [`InMemoryMessageStorage`](InMemoryMessageStorage.md) + +#### Returns + +[`InMemoryMessageStorage`](InMemoryMessageStorage.md) + +## Methods + +### getMessages() + +> **getMessages**(`fromMessagesHash`): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L10) + +#### Parameters + +##### fromMessagesHash + +`string` + +#### Returns + +`Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> + +#### Implementation of + +[`MessageStorage`](../interfaces/MessageStorage.md).[`getMessages`](../interfaces/MessageStorage.md#getmessages) + +*** + +### pushMessages() + +> **pushMessages**(`fromMessagesHash`, `toMessagesHash`, `messages`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L16) + +#### Parameters + +##### fromMessagesHash + +`string` + +##### toMessagesHash + +`string` + +##### messages + +[`PendingTransaction`](PendingTransaction.md)[] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`MessageStorage`](../interfaces/MessageStorage.md).[`pushMessages`](../interfaces/MessageStorage.md#pushmessages) diff --git a/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md b/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md new file mode 100644 index 0000000..0256cb1 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md @@ -0,0 +1,57 @@ +--- +title: InMemorySettlementStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemorySettlementStorage + +# Class: InMemorySettlementStorage + +Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L7) + +## Implements + +- [`SettlementStorage`](../interfaces/SettlementStorage.md) + +## Constructors + +### new InMemorySettlementStorage() + +> **new InMemorySettlementStorage**(): [`InMemorySettlementStorage`](InMemorySettlementStorage.md) + +#### Returns + +[`InMemorySettlementStorage`](InMemorySettlementStorage.md) + +## Properties + +### settlements + +> **settlements**: [`Settlement`](../interfaces/Settlement.md)[] = `[]` + +Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L8) + +## Methods + +### pushSettlement() + +> **pushSettlement**(`settlement`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L10) + +#### Parameters + +##### settlement + +[`Settlement`](../interfaces/Settlement.md) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`SettlementStorage`](../interfaces/SettlementStorage.md).[`pushSettlement`](../interfaces/SettlementStorage.md#pushsettlement) diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md new file mode 100644 index 0000000..77392b3 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md @@ -0,0 +1,104 @@ +--- +title: InMemoryTransactionStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryTransactionStorage + +# Class: InMemoryTransactionStorage + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L14) + +## Implements + +- [`TransactionStorage`](../interfaces/TransactionStorage.md) + +## Constructors + +### new InMemoryTransactionStorage() + +> **new InMemoryTransactionStorage**(`blockStorage`, `batchStorage`): [`InMemoryTransactionStorage`](InMemoryTransactionStorage.md) + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L19) + +#### Parameters + +##### blockStorage + +[`BlockStorage`](../interfaces/BlockStorage.md) & [`HistoricalBlockStorage`](../interfaces/HistoricalBlockStorage.md) + +##### batchStorage + +[`InMemoryBatchStorage`](InMemoryBatchStorage.md) + +#### Returns + +[`InMemoryTransactionStorage`](InMemoryTransactionStorage.md) + +## Methods + +### findTransaction() + +> **findTransaction**(`hash`): `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](PendingTransaction.md); \}\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L73) + +Finds a transaction by its hash. +It returns both pending transaction and already included transactions +In case the transaction has been included, it also returns the block hash +and batch number where applicable. + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](PendingTransaction.md); \}\> + +#### Implementation of + +[`TransactionStorage`](../interfaces/TransactionStorage.md).[`findTransaction`](../interfaces/TransactionStorage.md#findtransaction) + +*** + +### getPendingUserTransactions() + +> **getPendingUserTransactions**(): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L25) + +#### Returns + +`Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> + +#### Implementation of + +[`TransactionStorage`](../interfaces/TransactionStorage.md).[`getPendingUserTransactions`](../interfaces/TransactionStorage.md#getpendingusertransactions) + +*** + +### pushUserTransaction() + +> **pushUserTransaction**(`tx`): `Promise`\<`boolean`\> + +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L46) + +#### Parameters + +##### tx + +[`PendingTransaction`](PendingTransaction.md) + +#### Returns + +`Promise`\<`boolean`\> + +#### Implementation of + +[`TransactionStorage`](../interfaces/TransactionStorage.md).[`pushUserTransaction`](../interfaces/TransactionStorage.md#pushusertransaction) diff --git a/src/pages/docs/reference/sequencer/classes/ListenerList.md b/src/pages/docs/reference/sequencer/classes/ListenerList.md new file mode 100644 index 0000000..1dbb9a2 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/ListenerList.md @@ -0,0 +1,93 @@ +--- +title: ListenerList +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ListenerList + +# Class: ListenerList\ + +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/ListenerList.ts#L3) + +## Type Parameters + +• **T** + +## Constructors + +### new ListenerList() + +> **new ListenerList**\<`T`\>(): [`ListenerList`](ListenerList.md)\<`T`\> + +#### Returns + +[`ListenerList`](ListenerList.md)\<`T`\> + +## Methods + +### executeListeners() + +> **executeListeners**(`payload`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/ListenerList.ts#L15) + +#### Parameters + +##### payload + +`T` + +#### Returns + +`Promise`\<`void`\> + +*** + +### getListeners() + +> **getListeners**(): `object`[] + +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/ListenerList.ts#L11) + +#### Returns + +`object`[] + +*** + +### pushListener() + +> **pushListener**(`listener`): `number` + +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/ListenerList.ts#L22) + +#### Parameters + +##### listener + +(`payload`) => `Promise`\<`void`\> + +#### Returns + +`number` + +*** + +### removeListener() + +> **removeListener**(`listenerId`): `void` + +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/ListenerList.ts#L34) + +#### Parameters + +##### listenerId + +`number` + +#### Returns + +`void` diff --git a/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md b/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md new file mode 100644 index 0000000..c26a568 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md @@ -0,0 +1,290 @@ +--- +title: LocalTaskQueue +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / LocalTaskQueue + +# Class: LocalTaskQueue + +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L74) + +Definition of a connection-object that can generate queues and workers +for a specific connection type (e.g. BullMQ, In-memory) + +## Extends + +- [`AbstractTaskQueue`](AbstractTaskQueue.md)\<[`LocalTaskQueueConfig`](../interfaces/LocalTaskQueueConfig.md)\> + +## Implements + +- [`TaskQueue`](../interfaces/TaskQueue.md) + +## Constructors + +### new LocalTaskQueue() + +> **new LocalTaskQueue**(): [`LocalTaskQueue`](LocalTaskQueue.md) + +#### Returns + +[`LocalTaskQueue`](LocalTaskQueue.md) + +#### Inherited from + +[`AbstractTaskQueue`](AbstractTaskQueue.md).[`constructor`](AbstractTaskQueue.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`LocalTaskQueueConfig`](../interfaces/LocalTaskQueueConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`AbstractTaskQueue`](AbstractTaskQueue.md).[`currentConfig`](AbstractTaskQueue.md#currentconfig) + +*** + +### listeners + +> `readonly` **listeners**: `object` = `{}` + +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L92) + +#### Index Signature + +\[`key`: `string`\]: `undefined` \| `QueueListener`[] + +*** + +### queuedTasks + +> **queuedTasks**: `object` = `{}` + +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L78) + +#### Index Signature + +\[`key`: `string`\]: `object`[] + +*** + +### queues + +> `protected` **queues**: `Record`\<`string`, [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> = `{}` + +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) + +#### Inherited from + +[`AbstractTaskQueue`](AbstractTaskQueue.md).[`queues`](AbstractTaskQueue.md#queues) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`AbstractTaskQueue`](AbstractTaskQueue.md).[`presets`](AbstractTaskQueue.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`AbstractTaskQueue`](AbstractTaskQueue.md).[`config`](AbstractTaskQueue.md#config) + +## Methods + +### closeQueues() + +> `protected` **closeQueues**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`AbstractTaskQueue`](AbstractTaskQueue.md).[`closeQueues`](AbstractTaskQueue.md#closequeues) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractTaskQueue`](AbstractTaskQueue.md).[`create`](AbstractTaskQueue.md#create) + +*** + +### createOrGetQueue() + +> `protected` **createOrGetQueue**(`name`, `creator`): [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) + +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) + +#### Parameters + +##### name + +`string` + +##### creator + +(`name`) => [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) + +#### Returns + +[`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) + +#### Inherited from + +[`AbstractTaskQueue`](AbstractTaskQueue.md).[`createOrGetQueue`](AbstractTaskQueue.md#createorgetqueue) + +*** + +### createWorker() + +> **createWorker**(`queueName`, `executor`, `options`?): [`Closeable`](../interfaces/Closeable.md) + +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:146](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L146) + +#### Parameters + +##### queueName + +`string` + +##### executor + +(`data`) => `Promise`\<[`TaskPayload`](../interfaces/TaskPayload.md)\> + +##### options? + +###### concurrency + +`number` + +###### singleUse + +`boolean` + +#### Returns + +[`Closeable`](../interfaces/Closeable.md) + +#### Implementation of + +[`TaskQueue`](../interfaces/TaskQueue.md).[`createWorker`](../interfaces/TaskQueue.md#createworker) + +*** + +### getQueue() + +> **getQueue**(`queueName`): `Promise`\<[`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> + +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:186](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L186) + +#### Parameters + +##### queueName + +`string` + +#### Returns + +`Promise`\<[`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> + +#### Implementation of + +[`TaskQueue`](../interfaces/TaskQueue.md).[`getQueue`](../interfaces/TaskQueue.md#getqueue) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:193](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L193) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`AbstractTaskQueue`](AbstractTaskQueue.md).[`start`](AbstractTaskQueue.md#start) + +*** + +### workNextTasks() + +> **workNextTasks**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L98) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md b/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md new file mode 100644 index 0000000..6785c70 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md @@ -0,0 +1,682 @@ +--- +title: LocalTaskWorkerModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / LocalTaskWorkerModule + +# Class: LocalTaskWorkerModule\ + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L56) + +This module spins up a worker in the current local node instance. +This should only be used for local testing/development and not in a +production setup. Use the proper worker execution method for spinning up +cloud workers. + +## Extends + +- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Tasks`\> + +## Type Parameters + +• **Tasks** *extends* [`TaskWorkerModulesRecord`](../type-aliases/TaskWorkerModulesRecord.md) + +## Implements + +- [`SequencerModule`](SequencerModule.md) +- [`EventEmittingContainer`](../../common/interfaces/EventEmittingContainer.md)\<`LocalTaskWorkerModuleEvents`\> + +## Constructors + +### new LocalTaskWorkerModule() + +> **new LocalTaskWorkerModule**\<`Tasks`\>(`modules`): [`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\> + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L80) + +#### Parameters + +##### modules + +`Tasks` + +#### Returns + +[`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\> + +#### Overrides + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) + +## Properties + +### containerEvents + +> **containerEvents**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<`LocalTaskWorkerModuleEvents`\> + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L64) + +#### Implementation of + +[`EventEmittingContainer`](../../common/interfaces/EventEmittingContainer.md).[`containerEvents`](../../common/interfaces/EventEmittingContainer.md#containerevents) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Tasks`\> + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Implementation of + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) + +*** + +### definition + +> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Tasks`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L62) + +#### Implementation of + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Implementation of + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:124](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L124) + +#### Returns + +`Promise`\<`void`\> + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Tasks`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Tasks`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:160 + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Implementation of + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) + +*** + +### decorateModule() + +> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:134 + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Tasks`\> + +##### containedModule + +`InstanceType`\<`Tasks`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Tasks`\>\]\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Tasks`\>[] + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +`Tasks` + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Tasks`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +`Tasks` + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Tasks`\>\[`KeyType`\]\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Tasks`\>\[`KeyType`\]\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:100](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L100) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Tasks`\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`Tasks`\>(`modules`): [`TypedClass`](../type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\>\> + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L70) + +#### Type Parameters + +• **Tasks** *extends* [`TaskWorkerModulesRecord`](../type-aliases/TaskWorkerModulesRecord.md) + +#### Parameters + +##### modules + +`Tasks` + +#### Returns + +[`TypedClass`](../type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\>\> diff --git a/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md b/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md new file mode 100644 index 0000000..80fed30 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md @@ -0,0 +1,339 @@ +--- +title: ManualBlockTrigger +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ManualBlockTrigger + +# Class: ManualBlockTrigger + +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L17) + +A BlockTrigger is the primary method to start the production of a block and +all associated processes. + +## Extends + +- [`BlockTriggerBase`](BlockTriggerBase.md) + +## Implements + +- [`BlockTrigger`](../interfaces/BlockTrigger.md) + +## Constructors + +### new ManualBlockTrigger() + +> **new ManualBlockTrigger**(`batchProducerModule`, `blockProducerModule`, `settlementModule`, `blockQueue`, `batchStorage`, `settlementStorage`): [`ManualBlockTrigger`](ManualBlockTrigger.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L21) + +#### Parameters + +##### batchProducerModule + +[`BatchProducerModule`](BatchProducerModule.md) + +##### blockProducerModule + +[`BlockProducerModule`](BlockProducerModule.md) + +##### settlementModule + +`undefined` | [`SettlementModule`](SettlementModule.md) + +##### blockQueue + +[`BlockQueue`](../interfaces/BlockQueue.md) + +##### batchStorage + +[`BatchStorage`](../interfaces/BatchStorage.md) + +##### settlementStorage + +`undefined` | [`SettlementStorage`](../interfaces/SettlementStorage.md) + +#### Returns + +[`ManualBlockTrigger`](ManualBlockTrigger.md) + +#### Overrides + +[`BlockTriggerBase`](BlockTriggerBase.md).[`constructor`](BlockTriggerBase.md#constructors) + +## Properties + +### batchProducerModule + +> `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`batchProducerModule`](BlockTriggerBase.md#batchproducermodule-1) + +*** + +### batchQueue + +> `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`batchQueue`](BlockTriggerBase.md#batchqueue-1) + +*** + +### blockProducerModule + +> `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`blockProducerModule`](BlockTriggerBase.md#blockproducermodule-1) + +*** + +### blockQueue + +> `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`blockQueue`](BlockTriggerBase.md#blockqueue-1) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`currentConfig`](BlockTriggerBase.md#currentconfig) + +*** + +### events + +> `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`BlockEvents`](../type-aliases/BlockEvents.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`events`](BlockTriggerBase.md#events) + +*** + +### settlementModule + +> `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`settlementModule`](BlockTriggerBase.md#settlementmodule-1) + +*** + +### settlementStorage + +> `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`settlementStorage`](BlockTriggerBase.md#settlementstorage-1) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`presets`](BlockTriggerBase.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`config`](BlockTriggerBase.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`create`](BlockTriggerBase.md#create) + +*** + +### produceBatch() + +> **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L57) + +#### Returns + +`Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> + +#### Overrides + +[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBatch`](BlockTriggerBase.md#producebatch) + +*** + +### produceBlock() + +> **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L65) + +#### Returns + +`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +#### Overrides + +[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBlock`](BlockTriggerBase.md#produceblock) + +*** + +### produceBlockAndBatch() + +> **produceBlockAndBatch**(): `Promise`\<\[`undefined` \| [`Block`](../interfaces/Block.md), `undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\]\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L50) + +Produces both an unproven block and immediately produce a +settlement block proof + +#### Returns + +`Promise`\<\[`undefined` \| [`Block`](../interfaces/Block.md), `undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\]\> + +*** + +### produceBlockWithResult() + +> **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L69) + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> + +#### Overrides + +[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBlockWithResult`](BlockTriggerBase.md#produceblockwithresult) + +*** + +### settle() + +> **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L61) + +#### Parameters + +##### batch + +[`SettleableBatch`](../interfaces/SettleableBatch.md) + +#### Returns + +`Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> + +#### Overrides + +[`BlockTriggerBase`](BlockTriggerBase.md).[`settle`](BlockTriggerBase.md#settle) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`start`](BlockTriggerBase.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md b/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md new file mode 100644 index 0000000..c6f4b7f --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md @@ -0,0 +1,220 @@ +--- +title: MinaBaseLayer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaBaseLayer + +# Class: MinaBaseLayer + +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L35) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](SequencerModule.md)\<[`MinaBaseLayerConfig`](../interfaces/MinaBaseLayerConfig.md)\> + +## Implements + +- [`BaseLayer`](../interfaces/BaseLayer.md) +- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) + +## Constructors + +### new MinaBaseLayer() + +> **new MinaBaseLayer**(`areProofsEnabled`): [`MinaBaseLayer`](MinaBaseLayer.md) + +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L43) + +#### Parameters + +##### areProofsEnabled + +[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Returns + +[`MinaBaseLayer`](MinaBaseLayer.md) + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`MinaBaseLayerConfig`](../interfaces/MinaBaseLayerConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### network? + +> `optional` **network**: `Mina` + +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L39) + +*** + +### originalNetwork? + +> `optional` **originalNetwork**: `Mina` + +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L41) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### dependencies() + +> **dependencies**(): `object` + +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L50) + +#### Returns + +`object` + +##### IncomingMessageAdapter + +> **IncomingMessageAdapter**: `object` + +###### IncomingMessageAdapter.useClass + +> **IncomingMessageAdapter.useClass**: *typeof* [`MinaIncomingMessageAdapter`](MinaIncomingMessageAdapter.md) = `MinaIncomingMessageAdapter` + +##### OutgoingMessageQueue + +> **OutgoingMessageQueue**: `object` + +###### OutgoingMessageQueue.useClass + +> **OutgoingMessageQueue.useClass**: *typeof* [`WithdrawalQueue`](WithdrawalQueue.md) = `WithdrawalQueue` + +##### TransactionSender + +> **TransactionSender**: `object` + +###### TransactionSender.useClass + +> **TransactionSender.useClass**: *typeof* [`MinaTransactionSender`](MinaTransactionSender.md) = `MinaTransactionSender` + +#### Implementation of + +[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) + +*** + +### isLocalBlockChain() + +> **isLocalBlockChain**(): `boolean` + +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L66) + +#### Returns + +`boolean` + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L70) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md b/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md new file mode 100644 index 0000000..d8f58f5 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md @@ -0,0 +1,82 @@ +--- +title: MinaIncomingMessageAdapter +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaIncomingMessageAdapter + +# Class: MinaIncomingMessageAdapter + +Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L34) + +IncomingMessageAdapter implementation for a Mina Baselayer +based on decoding L1-dispatched actions + +## Implements + +- [`IncomingMessageAdapter`](../interfaces/IncomingMessageAdapter.md) + +## Constructors + +### new MinaIncomingMessageAdapter() + +> **new MinaIncomingMessageAdapter**(`baseLayer`, `runtime`, `protocol`): [`MinaIncomingMessageAdapter`](MinaIncomingMessageAdapter.md) + +Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L35) + +#### Parameters + +##### baseLayer + +[`MinaBaseLayer`](MinaBaseLayer.md) + +##### runtime + +[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<`any`\> + +#### Returns + +[`MinaIncomingMessageAdapter`](MinaIncomingMessageAdapter.md) + +## Methods + +### getPendingMessages() + +> **getPendingMessages**(`address`, `params`): `Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](PendingTransaction.md)[]; `to`: `string`; \}\> + +Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:99](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L99) + +#### Parameters + +##### address + +`PublicKey` + +##### params + +###### fromActionHash + +`string` + +###### fromL1BlockHeight + +`number` + +###### toActionHash + +`string` + +#### Returns + +`Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](PendingTransaction.md)[]; `to`: `string`; \}\> + +#### Implementation of + +[`IncomingMessageAdapter`](../interfaces/IncomingMessageAdapter.md).[`getPendingMessages`](../interfaces/IncomingMessageAdapter.md#getpendingmessages) diff --git a/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md b/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md new file mode 100644 index 0000000..4a64d02 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md @@ -0,0 +1,83 @@ +--- +title: MinaSimulationService +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaSimulationService + +# Class: MinaSimulationService + +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L17) + +## Constructors + +### new MinaSimulationService() + +> **new MinaSimulationService**(`baseLayer`): [`MinaSimulationService`](MinaSimulationService.md) + +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L18) + +#### Parameters + +##### baseLayer + +[`MinaBaseLayer`](MinaBaseLayer.md) + +#### Returns + +[`MinaSimulationService`](MinaSimulationService.md) + +## Methods + +### applyTransaction() + +> **applyTransaction**(`tx`): `void` + +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L65) + +#### Parameters + +##### tx + +`Transaction`\<`boolean`, `boolean`\> + +#### Returns + +`void` + +*** + +### updateAccount() + +> **updateAccount**(`publicKey`, `tokenId`?): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L41) + +#### Parameters + +##### publicKey + +`PublicKey` + +##### tokenId? + +`Field` + +#### Returns + +`Promise`\<`void`\> + +*** + +### updateNetworkState() + +> **updateNetworkState**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L36) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md b/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md new file mode 100644 index 0000000..23e0512 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md @@ -0,0 +1,65 @@ +--- +title: MinaTransactionSender +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaTransactionSender + +# Class: MinaTransactionSender + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L29) + +## Constructors + +### new MinaTransactionSender() + +> **new MinaTransactionSender**(`creator`, `provingTask`, `simulator`, `baseLayer`): [`MinaTransactionSender`](MinaTransactionSender.md) + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L39) + +#### Parameters + +##### creator + +[`FlowCreator`](FlowCreator.md) + +##### provingTask + +[`SettlementProvingTask`](SettlementProvingTask.md) + +##### simulator + +[`MinaTransactionSimulator`](MinaTransactionSimulator.md) + +##### baseLayer + +[`MinaBaseLayer`](MinaBaseLayer.md) + +#### Returns + +[`MinaTransactionSender`](MinaTransactionSender.md) + +## Methods + +### proveAndSendTransaction() + +> **proveAndSendTransaction**(`transaction`, `waitOnStatus`): `Promise`\<[`EventListenable`](../../common/type-aliases/EventListenable.md)\<[`TxEvents`](../interfaces/TxEvents.md)\>\> + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:116](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L116) + +#### Parameters + +##### transaction + +`Transaction`\<`false`, `true`\> + +##### waitOnStatus + +`"sent"` | `"included"` | `"none"` + +#### Returns + +`Promise`\<[`EventListenable`](../../common/type-aliases/EventListenable.md)\<[`TxEvents`](../interfaces/TxEvents.md)\>\> diff --git a/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md b/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md new file mode 100644 index 0000000..5d5c114 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md @@ -0,0 +1,203 @@ +--- +title: MinaTransactionSimulator +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaTransactionSimulator + +# Class: MinaTransactionSimulator + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L32) + +Custom variant of the ocaml ledger implementation that applies account updates +to a ledger state. It isn't feature complete and is mainly used to update the +o1js internal account cache to create batched transactions + +## Constructors + +### new MinaTransactionSimulator() + +> **new MinaTransactionSimulator**(`baseLayer`): [`MinaTransactionSimulator`](MinaTransactionSimulator.md) + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L37) + +#### Parameters + +##### baseLayer + +[`MinaBaseLayer`](MinaBaseLayer.md) + +#### Returns + +[`MinaTransactionSimulator`](MinaTransactionSimulator.md) + +## Methods + +### apply() + +> **apply**(`account`, `au`): `void` + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:247](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L247) + +#### Parameters + +##### account + +`Account` + +##### au + +`AccountUpdate` + +#### Returns + +`void` + +*** + +### applyFeepayer() + +> **applyFeepayer**(`account`, `feepayer`): `void` + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:242](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L242) + +#### Parameters + +##### account + +`Account` + +##### feepayer + +`FeePayerUnsigned` + +#### Returns + +`void` + +*** + +### applyTransaction() + +> **applyTransaction**(`tx`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L86) + +#### Parameters + +##### tx + +`Transaction`\<`boolean`, `boolean`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### checkFeePayer() + +> **checkFeePayer**(`account`, `feepayer`): `boolean` + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:199](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L199) + +#### Parameters + +##### account + +`Account` + +##### feepayer + +`FeePayerUnsigned` + +#### Returns + +`boolean` + +*** + +### checkPreconditions() + +> **checkPreconditions**(`account`, `au`): `string`[] + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:206](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L206) + +#### Parameters + +##### account + +`Account` + +##### au + +`AccountUpdate` + +#### Returns + +`string`[] + +*** + +### getAccount() + +> **getAccount**(`publicKey`, `tokenId`?): `Promise`\<`Account`\> + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:142](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L142) + +#### Parameters + +##### publicKey + +`PublicKey` + +##### tokenId? + +`Field` + +#### Returns + +`Promise`\<`Account`\> + +*** + +### getAccounts() + +> **getAccounts**(`tx`): `Promise`\<`Account`[]\> + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L80) + +#### Parameters + +##### tx + +`Transaction`\<`boolean`, `boolean`\> + +#### Returns + +`Promise`\<`Account`[]\> + +*** + +### reloadAccount() + +> **reloadAccount**(`publicKey`, `tokenId`?): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:163](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L163) + +#### Parameters + +##### publicKey + +`PublicKey` + +##### tokenId? + +`Field` + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md b/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md new file mode 100644 index 0000000..c877e6d --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md @@ -0,0 +1,73 @@ +--- +title: NetworkStateQuery +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NetworkStateQuery + +# Class: NetworkStateQuery + +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L5) + +## Constructors + +### new NetworkStateQuery() + +> **new NetworkStateQuery**(`transportModule`): [`NetworkStateQuery`](NetworkStateQuery.md) + +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L6) + +#### Parameters + +##### transportModule + +[`NetworkStateTransportModule`](../interfaces/NetworkStateTransportModule.md) + +#### Returns + +[`NetworkStateQuery`](NetworkStateQuery.md) + +## Accessors + +### proven + +#### Get Signature + +> **get** **proven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L18) + +##### Returns + +`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +*** + +### stagedUnproven + +#### Get Signature + +> **get** **stagedUnproven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L14) + +##### Returns + +`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +*** + +### unproven + +#### Get Signature + +> **get** **unproven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L10) + +##### Returns + +`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> diff --git a/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md new file mode 100644 index 0000000..a5329fe --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md @@ -0,0 +1,83 @@ +--- +title: NewBlockProvingParametersSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NewBlockProvingParametersSerializer + +# Class: NewBlockProvingParametersSerializer + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L38) + +## Implements + +- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`NewBlockPayload`\> + +## Constructors + +### new NewBlockProvingParametersSerializer() + +> **new NewBlockProvingParametersSerializer**(`stProofSerializer`, `blockProofSerializer`): [`NewBlockProvingParametersSerializer`](NewBlockProvingParametersSerializer.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L41) + +#### Parameters + +##### stProofSerializer + +[`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`StateTransitionProverPublicInput`](../../protocol/classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../../protocol/classes/StateTransitionProverPublicOutput.md)\> + +##### blockProofSerializer + +[`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../../protocol/classes/BlockProverPublicOutput.md)\> + +#### Returns + +[`NewBlockProvingParametersSerializer`](NewBlockProvingParametersSerializer.md) + +## Methods + +### fromJSON() + +> **fromJSON**(`json`): `Promise`\<`NewBlockPayload`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L73) + +#### Parameters + +##### json + +`string` + +#### Returns + +`Promise`\<`NewBlockPayload`\> + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) + +*** + +### toJSON() + +> **toJSON**(`input`): `string` + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L52) + +#### Parameters + +##### input + +`NewBlockPayload` + +#### Returns + +`string` + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) diff --git a/src/pages/docs/reference/sequencer/classes/NewBlockTask.md b/src/pages/docs/reference/sequencer/classes/NewBlockTask.md new file mode 100644 index 0000000..2ae7892 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/NewBlockTask.md @@ -0,0 +1,206 @@ +--- +title: NewBlockTask +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NewBlockTask + +# Class: NewBlockTask + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L45) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`TaskWorkerModule`](TaskWorkerModule.md) + +## Implements + +- [`Task`](../interfaces/Task.md)\<[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md), `BlockProof`\> + +## Constructors + +### new NewBlockTask() + +> **new NewBlockTask**(`protocol`, `executionContext`, `compileRegistry`): [`NewBlockTask`](NewBlockTask.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L55) + +#### Parameters + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> + +##### executionContext + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md) + +##### compileRegistry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +[`NewBlockTask`](NewBlockTask.md) + +#### Overrides + +[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) + +*** + +### name + +> `readonly` **name**: `"newBlock"` = `"newBlock"` + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L53) + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) + +## Methods + +### compute() + +> **compute**(`input`): `Promise`\<`BlockProof`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L105) + +#### Parameters + +##### input + +[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md) + +#### Returns + +`Promise`\<`BlockProof`\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) + +*** + +### inputSerializer() + +> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L66) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) + +*** + +### prepare() + +> **prepare**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L129) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) + +*** + +### resultSerializer() + +> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`BlockProof`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L81) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<`BlockProof`\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md b/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md new file mode 100644 index 0000000..b0cb5b4 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md @@ -0,0 +1,171 @@ +--- +title: NoopBaseLayer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NoopBaseLayer + +# Class: NoopBaseLayer + +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L53) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](SequencerModule.md) + +## Implements + +- [`BaseLayer`](../interfaces/BaseLayer.md) + +## Constructors + +### new NoopBaseLayer() + +> **new NoopBaseLayer**(): [`NoopBaseLayer`](NoopBaseLayer.md) + +#### Returns + +[`NoopBaseLayer`](NoopBaseLayer.md) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### blockProduced() + +> **blockProduced**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L54) + +#### Returns + +`Promise`\<`void`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### dependencies() + +> **dependencies**(): [`BaseLayerDependencyRecord`](../interfaces/BaseLayerDependencyRecord.md) + +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L62) + +#### Returns + +[`BaseLayerDependencyRecord`](../interfaces/BaseLayerDependencyRecord.md) + +#### Implementation of + +[`BaseLayer`](../interfaces/BaseLayer.md).[`dependencies`](../interfaces/BaseLayer.md#dependencies) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L58) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md new file mode 100644 index 0000000..0940458 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md @@ -0,0 +1,85 @@ +--- +title: PairProofTaskSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PairProofTaskSerializer + +# Class: PairProofTaskSerializer\ + +Defined in: [packages/sequencer/src/helpers/utils.ts:164](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L164) + +## Type Parameters + +• **PublicInputType** + +• **PublicOutputType** + +## Implements + +- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\>\> + +## Constructors + +### new PairProofTaskSerializer() + +> **new PairProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`PairProofTaskSerializer`](PairProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> + +Defined in: [packages/sequencer/src/helpers/utils.ts:170](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L170) + +#### Parameters + +##### proofClass + +[`Subclass`](../../protocol/type-aliases/Subclass.md)\<*typeof* `Proof`\> + +#### Returns + +[`PairProofTaskSerializer`](PairProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> + +## Methods + +### fromJSON() + +> **fromJSON**(`json`): `Promise`\<[`PairTuple`](../type-aliases/PairTuple.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\>\> + +Defined in: [packages/sequencer/src/helpers/utils.ts:176](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L176) + +#### Parameters + +##### json + +`string` + +#### Returns + +`Promise`\<[`PairTuple`](../type-aliases/PairTuple.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\>\> + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) + +*** + +### toJSON() + +> **toJSON**(`input`): `string` + +Defined in: [packages/sequencer/src/helpers/utils.ts:187](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L187) + +#### Parameters + +##### input + +[`PairTuple`](../type-aliases/PairTuple.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> + +#### Returns + +`string` + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) diff --git a/src/pages/docs/reference/sequencer/classes/PendingTransaction.md b/src/pages/docs/reference/sequencer/classes/PendingTransaction.md new file mode 100644 index 0000000..f7dbfb3 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/PendingTransaction.md @@ -0,0 +1,298 @@ +--- +title: PendingTransaction +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PendingTransaction + +# Class: PendingTransaction + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:123](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L123) + +## Extends + +- [`UnsignedTransaction`](UnsignedTransaction.md) + +## Constructors + +### new PendingTransaction() + +> **new PendingTransaction**(`data`): [`PendingTransaction`](PendingTransaction.md) + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:140](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L140) + +#### Parameters + +##### data + +###### argsFields + +`Field`[] + +###### auxiliaryData + +`string`[] + +###### isMessage + +`boolean` + +###### methodId + +`Field` + +###### nonce + +`UInt64` + +###### sender + +`PublicKey` + +###### signature + +`Signature` + +#### Returns + +[`PendingTransaction`](PendingTransaction.md) + +#### Overrides + +[`UnsignedTransaction`](UnsignedTransaction.md).[`constructor`](UnsignedTransaction.md#constructors) + +## Properties + +### argsFields + +> **argsFields**: `Field`[] + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L37) + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`argsFields`](UnsignedTransaction.md#argsfields-1) + +*** + +### auxiliaryData + +> **auxiliaryData**: `string`[] + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L39) + +Used to transport non-provable data, mainly proof data for now +These values will not be part of the signature message or transaction hash + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`auxiliaryData`](UnsignedTransaction.md#auxiliarydata-1) + +*** + +### isMessage + +> **isMessage**: `boolean` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L41) + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`isMessage`](UnsignedTransaction.md#ismessage-1) + +*** + +### methodId + +> **methodId**: `Field` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L31) + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`methodId`](UnsignedTransaction.md#methodid-1) + +*** + +### nonce + +> **nonce**: `UInt64` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L33) + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`nonce`](UnsignedTransaction.md#nonce-1) + +*** + +### sender + +> **sender**: `PublicKey` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L35) + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`sender`](UnsignedTransaction.md#sender-1) + +*** + +### signature + +> **signature**: `Signature` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:138](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L138) + +## Methods + +### argsHash() + +> **argsHash**(): `Field` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L59) + +#### Returns + +`Field` + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`argsHash`](UnsignedTransaction.md#argshash) + +*** + +### getSignatureData() + +> **getSignatureData**(): `Field`[] + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L72) + +#### Returns + +`Field`[] + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`getSignatureData`](UnsignedTransaction.md#getsignaturedata) + +*** + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L63) + +#### Returns + +`Field` + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`hash`](UnsignedTransaction.md#hash) + +*** + +### sign() + +> **sign**(`privateKey`): [`PendingTransaction`](PendingTransaction.md) + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L80) + +#### Parameters + +##### privateKey + +`PrivateKey` + +#### Returns + +[`PendingTransaction`](PendingTransaction.md) + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`sign`](UnsignedTransaction.md#sign) + +*** + +### signed() + +> **signed**(`signature`): [`PendingTransaction`](PendingTransaction.md) + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L95) + +#### Parameters + +##### signature + +`Signature` + +#### Returns + +[`PendingTransaction`](PendingTransaction.md) + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`signed`](UnsignedTransaction.md#signed) + +*** + +### toJSON() + +> **toJSON**(): `PendingTransactionJSONType` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:153](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L153) + +#### Returns + +`PendingTransactionJSONType` + +*** + +### toProtocolTransaction() + +> **toProtocolTransaction**(): [`SignedTransaction`](../../protocol/classes/SignedTransaction.md) + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:171](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L171) + +#### Returns + +[`SignedTransaction`](../../protocol/classes/SignedTransaction.md) + +*** + +### toRuntimeTransaction() + +> **toRuntimeTransaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L85) + +#### Returns + +[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +#### Inherited from + +[`UnsignedTransaction`](UnsignedTransaction.md).[`toRuntimeTransaction`](UnsignedTransaction.md#toruntimetransaction) + +*** + +### fromJSON() + +> `static` **fromJSON**(`object`): [`PendingTransaction`](PendingTransaction.md) + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:124](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L124) + +#### Parameters + +##### object + +`PendingTransactionJSONType` + +#### Returns + +[`PendingTransaction`](PendingTransaction.md) diff --git a/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md b/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md new file mode 100644 index 0000000..8efb0a3 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md @@ -0,0 +1,102 @@ +--- +title: PreFilledStateService +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PreFilledStateService + +# Class: PreFilledStateService + +Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L4) + +Naive implementation of an in-memory variant of the StateService interface + +## Extends + +- [`InMemoryStateService`](../../module/classes/InMemoryStateService.md) + +## Constructors + +### new PreFilledStateService() + +> **new PreFilledStateService**(`values`): [`PreFilledStateService`](PreFilledStateService.md) + +Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L5) + +#### Parameters + +##### values + +#### Returns + +[`PreFilledStateService`](PreFilledStateService.md) + +#### Overrides + +[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`constructor`](../../module/classes/InMemoryStateService.md#constructors) + +## Properties + +### values + +> **values**: `Record`\<`string`, `null` \| `Field`[]\> + +Defined in: packages/module/dist/state/InMemoryStateService.d.ts:11 + +This mapping container null values if the specific entry has been deleted. +This is used by the CachedState service to keep track of deletions + +#### Inherited from + +[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`values`](../../module/classes/InMemoryStateService.md#values) + +## Methods + +### get() + +> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> + +Defined in: packages/module/dist/state/InMemoryStateService.d.ts:12 + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| `Field`[]\> + +#### Inherited from + +[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`get`](../../module/classes/InMemoryStateService.md#get) + +*** + +### set() + +> **set**(`key`, `value`): `Promise`\<`void`\> + +Defined in: packages/module/dist/state/InMemoryStateService.d.ts:13 + +#### Parameters + +##### key + +`Field` + +##### value + +`undefined` | `Field`[] + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`set`](../../module/classes/InMemoryStateService.md#set) diff --git a/src/pages/docs/reference/sequencer/classes/PrivateMempool.md b/src/pages/docs/reference/sequencer/classes/PrivateMempool.md new file mode 100644 index 0000000..216903f --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/PrivateMempool.md @@ -0,0 +1,241 @@ +--- +title: PrivateMempool +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PrivateMempool + +# Class: PrivateMempool + +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L36) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](SequencerModule.md) + +## Implements + +- [`Mempool`](../interfaces/Mempool.md) + +## Constructors + +### new PrivateMempool() + +> **new PrivateMempool**(`transactionValidator`, `transactionStorage`, `protocol`, `sequencer`, `stateService`): [`PrivateMempool`](PrivateMempool.md) + +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L41) + +#### Parameters + +##### transactionValidator + +`TransactionValidator` + +##### transactionStorage + +[`TransactionStorage`](../interfaces/TransactionStorage.md) + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> + +##### sequencer + +[`Sequencer`](Sequencer.md)\<[`SequencerModulesRecord`](../type-aliases/SequencerModulesRecord.md)\> + +##### stateService + +[`AsyncStateService`](../interfaces/AsyncStateService.md) + +#### Returns + +[`PrivateMempool`](PrivateMempool.md) + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### events + +> `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`MempoolEvents`](../type-aliases/MempoolEvents.md)\> + +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L37) + +#### Implementation of + +[`Mempool`](../interfaces/Mempool.md).[`events`](../interfaces/Mempool.md#events) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### add() + +> **add**(`tx`): `Promise`\<`boolean`\> + +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L57) + +Add a transaction to the mempool + +#### Parameters + +##### tx + +[`PendingTransaction`](PendingTransaction.md) + +#### Returns + +`Promise`\<`boolean`\> + +The new commitment to the mempool + +#### Implementation of + +[`Mempool`](../interfaces/Mempool.md).[`add`](../interfaces/Mempool.md#add) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### getStagedNetworkState() + +> **getStagedNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:91](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L91) + +#### Returns + +`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +*** + +### getTxs() + +> **getTxs**(`limit`?): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> + +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:96](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L96) + +Retrieve all transactions that are currently in the mempool + +#### Parameters + +##### limit? + +`number` + +#### Returns + +`Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> + +#### Implementation of + +[`Mempool`](../interfaces/Mempool.md).[`getTxs`](../interfaces/Mempool.md#gettxs) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:200](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L200) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md new file mode 100644 index 0000000..8d818c9 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md @@ -0,0 +1,167 @@ +--- +title: ProofTaskSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ProofTaskSerializer + +# Class: ProofTaskSerializer\ + +Defined in: [packages/sequencer/src/helpers/utils.ts:100](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L100) + +## Extends + +- `ProofTaskSerializerBase`\<`PublicInputType`, `PublicOutputType`\> + +## Type Parameters + +• **PublicInputType** + +• **PublicOutputType** + +## Implements + +- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> + +## Constructors + +### new ProofTaskSerializer() + +> **new ProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`ProofTaskSerializer`](ProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> + +Defined in: [packages/sequencer/src/helpers/utils.ts:104](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L104) + +#### Parameters + +##### proofClass + +[`Subclass`](../../protocol/type-aliases/Subclass.md)\<*typeof* `Proof`\> + +#### Returns + +[`ProofTaskSerializer`](ProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> + +#### Overrides + +`ProofTaskSerializerBase.constructor` + +## Methods + +### fromJSON() + +> **fromJSON**(`json`): `Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> + +Defined in: [packages/sequencer/src/helpers/utils.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L112) + +#### Parameters + +##### json + +`string` + +#### Returns + +`Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) + +*** + +### fromJSONProof() + +> **fromJSONProof**(`jsonProof`): `Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> + +Defined in: [packages/sequencer/src/helpers/utils.ts:119](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L119) + +#### Parameters + +##### jsonProof + +`JsonProof` + +#### Returns + +`Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> + +*** + +### getDummy() + +> `protected` **getDummy**\<`T`\>(`c`, `jsonProof`): `T` + +Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L41) + +#### Type Parameters + +• **T** *extends* `Proof`\<`PublicInputType`, `PublicOutputType`\> \| `DynamicProof`\<`PublicInputType`, `PublicOutputType`\> + +#### Parameters + +##### c + +[`TypedClass`](../type-aliases/TypedClass.md)\<`T`\> + +##### jsonProof + +`JsonProof` + +#### Returns + +`T` + +#### Inherited from + +`ProofTaskSerializerBase.getDummy` + +*** + +### toJSON() + +> **toJSON**(`proof`): `string` + +Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L65) + +#### Parameters + +##### proof + +`Proof`\<`PublicInputType`, `PublicOutputType`\> | `DynamicProof`\<`PublicInputType`, `PublicOutputType`\> + +#### Returns + +`string` + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) + +#### Inherited from + +`ProofTaskSerializerBase.toJSON` + +*** + +### toJSONProof() + +> **toJSONProof**(`proof`): `JsonProof` + +Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L73) + +#### Parameters + +##### proof + +`Proof`\<`PublicInputType`, `PublicOutputType`\> | `DynamicProof`\<`PublicInputType`, `PublicOutputType`\> + +#### Returns + +`JsonProof` + +#### Inherited from + +`ProofTaskSerializerBase.toJSONProof` diff --git a/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md b/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md new file mode 100644 index 0000000..121012f --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md @@ -0,0 +1,91 @@ +--- +title: ProvenSettlementPermissions +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ProvenSettlementPermissions + +# Class: ProvenSettlementPermissions + +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L5) + +## Implements + +- [`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md) + +## Constructors + +### new ProvenSettlementPermissions() + +> **new ProvenSettlementPermissions**(): [`ProvenSettlementPermissions`](ProvenSettlementPermissions.md) + +#### Returns + +[`ProvenSettlementPermissions`](ProvenSettlementPermissions.md) + +## Methods + +### bridgeContractMina() + +> **bridgeContractMina**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L35) + +#### Returns + +`Permissions` + +#### Implementation of + +[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`bridgeContractMina`](../interfaces/BaseLayerContractPermissions.md#bridgecontractmina) + +*** + +### bridgeContractToken() + +> **bridgeContractToken**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L39) + +#### Returns + +`Permissions` + +#### Implementation of + +[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`bridgeContractToken`](../interfaces/BaseLayerContractPermissions.md#bridgecontracttoken) + +*** + +### dispatchContract() + +> **dispatchContract**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L31) + +#### Returns + +`Permissions` + +#### Implementation of + +[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`dispatchContract`](../interfaces/BaseLayerContractPermissions.md#dispatchcontract) + +*** + +### settlementContract() + +> **settlementContract**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L27) + +#### Returns + +`Permissions` + +#### Implementation of + +[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`settlementContract`](../interfaces/BaseLayerContractPermissions.md#settlementcontract) diff --git a/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md b/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md new file mode 100644 index 0000000..931dda9 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md @@ -0,0 +1,152 @@ +--- +title: ReductionTaskFlow +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ReductionTaskFlow + +# Class: ReductionTaskFlow\ + +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L30) + +This class builds and executes a flow that follows the map-reduce pattern. +This works in 2 steps: +1. Mapping: Execute the mappingTask to transform from Input -> Output +2. Reduction: Find suitable pairs and merge them [Output, Output] -> Output + +We use this pattern extensively in our pipeline, + +## Type Parameters + +• **Input** + +• **Output** + +## Constructors + +### new ReductionTaskFlow() + +> **new ReductionTaskFlow**\<`Input`, `Output`\>(`options`, `flowCreator`): [`ReductionTaskFlow`](ReductionTaskFlow.md)\<`Input`, `Output`\> + +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L37) + +#### Parameters + +##### options + +###### inputLength + +`number` + +###### mappingTask + +[`Task`](../interfaces/Task.md)\<`Input`, `Output`\> + +###### mergableFunction + +(`a`, `b`) => `boolean` + +###### name + +`string` + +###### reductionTask + +[`Task`](../interfaces/Task.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<`Output`\>, `Output`\> + +##### flowCreator + +[`FlowCreator`](FlowCreator.md) + +#### Returns + +[`ReductionTaskFlow`](ReductionTaskFlow.md)\<`Input`, `Output`\> + +## Methods + +### deferErrorsTo() + +> **deferErrorsTo**(`flow`): `void` + +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:184](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L184) + +To be used in conjunction with onCompletion +It allows errors from this flow to be "defered" to another parent +flow which might be properly awaited and therefore will throw the +error up to the user + +#### Parameters + +##### flow + +[`Flow`](Flow.md)\<`unknown`\> + +#### Returns + +`void` + +*** + +### execute() + +> **execute**(`inputs`): `Promise`\<`Output`\> + +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:193](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L193) + +Execute the flow using the returned Promise that resolved when +the flow is finished + +#### Parameters + +##### inputs + +`Input`[] = `[]` + +initial inputs - doesnt have to be the complete set of inputs + +#### Returns + +`Promise`\<`Output`\> + +*** + +### onCompletion() + +> **onCompletion**(`callback`): `void` + +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:173](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L173) + +Execute the flow using a callback method that is invoked upon +completion of the flow. +Push inputs using pushInput() + +#### Parameters + +##### callback + +(`output`) => `Promise`\<`void`\> + +#### Returns + +`void` + +*** + +### pushInput() + +> **pushInput**(`input`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:205](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L205) + +#### Parameters + +##### input + +`Input` + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md new file mode 100644 index 0000000..837a73f --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md @@ -0,0 +1,71 @@ +--- +title: RuntimeProofParametersSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / RuntimeProofParametersSerializer + +# Class: RuntimeProofParametersSerializer + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L11) + +## Implements + +- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md)\> + +## Constructors + +### new RuntimeProofParametersSerializer() + +> **new RuntimeProofParametersSerializer**(): [`RuntimeProofParametersSerializer`](RuntimeProofParametersSerializer.md) + +#### Returns + +[`RuntimeProofParametersSerializer`](RuntimeProofParametersSerializer.md) + +## Methods + +### fromJSON() + +> **fromJSON**(`json`): [`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L29) + +#### Parameters + +##### json + +`string` + +#### Returns + +[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md) + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) + +*** + +### toJSON() + +> **toJSON**(`parameters`): `string` + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L14) + +#### Parameters + +##### parameters + +[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md) + +#### Returns + +`string` + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md b/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md new file mode 100644 index 0000000..8394d97 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md @@ -0,0 +1,222 @@ +--- +title: RuntimeProvingTask +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / RuntimeProvingTask + +# Class: RuntimeProvingTask + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L36) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`TaskWorkerModule`](TaskWorkerModule.md) + +## Implements + +- [`Task`](../interfaces/Task.md)\<[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md), `RuntimeProof`\> + +## Constructors + +### new RuntimeProvingTask() + +> **new RuntimeProvingTask**(`runtime`, `executionContext`, `compileRegistry`): [`RuntimeProvingTask`](RuntimeProvingTask.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L45) + +#### Parameters + +##### runtime + +[`Runtime`](../../module/classes/Runtime.md)\<`never`\> + +##### executionContext + +[`RuntimeMethodExecutionContext`](../../protocol/classes/RuntimeMethodExecutionContext.md) + +##### compileRegistry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +[`RuntimeProvingTask`](RuntimeProvingTask.md) + +#### Overrides + +[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) + +*** + +### name + +> **name**: `string` = `"runtimeProof"` + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L43) + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) + +*** + +### runtime + +> `protected` `readonly` **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<`never`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L46) + +*** + +### runtimeZkProgrammable + +> `protected` `readonly` **runtimeZkProgrammable**: [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\>[] + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L40) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) + +## Methods + +### compute() + +> **compute**(`input`): `Promise`\<`RuntimeProof`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L61) + +#### Parameters + +##### input + +[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md) + +#### Returns + +`Promise`\<`RuntimeProof`\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) + +*** + +### inputSerializer() + +> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L53) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) + +*** + +### prepare() + +> **prepare**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:107](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L107) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) + +*** + +### resultSerializer() + +> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`RuntimeProof`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L57) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<`RuntimeProof`\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md b/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md new file mode 100644 index 0000000..199ebb2 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md @@ -0,0 +1,97 @@ +--- +title: RuntimeVerificationKeyAttestationSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / RuntimeVerificationKeyAttestationSerializer + +# Class: RuntimeVerificationKeyAttestationSerializer + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L9) + +## Constructors + +### new RuntimeVerificationKeyAttestationSerializer() + +> **new RuntimeVerificationKeyAttestationSerializer**(): [`RuntimeVerificationKeyAttestationSerializer`](RuntimeVerificationKeyAttestationSerializer.md) + +#### Returns + +[`RuntimeVerificationKeyAttestationSerializer`](RuntimeVerificationKeyAttestationSerializer.md) + +## Methods + +### fromJSON() + +> `static` **fromJSON**(`json`): [`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L10) + +#### Parameters + +##### json + +###### verificationKey + +\{ `data`: `string`; `hash`: `string`; \} + +###### verificationKey.data + +`string` + +###### verificationKey.hash + +`string` + +###### witness + +\{ `isLeft`: `boolean`[]; `path`: `string`[]; \} + +###### witness.isLeft + +`boolean`[] + +###### witness.path + +`string`[] + +#### Returns + +[`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) + +*** + +### toJSON() + +> `static` **toJSON**(`attestation`): `object` + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L20) + +#### Parameters + +##### attestation + +[`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) + +#### Returns + +`object` + +##### verificationKey + +> **verificationKey**: [`VerificationKeyJSON`](../type-aliases/VerificationKeyJSON.md) + +##### witness + +> **witness**: `object` + +###### witness.isLeft + +> **witness.isLeft**: `boolean`[] + +###### witness.path + +> **witness.path**: `string`[] diff --git a/src/pages/docs/reference/sequencer/classes/Sequencer.md b/src/pages/docs/reference/sequencer/classes/Sequencer.md new file mode 100644 index 0000000..c63c90a --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/Sequencer.md @@ -0,0 +1,687 @@ +--- +title: Sequencer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Sequencer + +# Class: Sequencer\ + +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L30) + +Reusable module container facilitating registration, resolution +configuration, decoration and validation of modules + +## Extends + +- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Modules`\> + +## Type Parameters + +• **Modules** *extends* [`SequencerModulesRecord`](../type-aliases/SequencerModulesRecord.md) + +## Implements + +- [`Sequenceable`](../interfaces/Sequenceable.md) + +## Constructors + +### new Sequencer() + +> **new Sequencer**\<`Modules`\>(`definition`): [`Sequencer`](Sequencer.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:68 + +#### Parameters + +##### definition + +[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +#### Returns + +[`Sequencer`](Sequencer.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) + +*** + +### definition + +> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:116 + +##### Returns + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:117 + +##### Parameters + +###### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +##### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) + +*** + +### container + +#### Get Signature + +> **get** `protected` **container**(): `DependencyContainer` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 + +##### Returns + +`DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) + +*** + +### dependencyContainer + +#### Get Signature + +> **get** **dependencyContainer**(): `DependencyContainer` + +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L61) + +##### Returns + +`DependencyContainer` + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:99 + +##### Returns + +[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) + +*** + +### moduleNames + +#### Get Signature + +> **get** **moduleNames**(): `string`[] + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:72 + +##### Returns + +`string`[] + +list of module names + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) + +*** + +### protocol + +#### Get Signature + +> **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> + +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L53) + +##### Returns + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> + +*** + +### runtime + +#### Get Signature + +> **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> + +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L49) + +##### Returns + +[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> + +## Methods + +### assertContainerInitialized() + +> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:89 + +#### Parameters + +##### container + +`undefined` | `DependencyContainer` + +#### Returns + +`asserts container is DependencyContainer` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) + +*** + +### assertIsValidModuleName() + +> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:87 + +Assert that the iterated `moduleName` is of ModuleName type, +otherwise it may be just string e.g. when modules are iterated over +using e.g. a for loop. + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`asserts moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) + +*** + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:125](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L125) + +#### Returns + +`Promise`\<`void`\> + +*** + +### configure() + +> **configure**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:114 + +Provide additional configuration after the ModuleContainer was created. + +Keep in mind that modules are only decorated once after they are resolved, +therefore applying any configuration must happen +before the first resolution. + +#### Parameters + +##### config + +[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) + +*** + +### configurePartial() + +> **configurePartial**(`config`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 + +#### Parameters + +##### config + +[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:160 + +This is a placeholder for individual modules to override. +This method will be called whenever the underlying container fully +initialized + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) + +*** + +### decorateModule() + +> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:134 + +Override this in the child class to provide custom +features or module checks + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +`InstanceType`\<`Modules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>\]\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) + +*** + +### initializeDependencyFactories() + +> `protected` **initializeDependencyFactories**(`factories`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:140 + +Inject a set of dependencies using the given list of DependencyFactories +This method should be called during startup + +#### Parameters + +##### factories + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>[] + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) + +*** + +### isValidModuleName() + +> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:88 + +#### Parameters + +##### modules + +`Modules` + +##### moduleName + +`string` | `number` | `symbol` + +#### Returns + +`moduleName is StringKeyOf` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) + +*** + +### onAfterModuleResolution() + +> `protected` **onAfterModuleResolution**(`moduleName`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:154 + +Handle module resolution, e.g. by decorating resolved modules + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) + +*** + +### registerAliases() + +> `protected` **registerAliases**(`originalToken`, `clas`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:90 + +#### Parameters + +##### originalToken + +`string` + +##### clas + +[`TypedClass`](../type-aliases/TypedClass.md)\<`any`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) + +*** + +### registerClasses() + +> `protected` **registerClasses**(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:105 + +#### Parameters + +##### modules + +`Record`\<`string`, [`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\>\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) + +*** + +### registerModules() + +> `protected` **registerModules**(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:98 + +Register modules into the current container, and registers +a respective resolution hook in order to decorate the module +upon/after resolution. + +#### Parameters + +##### modules + +`Modules` + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) + +*** + +### registerValue() + +> **registerValue**\<`Value`\>(`modules`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:104 + +Register a non-module value into the current container + +#### Type Parameters + +• **Value** + +#### Parameters + +##### modules + +`Record`\<`string`, `Value`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) + +*** + +### resolve() + +> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:128 + +Resolves a module from the current module container + +We have to narrow down the `ModuleName` type here to +`ResolvableModuleName`, otherwise the resolved value might +be any module instance, not the one specifically requested as argument. + +#### Type Parameters + +• **KeyType** *extends* `string` + +#### Parameters + +##### moduleName + +`KeyType` + +#### Returns + +`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) + +*** + +### resolveOrFail() + +> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 + +#### Type Parameters + +• **ModuleType** + +#### Parameters + +##### moduleName + +`string` + +##### moduleType + +[`TypedClass`](../type-aliases/TypedClass.md)\<`ModuleType`\> + +#### Returns + +`ModuleType` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L69) + +Starts the sequencer by iterating over all provided +modules to start each + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Sequenceable`](../interfaces/Sequenceable.md).[`start`](../interfaces/Sequenceable.md#start) + +*** + +### validateModule() + +> `protected` **validateModule**(`moduleName`, `containedModule`): `void` + +Defined in: packages/common/dist/config/ModuleContainer.d.ts:80 + +Check if the provided module satisfies the container requirements, +such as only injecting other known modules. + +#### Parameters + +##### moduleName + +[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> + +##### containedModule + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> + +#### Returns + +`void` + +#### Inherited from + +[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) + +*** + +### from() + +> `static` **from**\<`Modules`\>(`definition`): [`TypedClass`](../type-aliases/TypedClass.md)\<[`Sequencer`](Sequencer.md)\<`Modules`\>\> + +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L39) + +Alternative constructor for Sequencer + +#### Type Parameters + +• **Modules** *extends* [`SequencerModulesRecord`](../type-aliases/SequencerModulesRecord.md) + +#### Parameters + +##### definition + +[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> + +#### Returns + +[`TypedClass`](../type-aliases/TypedClass.md)\<[`Sequencer`](Sequencer.md)\<`Modules`\>\> + +Sequencer diff --git a/src/pages/docs/reference/sequencer/classes/SequencerModule.md b/src/pages/docs/reference/sequencer/classes/SequencerModule.md new file mode 100644 index 0000000..e25be11 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/SequencerModule.md @@ -0,0 +1,155 @@ +--- +title: SequencerModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SequencerModule + +# Class: `abstract` SequencerModule\ + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L15) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> + +## Extended by + +- [`PrivateMempool`](PrivateMempool.md) +- [`AbstractTaskQueue`](AbstractTaskQueue.md) +- [`MinaBaseLayer`](MinaBaseLayer.md) +- [`NoopBaseLayer`](NoopBaseLayer.md) +- [`BlockTriggerBase`](BlockTriggerBase.md) +- [`BatchProducerModule`](BatchProducerModule.md) +- [`BlockProducerModule`](BlockProducerModule.md) +- [`SequencerStartupModule`](SequencerStartupModule.md) +- [`InMemoryDatabase`](InMemoryDatabase.md) +- [`DatabasePruneModule`](DatabasePruneModule.md) +- [`SettlementModule`](SettlementModule.md) +- [`WithdrawalQueue`](WithdrawalQueue.md) +- [`GraphqlServer`](../../api/classes/GraphqlServer.md) +- [`IndexerNotifier`](../../indexer/classes/IndexerNotifier.md) +- [`PrismaDatabaseConnection`](../../persistance/classes/PrismaDatabaseConnection.md) +- [`PrismaRedisDatabase`](../../persistance/classes/PrismaRedisDatabase.md) +- [`RedisConnectionModule`](../../persistance/classes/RedisConnectionModule.md) + +## Type Parameters + +• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) + +## Constructors + +### new SequencerModule() + +> **new SequencerModule**\<`Config`\>(): [`SequencerModule`](SequencerModule.md)\<`Config`\> + +#### Returns + +[`SequencerModule`](SequencerModule.md)\<`Config`\> + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) + +*** + +### start() + +> `abstract` **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md b/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md new file mode 100644 index 0000000..456b31e --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md @@ -0,0 +1,205 @@ +--- +title: SequencerStartupModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SequencerStartupModule + +# Class: SequencerStartupModule + +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L28) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](SequencerModule.md) + +## Implements + +- [`Closeable`](../interfaces/Closeable.md) + +## Constructors + +### new SequencerStartupModule() + +> **new SequencerStartupModule**(`flowCreator`, `protocol`, `compileTask`, `verificationKeyService`, `registrationFlow`, `compileRegistry`): [`SequencerStartupModule`](SequencerStartupModule.md) + +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L32) + +#### Parameters + +##### flowCreator + +[`FlowCreator`](FlowCreator.md) + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> + +##### compileTask + +`CircuitCompilerTask` + +##### verificationKeyService + +`VerificationKeyService` + +##### registrationFlow + +`WorkerRegistrationFlow` + +##### compileRegistry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +[`SequencerStartupModule`](SequencerStartupModule.md) + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:153](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L153) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Closeable`](../interfaces/Closeable.md).[`close`](../interfaces/Closeable.md#close) + +*** + +### compileRuntime() + +> **compileRuntime**(`flow`): `Promise`\<`bigint`\> + +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L55) + +#### Parameters + +##### flow + +[`Flow`](Flow.md)\<\{\}\> + +#### Returns + +`Promise`\<`bigint`\> + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L122) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/SettlementModule.md b/src/pages/docs/reference/sequencer/classes/SettlementModule.md new file mode 100644 index 0000000..e222860 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/SettlementModule.md @@ -0,0 +1,422 @@ +--- +title: SettlementModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettlementModule + +# Class: SettlementModule + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L62) + +Lifecycle of a SequencerModule + +start(): Executed to execute any logic required to start the module + +## Extends + +- [`SequencerModule`](SequencerModule.md)\<[`SettlementModuleConfig`](../interfaces/SettlementModuleConfig.md)\> + +## Implements + +- [`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md)\<[`SettlementModuleEvents`](../type-aliases/SettlementModuleEvents.md)\> +- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) + +## Constructors + +### new SettlementModule() + +> **new SettlementModule**(`baseLayer`, `protocol`, `incomingMessagesAdapter`, `messageStorage`, `blockProofSerializer`, `transactionSender`, `areProofsEnabled`, `feeStrategy`, `settlementStartupModule`): [`SettlementModule`](SettlementModule.md) + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L86) + +#### Parameters + +##### baseLayer + +[`MinaBaseLayer`](MinaBaseLayer.md) + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> + +##### incomingMessagesAdapter + +[`IncomingMessageAdapter`](../interfaces/IncomingMessageAdapter.md) + +##### messageStorage + +[`MessageStorage`](../interfaces/MessageStorage.md) + +##### blockProofSerializer + +[`BlockProofSerializer`](BlockProofSerializer.md) + +##### transactionSender + +[`MinaTransactionSender`](MinaTransactionSender.md) + +##### areProofsEnabled + +[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +##### feeStrategy + +`FeeStrategy` + +##### settlementStartupModule + +`SettlementStartupModule` + +#### Returns + +[`SettlementModule`](SettlementModule.md) + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### addresses? + +> `optional` **addresses**: `object` + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L71) + +#### dispatch + +> **dispatch**: `PublicKey` + +#### settlement + +> **settlement**: `PublicKey` + +*** + +### contracts? + +> `protected` `optional` **contracts**: `object` + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L66) + +#### dispatch + +> **dispatch**: [`DispatchSmartContract`](../../protocol/classes/DispatchSmartContract.md) + +#### settlement + +> **settlement**: [`SettlementSmartContract`](../../protocol/classes/SettlementSmartContract.md) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`SettlementModuleConfig`](../interfaces/SettlementModuleConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### events + +> **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`SettlementModuleEvents`](../type-aliases/SettlementModuleEvents.md)\> + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L84) + +#### Implementation of + +[`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md).[`events`](../../common/interfaces/EventEmittingComponent.md#events) + +*** + +### keys? + +> `optional` **keys**: `object` + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L76) + +#### dispatch + +> **dispatch**: `PrivateKey` + +#### minaBridge + +> **minaBridge**: `PrivateKey` + +#### settlement + +> **settlement**: `PrivateKey` + +*** + +### utils + +> **utils**: `SettlementUtils` + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L82) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### dependencies() + +> **dependencies**(): `object` + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:106](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L106) + +#### Returns + +`object` + +##### BridgingModule + +> **BridgingModule**: `object` + +###### BridgingModule.useClass + +> **BridgingModule.useClass**: *typeof* `BridgingModule` = `BridgingModule` + +#### Implementation of + +[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) + +*** + +### deploy() + +> **deploy**(`settlementKey`, `dispatchKey`, `minaBridgeKey`, `options`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:243](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L243) + +#### Parameters + +##### settlementKey + +`PrivateKey` + +##### dispatchKey + +`PrivateKey` + +##### minaBridgeKey + +`PrivateKey` + +##### options + +###### nonce + +`number` + +#### Returns + +`Promise`\<`void`\> + +*** + +### deployTokenBridge() + +> **deployTokenBridge**(`owner`, `ownerKey`, `contractKey`, `options`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:343](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L343) + +#### Parameters + +##### owner + +`TokenContractV2` + +##### ownerKey + +`PrivateKey` + +##### contractKey + +`PrivateKey` + +##### options + +###### nonce + +`number` + +#### Returns + +`Promise`\<`void`\> + +*** + +### getContracts() + +> **getContracts**(): `object` + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:127](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L127) + +#### Returns + +`object` + +##### dispatch + +> **dispatch**: [`DispatchSmartContract`](../../protocol/classes/DispatchSmartContract.md) + +##### settlement + +> **settlement**: [`SettlementSmartContract`](../../protocol/classes/SettlementSmartContract.md) + +*** + +### settleBatch() + +> **settleBatch**(`batch`, `options`): `Promise`\<[`Settlement`](../interfaces/Settlement.md)\> + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:164](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L164) + +#### Parameters + +##### batch + +[`SettleableBatch`](../interfaces/SettleableBatch.md) + +##### options + +###### nonce + +`number` + +#### Returns + +`Promise`\<[`Settlement`](../interfaces/Settlement.md)\> + +*** + +### settlementContractModule() + +> `protected` **settlementContractModule**(): [`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md)\<[`MandatorySettlementModulesRecord`](../../protocol/type-aliases/MandatorySettlementModulesRecord.md)\> + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L114) + +#### Returns + +[`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md)\<[`MandatorySettlementModulesRecord`](../../protocol/type-aliases/MandatorySettlementModulesRecord.md)\> + +*** + +### signTransaction() + +> **signTransaction**(`tx`, `pks`): `Transaction`\<`false`, `true`\> + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:149](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L149) + +#### Parameters + +##### tx + +`Transaction`\<`false`, `false`\> + +##### pks + +`PrivateKey`[] + +#### Returns + +`Transaction`\<`false`, `true`\> + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:387](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L387) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md b/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md new file mode 100644 index 0000000..f3301cc --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md @@ -0,0 +1,217 @@ +--- +title: SettlementProvingTask +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettlementProvingTask + +# Class: SettlementProvingTask + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L72) + +Implementation of a task to prove any Mina transaction. +The o1js-internal account state is configurable via the task args. +It also dynamically retrieves the proof generation parameters from +the provided AccountUpdate + +## Extends + +- [`TaskWorkerModule`](TaskWorkerModule.md) + +## Implements + +- [`Task`](../interfaces/Task.md)\<[`TransactionTaskArgs`](../type-aliases/TransactionTaskArgs.md), [`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> + +## Constructors + +### new SettlementProvingTask() + +> **new SettlementProvingTask**(`protocol`, `compileRegistry`, `areProofsEnabled`): [`SettlementProvingTask`](SettlementProvingTask.md) + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L84) + +#### Parameters + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> + +##### compileRegistry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +##### areProofsEnabled + +[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) + +#### Returns + +[`SettlementProvingTask`](SettlementProvingTask.md) + +#### Overrides + +[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) + +*** + +### name + +> **name**: `string` = `"settlementTransactions"` + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L76) + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) + +*** + +### settlementContractModule + +> **settlementContractModule**: `undefined` \| [`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md)\<[`MandatorySettlementModulesRecord`](../../protocol/type-aliases/MandatorySettlementModulesRecord.md)\> = `undefined` + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L78) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) + +## Methods + +### compute() + +> **compute**(`input`): `Promise`\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:125](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L125) + +#### Parameters + +##### input + +[`TransactionTaskArgs`](../type-aliases/TransactionTaskArgs.md) + +#### Returns + +`Promise`\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) + +*** + +### inputSerializer() + +> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskArgs`](../type-aliases/TransactionTaskArgs.md)\> + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:158](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L158) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskArgs`](../type-aliases/TransactionTaskArgs.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) + +*** + +### prepare() + +> **prepare**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:395](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L395) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) + +*** + +### resultSerializer() + +> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:432](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L432) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md b/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md new file mode 100644 index 0000000..b68c400 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md @@ -0,0 +1,91 @@ +--- +title: SignedSettlementPermissions +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SignedSettlementPermissions + +# Class: SignedSettlementPermissions + +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L5) + +## Implements + +- [`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md) + +## Constructors + +### new SignedSettlementPermissions() + +> **new SignedSettlementPermissions**(): [`SignedSettlementPermissions`](SignedSettlementPermissions.md) + +#### Returns + +[`SignedSettlementPermissions`](SignedSettlementPermissions.md) + +## Methods + +### bridgeContractMina() + +> **bridgeContractMina**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L28) + +#### Returns + +`Permissions` + +#### Implementation of + +[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`bridgeContractMina`](../interfaces/BaseLayerContractPermissions.md#bridgecontractmina) + +*** + +### bridgeContractToken() + +> **bridgeContractToken**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L32) + +#### Returns + +`Permissions` + +#### Implementation of + +[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`bridgeContractToken`](../interfaces/BaseLayerContractPermissions.md#bridgecontracttoken) + +*** + +### dispatchContract() + +> **dispatchContract**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L20) + +#### Returns + +`Permissions` + +#### Implementation of + +[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`dispatchContract`](../interfaces/BaseLayerContractPermissions.md#dispatchcontract) + +*** + +### settlementContract() + +> **settlementContract**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L24) + +#### Returns + +`Permissions` + +#### Implementation of + +[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`settlementContract`](../interfaces/BaseLayerContractPermissions.md#settlementcontract) diff --git a/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md b/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md new file mode 100644 index 0000000..362a97d --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md @@ -0,0 +1,301 @@ +--- +title: SomeProofSubclass +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SomeProofSubclass + +# Class: SomeProofSubclass + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L58) + +## Extends + +- `Proof`\<`Field`, `Void`\> + +## Constructors + +### new SomeProofSubclass() + +> **new SomeProofSubclass**(`__namedParameters`): [`SomeProofSubclass`](SomeProofSubclass.md) + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:94 + +#### Parameters + +##### \_\_namedParameters + +###### maxProofsVerified + +`0` \| `1` \| `2` + +###### proof + +`unknown` + +###### publicInput + +`Field` + +###### publicOutput + +`undefined` + +#### Returns + +[`SomeProofSubclass`](SomeProofSubclass.md) + +#### Inherited from + +`Proof.constructor` + +## Properties + +### maxProofsVerified + +> **maxProofsVerified**: `0` \| `1` \| `2` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:91 + +#### Inherited from + +`Proof.maxProofsVerified` + +*** + +### proof + +> **proof**: `unknown` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:90 + +#### Inherited from + +`Proof.proof` + +*** + +### publicInput + +> **publicInput**: `Field` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:88 + +#### Inherited from + +`Proof.publicInput` + +*** + +### publicOutput + +> **publicOutput**: `undefined` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:89 + +#### Inherited from + +`Proof.publicOutput` + +*** + +### shouldVerify + +> **shouldVerify**: `Bool` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:92 + +#### Inherited from + +`Proof.shouldVerify` + +*** + +### publicInputType + +> `static` **publicInputType**: *typeof* `Field` & (`x`) => `Field` = `Field` + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L59) + +#### Overrides + +`Proof.publicInputType` + +*** + +### publicOutputType + +> `static` **publicOutputType**: `ProvablePureExtended`\<`void`, `void`, `null`\> = `Void` + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L61) + +#### Overrides + +`Proof.publicOutputType` + +*** + +### tag() + +> `static` **tag**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:85 + +#### Returns + +`object` + +##### name + +> **name**: `string` + +#### Inherited from + +`Proof.tag` + +## Methods + +### toJSON() + +> **toJSON**(): `JsonProof` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:93 + +#### Returns + +`JsonProof` + +#### Inherited from + +`Proof.toJSON` + +*** + +### verify() + +> **verify**(): `void` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:102 + +#### Returns + +`void` + +#### Inherited from + +`Proof.verify` + +*** + +### verifyIf() + +> **verifyIf**(`condition`): `void` + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:103 + +#### Parameters + +##### condition + +`Bool` + +#### Returns + +`void` + +#### Inherited from + +`Proof.verifyIf` + +*** + +### dummy() + +> `static` **dummy**\<`Input`, `OutPut`\>(`publicInput`, `publicOutput`, `maxProofsVerified`, `domainLog2`?): `Promise`\<`Proof`\<`Input`, `OutPut`\>\> + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:126 + +Dummy proof. This can be useful for ZkPrograms that handle the base case in the same +method as the inductive case, using a pattern like this: + +```ts +method(proof: SelfProof, isRecursive: Bool) { + proof.verifyIf(isRecursive); + // ... +} +``` + +To use such a method in the base case, you need a dummy proof: + +```ts +let dummy = await MyProof.dummy(publicInput, publicOutput, 1); +await myProgram.myMethod(dummy, Bool(false)); +``` + +**Note**: The types of `publicInput` and `publicOutput`, as well as the `maxProofsVerified` parameter, +must match your ZkProgram. `maxProofsVerified` is the maximum number of proofs that any of your methods take as arguments. + +#### Type Parameters + +• **Input** + +• **OutPut** + +#### Parameters + +##### publicInput + +`Input` + +##### publicOutput + +`OutPut` + +##### maxProofsVerified + +`0` | `1` | `2` + +##### domainLog2? + +`number` + +#### Returns + +`Promise`\<`Proof`\<`Input`, `OutPut`\>\> + +#### Inherited from + +`Proof.dummy` + +*** + +### fromJSON() + +> `static` **fromJSON**\<`S`\>(`this`, `__namedParameters`): `Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:104 + +#### Type Parameters + +• **S** *extends* `Subclass`\<*typeof* `Proof`\> + +#### Parameters + +##### this + +`S` + +##### \_\_namedParameters + +`JsonProof` + +#### Returns + +`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> + +#### Inherited from + +`Proof.fromJSON` diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md new file mode 100644 index 0000000..b9bcd66 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md @@ -0,0 +1,71 @@ +--- +title: StateTransitionParametersSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateTransitionParametersSerializer + +# Class: StateTransitionParametersSerializer + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L21) + +## Implements + +- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md)\> + +## Constructors + +### new StateTransitionParametersSerializer() + +> **new StateTransitionParametersSerializer**(): [`StateTransitionParametersSerializer`](StateTransitionParametersSerializer.md) + +#### Returns + +[`StateTransitionParametersSerializer`](StateTransitionParametersSerializer.md) + +## Methods + +### fromJSON() + +> **fromJSON**(`json`): [`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L43) + +#### Parameters + +##### json + +`string` + +#### Returns + +[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md) + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) + +*** + +### toJSON() + +> **toJSON**(`parameters`): `string` + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L24) + +#### Parameters + +##### parameters + +[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md) + +#### Returns + +`string` + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md b/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md new file mode 100644 index 0000000..fae1607 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md @@ -0,0 +1,214 @@ +--- +title: StateTransitionReductionTask +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateTransitionReductionTask + +# Class: StateTransitionReductionTask + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L24) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`TaskWorkerModule`](TaskWorkerModule.md) + +## Implements + +- [`Task`](../interfaces/Task.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\>, [`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +## Constructors + +### new StateTransitionReductionTask() + +> **new StateTransitionReductionTask**(`protocol`, `executionContext`, `compileRegistry`): [`StateTransitionReductionTask`](StateTransitionReductionTask.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L32) + +#### Parameters + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> + +##### executionContext + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md) + +##### compileRegistry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +[`StateTransitionReductionTask`](StateTransitionReductionTask.md) + +#### Overrides + +[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) + +*** + +### name + +> **name**: `string` = `"stateTransitionReduction"` + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L30) + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) + +*** + +### stateTransitionProver + +> `protected` `readonly` **stateTransitionProver**: [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L28) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) + +## Methods + +### compute() + +> **compute**(`input`): `Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L56) + +#### Parameters + +##### input + +[`PairTuple`](../type-aliases/PairTuple.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +#### Returns + +`Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) + +*** + +### inputSerializer() + +> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\>\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L44) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\>\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) + +*** + +### prepare() + +> **prepare**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L66) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) + +*** + +### resultSerializer() + +> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L50) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md b/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md new file mode 100644 index 0000000..c503c80 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md @@ -0,0 +1,214 @@ +--- +title: StateTransitionTask +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateTransitionTask + +# Class: StateTransitionTask + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L38) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`TaskWorkerModule`](TaskWorkerModule.md) + +## Implements + +- [`Task`](../interfaces/Task.md)\<[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md), [`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +## Constructors + +### new StateTransitionTask() + +> **new StateTransitionTask**(`protocol`, `executionContext`, `compileRegistry`): [`StateTransitionTask`](StateTransitionTask.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L46) + +#### Parameters + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> + +##### executionContext + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md) + +##### compileRegistry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +[`StateTransitionTask`](StateTransitionTask.md) + +#### Overrides + +[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) + +*** + +### name + +> **name**: `string` = `"stateTransitionProof"` + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L44) + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) + +*** + +### stateTransitionProver + +> `protected` `readonly` **stateTransitionProver**: [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L42) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) + +## Methods + +### compute() + +> **compute**(`input`): `Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L68) + +#### Parameters + +##### input + +[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md) + +#### Returns + +`Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) + +*** + +### inputSerializer() + +> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L58) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) + +*** + +### prepare() + +> **prepare**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L88) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) + +*** + +### resultSerializer() + +> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L62) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md new file mode 100644 index 0000000..d0aba48 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md @@ -0,0 +1,123 @@ +--- +title: SyncCachedMerkleTreeStore +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SyncCachedMerkleTreeStore + +# Class: SyncCachedMerkleTreeStore + +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L7) + +## Extends + +- [`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md) + +## Constructors + +### new SyncCachedMerkleTreeStore() + +> **new SyncCachedMerkleTreeStore**(`parent`): [`SyncCachedMerkleTreeStore`](SyncCachedMerkleTreeStore.md) + +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L8) + +#### Parameters + +##### parent + +[`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) + +#### Returns + +[`SyncCachedMerkleTreeStore`](SyncCachedMerkleTreeStore.md) + +#### Overrides + +[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`constructor`](../../common/classes/InMemoryMerkleTreeStorage.md#constructors) + +## Properties + +### nodes + +> `protected` **nodes**: `object` + +Defined in: packages/common/dist/trees/InMemoryMerkleTreeStorage.d.ts:3 + +#### Index Signature + +\[`key`: `number`\]: `object` + +#### Inherited from + +[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`nodes`](../../common/classes/InMemoryMerkleTreeStorage.md#nodes) + +## Methods + +### getNode() + +> **getNode**(`key`, `level`): `undefined` \| `bigint` + +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L12) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +#### Returns + +`undefined` \| `bigint` + +#### Overrides + +[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`getNode`](../../common/classes/InMemoryMerkleTreeStorage.md#getnode) + +*** + +### mergeIntoParent() + +> **mergeIntoParent**(): `void` + +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L20) + +#### Returns + +`void` + +*** + +### setNode() + +> **setNode**(`key`, `level`, `value`): `void` + +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L16) + +#### Parameters + +##### key + +`bigint` + +##### level + +`number` + +##### value + +`bigint` + +#### Returns + +`void` + +#### Overrides + +[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`setNode`](../../common/classes/InMemoryMerkleTreeStorage.md#setnode) diff --git a/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md b/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md new file mode 100644 index 0000000..10f6278 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md @@ -0,0 +1,114 @@ +--- +title: TaskWorkerModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskWorkerModule + +# Class: `abstract` TaskWorkerModule + +Defined in: [packages/sequencer/src/worker/worker/TaskWorkerModule.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/TaskWorkerModule.ts#L3) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<[`NoConfig`](../../common/type-aliases/NoConfig.md)\> + +## Extended by + +- [`TransactionProvingTask`](TransactionProvingTask.md) +- [`RuntimeProvingTask`](RuntimeProvingTask.md) +- [`StateTransitionTask`](StateTransitionTask.md) +- [`StateTransitionReductionTask`](StateTransitionReductionTask.md) +- [`NewBlockTask`](NewBlockTask.md) +- [`SettlementProvingTask`](SettlementProvingTask.md) +- [`IndexBlockTask`](../../indexer/classes/IndexBlockTask.md) + +## Constructors + +### new TaskWorkerModule() + +> **new TaskWorkerModule**(): [`TaskWorkerModule`](TaskWorkerModule.md) + +#### Returns + +[`TaskWorkerModule`](TaskWorkerModule.md) + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) diff --git a/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md b/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md new file mode 100644 index 0000000..18a69ee --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md @@ -0,0 +1,345 @@ +--- +title: TimedBlockTrigger +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TimedBlockTrigger + +# Class: TimedBlockTrigger + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L36) + +A BlockTrigger is the primary method to start the production of a block and +all associated processes. + +## Extends + +- [`BlockTriggerBase`](BlockTriggerBase.md)\<[`TimedBlockTriggerConfig`](../interfaces/TimedBlockTriggerConfig.md), [`TimedBlockTriggerEvent`](../interfaces/TimedBlockTriggerEvent.md)\> + +## Implements + +- [`BlockTrigger`](../interfaces/BlockTrigger.md) +- [`Closeable`](../interfaces/Closeable.md) + +## Constructors + +### new TimedBlockTrigger() + +> **new TimedBlockTrigger**(`batchProducerModule`, `blockProducerModule`, `settlementModule`, `blockQueue`, `batchStorage`, `settlementStorage`, `mempool`): [`TimedBlockTrigger`](TimedBlockTrigger.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L44) + +#### Parameters + +##### batchProducerModule + +`undefined` | [`BatchProducerModule`](BatchProducerModule.md) + +##### blockProducerModule + +[`BlockProducerModule`](BlockProducerModule.md) + +##### settlementModule + +`undefined` | [`SettlementModule`](SettlementModule.md) + +##### blockQueue + +[`BlockQueue`](../interfaces/BlockQueue.md) + +##### batchStorage + +[`BatchStorage`](../interfaces/BatchStorage.md) + +##### settlementStorage + +`undefined` | [`SettlementStorage`](../interfaces/SettlementStorage.md) + +##### mempool + +[`Mempool`](../interfaces/Mempool.md) + +#### Returns + +[`TimedBlockTrigger`](TimedBlockTrigger.md) + +#### Overrides + +[`BlockTriggerBase`](BlockTriggerBase.md).[`constructor`](BlockTriggerBase.md#constructors) + +## Properties + +### batchProducerModule + +> `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`batchProducerModule`](BlockTriggerBase.md#batchproducermodule-1) + +*** + +### batchQueue + +> `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`batchQueue`](BlockTriggerBase.md#batchqueue-1) + +*** + +### blockProducerModule + +> `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`blockProducerModule`](BlockTriggerBase.md#blockproducermodule-1) + +*** + +### blockQueue + +> `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`blockQueue`](BlockTriggerBase.md#blockqueue-1) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`TimedBlockTriggerConfig`](../interfaces/TimedBlockTriggerConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`currentConfig`](BlockTriggerBase.md#currentconfig) + +*** + +### events + +> `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`TimedBlockTriggerEvent`](../interfaces/TimedBlockTriggerEvent.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`events`](BlockTriggerBase.md#events) + +*** + +### settlementModule + +> `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`settlementModule`](BlockTriggerBase.md#settlementmodule-1) + +*** + +### settlementStorage + +> `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`settlementStorage`](BlockTriggerBase.md#settlementstorage-1) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`presets`](BlockTriggerBase.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`config`](BlockTriggerBase.md#config) + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:137](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L137) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Closeable`](../interfaces/Closeable.md).[`close`](../interfaces/Closeable.md#close) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`create`](BlockTriggerBase.md#create) + +*** + +### produceBatch() + +> `protected` **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) + +#### Returns + +`Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBatch`](BlockTriggerBase.md#producebatch) + +*** + +### produceBlock() + +> `protected` **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) + +#### Returns + +`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBlock`](BlockTriggerBase.md#produceblock) + +*** + +### produceBlockWithResult() + +> `protected` **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBlockWithResult`](BlockTriggerBase.md#produceblockwithresult) + +*** + +### settle() + +> `protected` **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) + +#### Parameters + +##### batch + +[`SettleableBatch`](../interfaces/SettleableBatch.md) + +#### Returns + +`Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> + +#### Inherited from + +[`BlockTriggerBase`](BlockTriggerBase.md).[`settle`](BlockTriggerBase.md#settle) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:90](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L90) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`BlockTriggerBase`](BlockTriggerBase.md).[`start`](BlockTriggerBase.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md b/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md new file mode 100644 index 0000000..2abd21a --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md @@ -0,0 +1,65 @@ +--- +title: TransactionExecutionService +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionExecutionService + +# Class: TransactionExecutionService + +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:153](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L153) + +## Constructors + +### new TransactionExecutionService() + +> **new TransactionExecutionService**(`runtime`, `protocol`, `stateServiceProvider`): [`TransactionExecutionService`](TransactionExecutionService.md) + +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:156](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L156) + +#### Parameters + +##### runtime + +[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> + +##### stateServiceProvider + +[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) + +#### Returns + +[`TransactionExecutionService`](TransactionExecutionService.md) + +## Methods + +### createExecutionTrace() + +> **createExecutionTrace**(`asyncStateService`, `tx`, `networkState`): `Promise`\<[`TransactionExecutionResult`](../interfaces/TransactionExecutionResult.md)\> + +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:209](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L209) + +#### Parameters + +##### asyncStateService + +[`CachedStateService`](CachedStateService.md) + +##### tx + +[`PendingTransaction`](PendingTransaction.md) + +##### networkState + +[`NetworkState`](../../protocol/classes/NetworkState.md) + +#### Returns + +`Promise`\<[`TransactionExecutionResult`](../interfaces/TransactionExecutionResult.md)\> diff --git a/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md b/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md new file mode 100644 index 0000000..736b97a --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md @@ -0,0 +1,214 @@ +--- +title: TransactionProvingTask +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionProvingTask + +# Class: TransactionProvingTask + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L50) + +Used by various module sub-types that may need to be configured + +## Extends + +- [`TaskWorkerModule`](TaskWorkerModule.md) + +## Implements + +- [`Task`](../interfaces/Task.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md), [`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> + +## Constructors + +### new TransactionProvingTask() + +> **new TransactionProvingTask**(`protocol`, `runtime`, `stateServiceProvider`, `executionContext`, `compileRegistry`): [`TransactionProvingTask`](TransactionProvingTask.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L63) + +#### Parameters + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> + +##### runtime + +[`Runtime`](../../module/classes/Runtime.md)\<`never`\> + +##### stateServiceProvider + +[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) + +##### executionContext + +[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md) + +##### compileRegistry + +[`CompileRegistry`](../../common/classes/CompileRegistry.md) + +#### Returns + +[`TransactionProvingTask`](TransactionProvingTask.md) + +#### Overrides + +[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) + +*** + +### name + +> **name**: `string` = `"block"` + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L61) + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) + +## Methods + +### compute() + +> **compute**(`input`): `Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L114) + +#### Parameters + +##### input + +[`PairingDerivedInput`](../interfaces/PairingDerivedInput.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md), `RuntimeProof`, [`BlockProverParameters`](../interfaces/BlockProverParameters.md)\> + +#### Returns + +`Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) + +*** + +### inputSerializer() + +> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L79) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) + +*** + +### prepare() + +> **prepare**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L144) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) + +*** + +### resultSerializer() + +> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L92) + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> + +#### Implementation of + +[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md b/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md new file mode 100644 index 0000000..738d832 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md @@ -0,0 +1,83 @@ +--- +title: TransactionProvingTaskParameterSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionProvingTaskParameterSerializer + +# Class: TransactionProvingTaskParameterSerializer + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L18) + +## Implements + +- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> + +## Constructors + +### new TransactionProvingTaskParameterSerializer() + +> **new TransactionProvingTaskParameterSerializer**(`stProofSerializer`, `runtimeProofSerializer`): [`TransactionProvingTaskParameterSerializer`](TransactionProvingTaskParameterSerializer.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L21) + +#### Parameters + +##### stProofSerializer + +[`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`StateTransitionProverPublicInput`](../../protocol/classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../../protocol/classes/StateTransitionProverPublicOutput.md)\> + +##### runtimeProofSerializer + +[`ProofTaskSerializer`](ProofTaskSerializer.md)\<`undefined`, [`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> + +#### Returns + +[`TransactionProvingTaskParameterSerializer`](TransactionProvingTaskParameterSerializer.md) + +## Methods + +### fromJSON() + +> **fromJSON**(`json`): `Promise`\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L57) + +#### Parameters + +##### json + +`string` + +#### Returns + +`Promise`\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) + +*** + +### toJSON() + +> **toJSON**(`input`): `string` + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L32) + +#### Parameters + +##### input + +[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md) + +#### Returns + +`string` + +#### Implementation of + +[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) diff --git a/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md b/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md new file mode 100644 index 0000000..555f2db --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md @@ -0,0 +1,130 @@ +--- +title: TransactionTraceService +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionTraceService + +# Class: TransactionTraceService + +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L36) + +## Constructors + +### new TransactionTraceService() + +> **new TransactionTraceService**(): [`TransactionTraceService`](TransactionTraceService.md) + +#### Returns + +[`TransactionTraceService`](TransactionTraceService.md) + +## Methods + +### createBlockTrace() + +> **createBlockTrace**(`traces`, `stateServices`, `blockHashTreeStore`, `beforeBlockStateRoot`, `block`): `Promise`\<[`BlockTrace`](../interfaces/BlockTrace.md)\> + +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L78) + +#### Parameters + +##### traces + +[`TransactionTrace`](../interfaces/TransactionTrace.md)[] + +##### stateServices + +###### merkleStore + +[`CachedMerkleTreeStore`](CachedMerkleTreeStore.md) + +###### stateService + +[`CachedStateService`](CachedStateService.md) + +##### blockHashTreeStore + +[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) + +##### beforeBlockStateRoot + +`Field` + +##### block + +[`BlockWithResult`](../interfaces/BlockWithResult.md) + +#### Returns + +`Promise`\<[`BlockTrace`](../interfaces/BlockTrace.md)\> + +*** + +### createTransactionTrace() + +> **createTransactionTrace**(`executionResult`, `stateServices`, `verificationKeyService`, `networkState`, `bundleTracker`, `eternalBundleTracker`, `messageTracker`): `Promise`\<[`TransactionTrace`](../interfaces/TransactionTrace.md)\> + +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:172](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L172) + +What is in a trace? +A trace has two parts: +1. start values of storage keys accessed by all state transitions +2. Merkle Witnesses of the keys accessed by the state transitions + +How do we create a trace? + +1. We execute the transaction and create the stateTransitions +The first execution is done with a DummyStateService to find out the +accessed keys that can then be cached for the actual run, which generates +the correct state transitions and has to be done for the next +transactions to be based on the correct state. + +2. We extract the accessed keys, download the state and put it into +AppChainProveParams + +3. We retrieve merkle witnesses for each step and put them into +StateTransitionProveParams + +#### Parameters + +##### executionResult + +[`TransactionExecutionResult`](../interfaces/TransactionExecutionResult.md) + +##### stateServices + +###### merkleStore + +[`CachedMerkleTreeStore`](CachedMerkleTreeStore.md) + +###### stateService + +[`CachedStateService`](CachedStateService.md) + +##### verificationKeyService + +`VerificationKeyService` + +##### networkState + +[`NetworkState`](../../protocol/classes/NetworkState.md) + +##### bundleTracker + +[`ProvableHashList`](../../protocol/classes/ProvableHashList.md)\<`Field`\> + +##### eternalBundleTracker + +[`ProvableHashList`](../../protocol/classes/ProvableHashList.md)\<`Field`\> + +##### messageTracker + +[`ProvableHashList`](../../protocol/classes/ProvableHashList.md)\<`Field`\> + +#### Returns + +`Promise`\<[`TransactionTrace`](../interfaces/TransactionTrace.md)\> diff --git a/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md b/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md new file mode 100644 index 0000000..b3e07b4 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md @@ -0,0 +1,220 @@ +--- +title: UnsignedTransaction +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / UnsignedTransaction + +# Class: UnsignedTransaction + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L30) + +## Extended by + +- [`PendingTransaction`](PendingTransaction.md) + +## Implements + +- [`UnsignedTransactionBody`](../type-aliases/UnsignedTransactionBody.md) + +## Constructors + +### new UnsignedTransaction() + +> **new UnsignedTransaction**(`data`): [`UnsignedTransaction`](UnsignedTransaction.md) + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L43) + +#### Parameters + +##### data + +###### argsFields + +`Field`[] + +###### auxiliaryData + +`string`[] + +###### isMessage + +`boolean` + +###### methodId + +`Field` + +###### nonce + +`UInt64` + +###### sender + +`PublicKey` + +#### Returns + +[`UnsignedTransaction`](UnsignedTransaction.md) + +## Properties + +### argsFields + +> **argsFields**: `Field`[] + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L37) + +#### Implementation of + +`UnsignedTransactionBody.argsFields` + +*** + +### auxiliaryData + +> **auxiliaryData**: `string`[] + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L39) + +Used to transport non-provable data, mainly proof data for now +These values will not be part of the signature message or transaction hash + +#### Implementation of + +`UnsignedTransactionBody.auxiliaryData` + +*** + +### isMessage + +> **isMessage**: `boolean` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L41) + +#### Implementation of + +`UnsignedTransactionBody.isMessage` + +*** + +### methodId + +> **methodId**: `Field` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L31) + +#### Implementation of + +`UnsignedTransactionBody.methodId` + +*** + +### nonce + +> **nonce**: `UInt64` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L33) + +#### Implementation of + +`UnsignedTransactionBody.nonce` + +*** + +### sender + +> **sender**: `PublicKey` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L35) + +#### Implementation of + +`UnsignedTransactionBody.sender` + +## Methods + +### argsHash() + +> **argsHash**(): `Field` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L59) + +#### Returns + +`Field` + +*** + +### getSignatureData() + +> **getSignatureData**(): `Field`[] + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L72) + +#### Returns + +`Field`[] + +*** + +### hash() + +> **hash**(): `Field` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L63) + +#### Returns + +`Field` + +*** + +### sign() + +> **sign**(`privateKey`): [`PendingTransaction`](PendingTransaction.md) + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L80) + +#### Parameters + +##### privateKey + +`PrivateKey` + +#### Returns + +[`PendingTransaction`](PendingTransaction.md) + +*** + +### signed() + +> **signed**(`signature`): [`PendingTransaction`](PendingTransaction.md) + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L95) + +#### Parameters + +##### signature + +`Signature` + +#### Returns + +[`PendingTransaction`](PendingTransaction.md) + +*** + +### toRuntimeTransaction() + +> **toRuntimeTransaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L85) + +#### Returns + +[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) diff --git a/src/pages/docs/reference/sequencer/classes/UntypedOption.md b/src/pages/docs/reference/sequencer/classes/UntypedOption.md new file mode 100644 index 0000000..3dc282a --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/UntypedOption.md @@ -0,0 +1,264 @@ +--- +title: UntypedOption +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / UntypedOption + +# Class: UntypedOption + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L7) + +Option facilitating in-circuit values that may or may not exist. + +## Extends + +- [`OptionBase`](../../protocol/classes/OptionBase.md) + +## Constructors + +### new UntypedOption() + +> **new UntypedOption**(`isSome`, `value`, `enforceEmpty`): [`UntypedOption`](UntypedOption.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L32) + +#### Parameters + +##### isSome + +`Bool` + +##### value + +`Field`[] + +##### enforceEmpty + +`Bool` + +#### Returns + +[`UntypedOption`](UntypedOption.md) + +#### Overrides + +[`OptionBase`](../../protocol/classes/OptionBase.md).[`constructor`](../../protocol/classes/OptionBase.md#constructors) + +## Properties + +### isForcedSome + +> **isForcedSome**: `Bool` + +Defined in: packages/protocol/dist/model/Option.d.ts:60 + +#### Inherited from + +[`OptionBase`](../../protocol/classes/OptionBase.md).[`isForcedSome`](../../protocol/classes/OptionBase.md#isforcedsome-1) + +*** + +### isSome + +> **isSome**: `Bool` + +Defined in: packages/protocol/dist/model/Option.d.ts:59 + +#### Inherited from + +[`OptionBase`](../../protocol/classes/OptionBase.md).[`isSome`](../../protocol/classes/OptionBase.md#issome-1) + +*** + +### value + +> **value**: `Field`[] + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L34) + +## Accessors + +### treeValue + +#### Get Signature + +> **get** **treeValue**(): `Field` + +Defined in: packages/protocol/dist/model/Option.d.ts:67 + +##### Returns + +`Field` + +Tree representation of the current value + +#### Inherited from + +[`OptionBase`](../../protocol/classes/OptionBase.md).[`treeValue`](../../protocol/classes/OptionBase.md#treevalue) + +## Methods + +### clone() + +> **clone**(): [`UntypedOption`](UntypedOption.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L40) + +#### Returns + +[`UntypedOption`](UntypedOption.md) + +#### Overrides + +[`OptionBase`](../../protocol/classes/OptionBase.md).[`clone`](../../protocol/classes/OptionBase.md#clone) + +*** + +### encodeValueToFields() + +> `protected` **encodeValueToFields**(): `Field`[] + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L44) + +#### Returns + +`Field`[] + +#### Overrides + +[`OptionBase`](../../protocol/classes/OptionBase.md).[`encodeValueToFields`](../../protocol/classes/OptionBase.md#encodevaluetofields) + +*** + +### forceSome() + +> **forceSome**(): `void` + +Defined in: packages/protocol/dist/model/Option.d.ts:68 + +#### Returns + +`void` + +#### Inherited from + +[`OptionBase`](../../protocol/classes/OptionBase.md).[`forceSome`](../../protocol/classes/OptionBase.md#forcesome) + +*** + +### toFields() + +> **toFields**(): `Field`[] + +Defined in: packages/protocol/dist/model/Option.d.ts:73 + +Returns the `to`-value as decoded as a list of fields +Not in circuit + +#### Returns + +`Field`[] + +#### Inherited from + +[`OptionBase`](../../protocol/classes/OptionBase.md).[`toFields`](../../protocol/classes/OptionBase.md#tofields) + +*** + +### toJSON() + +> **toJSON**(): `object` + +Defined in: packages/protocol/dist/model/Option.d.ts:78 + +#### Returns + +`object` + +##### isForcedSome + +> **isForcedSome**: `boolean` + +##### isSome + +> **isSome**: `boolean` + +##### value + +> **value**: `string`[] + +#### Inherited from + +[`OptionBase`](../../protocol/classes/OptionBase.md).[`toJSON`](../../protocol/classes/OptionBase.md#tojson) + +*** + +### toProvable() + +> **toProvable**(): [`ProvableOption`](../../protocol/classes/ProvableOption.md) + +Defined in: packages/protocol/dist/model/Option.d.ts:77 + +#### Returns + +[`ProvableOption`](../../protocol/classes/ProvableOption.md) + +Provable representation of the current option. + +#### Inherited from + +[`OptionBase`](../../protocol/classes/OptionBase.md).[`toProvable`](../../protocol/classes/OptionBase.md#toprovable) + +*** + +### fromJSON() + +> `static` **fromJSON**(`__namedParameters`): [`UntypedOption`](UntypedOption.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L16) + +#### Parameters + +##### \_\_namedParameters + +###### isForcedSome + +`boolean` + +###### isSome + +`boolean` + +###### value + +`string`[] + +#### Returns + +[`UntypedOption`](UntypedOption.md) + +*** + +### fromOption() + +> `static` **fromOption**\<`Value`\>(`option`): [`UntypedOption`](UntypedOption.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L8) + +#### Type Parameters + +• **Value** + +#### Parameters + +##### option + +[`Option`](../../protocol/classes/Option.md)\<`Field`\> | [`Option`](../../protocol/classes/Option.md)\<`Value`\> + +#### Returns + +[`UntypedOption`](UntypedOption.md) diff --git a/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md b/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md new file mode 100644 index 0000000..9482e13 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md @@ -0,0 +1,231 @@ +--- +title: UntypedStateTransition +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / UntypedStateTransition + +# Class: UntypedStateTransition + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L10) + +Generic state transition that constraints the current method circuit +to external state, by providing a state anchor. + +## Constructors + +### new UntypedStateTransition() + +> **new UntypedStateTransition**(`path`, `fromValue`, `toValue`): [`UntypedStateTransition`](UntypedStateTransition.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L35) + +#### Parameters + +##### path + +`Field` + +##### fromValue + +[`UntypedOption`](UntypedOption.md) + +##### toValue + +[`UntypedOption`](UntypedOption.md) + +#### Returns + +[`UntypedStateTransition`](UntypedStateTransition.md) + +## Properties + +### fromValue + +> **fromValue**: [`UntypedOption`](UntypedOption.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L37) + +*** + +### path + +> **path**: `Field` + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L36) + +*** + +### toValue + +> **toValue**: [`UntypedOption`](UntypedOption.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L38) + +## Accessors + +### from + +#### Get Signature + +> **get** **from**(): [`UntypedOption`](UntypedOption.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L41) + +##### Returns + +[`UntypedOption`](UntypedOption.md) + +*** + +### to + +#### Get Signature + +> **get** **to**(): [`UntypedOption`](UntypedOption.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L47) + +##### Returns + +[`UntypedOption`](UntypedOption.md) + +## Methods + +### toJSON() + +> **toJSON**(): `object` + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L63) + +#### Returns + +`object` + +##### from + +> **from**: `object` + +###### from.isForcedSome + +> **from.isForcedSome**: `boolean` + +###### from.isSome + +> **from.isSome**: `boolean` + +###### from.value + +> **from.value**: `string`[] + +##### path + +> **path**: `string` + +##### to + +> **to**: `object` + +###### to.isForcedSome + +> **to.isForcedSome**: `boolean` + +###### to.isSome + +> **to.isSome**: `boolean` + +###### to.value + +> **to.value**: `string`[] + +*** + +### toProvable() + +> **toProvable**(): [`ProvableStateTransition`](../../protocol/classes/ProvableStateTransition.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L55) + +Converts a StateTransition to a ProvableStateTransition, +while enforcing the 'from' property to be 'Some' in all cases. + +#### Returns + +[`ProvableStateTransition`](../../protocol/classes/ProvableStateTransition.md) + +*** + +### fromJSON() + +> `static` **fromJSON**(`__namedParameters`): [`UntypedStateTransition`](UntypedStateTransition.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L19) + +#### Parameters + +##### \_\_namedParameters + +###### from + +\{ `isForcedSome`: `boolean`; `isSome`: `boolean`; `value`: `string`[]; \} + +###### from.isForcedSome + +`boolean` + +###### from.isSome + +`boolean` + +###### from.value + +`string`[] + +###### path + +`string` + +###### to + +\{ `isForcedSome`: `boolean`; `isSome`: `boolean`; `value`: `string`[]; \} + +###### to.isForcedSome + +`boolean` + +###### to.isSome + +`boolean` + +###### to.value + +`string`[] + +#### Returns + +[`UntypedStateTransition`](UntypedStateTransition.md) + +*** + +### fromStateTransition() + +> `static` **fromStateTransition**\<`Value`\>(`st`): [`UntypedStateTransition`](UntypedStateTransition.md) + +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L11) + +#### Type Parameters + +• **Value** + +#### Parameters + +##### st + +[`StateTransition`](../../protocol/classes/StateTransition.md)\<`Value`\> + +#### Returns + +[`UntypedStateTransition`](UntypedStateTransition.md) diff --git a/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md b/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md new file mode 100644 index 0000000..33d1fe8 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md @@ -0,0 +1,167 @@ +--- +title: VanillaTaskWorkerModules +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / VanillaTaskWorkerModules + +# Class: VanillaTaskWorkerModules + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:131](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L131) + +## Constructors + +### new VanillaTaskWorkerModules() + +> **new VanillaTaskWorkerModules**(): [`VanillaTaskWorkerModules`](VanillaTaskWorkerModules.md) + +#### Returns + +[`VanillaTaskWorkerModules`](VanillaTaskWorkerModules.md) + +## Methods + +### allTasks() + +> `static` **allTasks**(): `object` + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:145](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L145) + +#### Returns + +`object` + +##### BlockBuildingTask + +> **BlockBuildingTask**: *typeof* [`NewBlockTask`](NewBlockTask.md) = `NewBlockTask` + +##### BlockReductionTask + +> **BlockReductionTask**: *typeof* `BlockReductionTask` + +##### CircuitCompilerTask + +> **CircuitCompilerTask**: *typeof* `CircuitCompilerTask` + +##### RuntimeProvingTask + +> **RuntimeProvingTask**: *typeof* [`RuntimeProvingTask`](RuntimeProvingTask.md) + +##### SettlementProvingTask + +> **SettlementProvingTask**: *typeof* [`SettlementProvingTask`](SettlementProvingTask.md) + +##### StateTransitionReductionTask + +> **StateTransitionReductionTask**: *typeof* [`StateTransitionReductionTask`](StateTransitionReductionTask.md) + +##### StateTransitionTask + +> **StateTransitionTask**: *typeof* [`StateTransitionTask`](StateTransitionTask.md) + +##### TransactionProvingTask + +> **TransactionProvingTask**: *typeof* [`TransactionProvingTask`](TransactionProvingTask.md) + +##### WorkerRegistrationTask + +> **WorkerRegistrationTask**: *typeof* `WorkerRegistrationTask` + +*** + +### defaultConfig() + +> `static` **defaultConfig**(): `object` + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:152](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L152) + +#### Returns + +`object` + +##### BlockBuildingTask + +> **BlockBuildingTask**: `object` = `{}` + +##### BlockProvingTask + +> **BlockProvingTask**: `object` = `{}` + +##### BlockReductionTask + +> **BlockReductionTask**: `object` = `{}` + +##### CircuitCompilerTask + +> **CircuitCompilerTask**: `object` = `{}` + +##### RuntimeProvingTask + +> **RuntimeProvingTask**: `object` = `{}` + +##### SettlementProvingTask + +> **SettlementProvingTask**: `object` = `{}` + +##### StateTransitionReductionTask + +> **StateTransitionReductionTask**: `object` = `{}` + +##### StateTransitionTask + +> **StateTransitionTask**: `object` = `{}` + +##### TransactionProvingTask + +> **TransactionProvingTask**: `object` = `{}` + +##### WorkerRegistrationTask + +> **WorkerRegistrationTask**: `object` = `{}` + +*** + +### withoutSettlement() + +> `static` **withoutSettlement**(): `object` + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L132) + +#### Returns + +`object` + +##### BlockBuildingTask + +> **BlockBuildingTask**: *typeof* [`NewBlockTask`](NewBlockTask.md) = `NewBlockTask` + +##### BlockReductionTask + +> **BlockReductionTask**: *typeof* `BlockReductionTask` + +##### CircuitCompilerTask + +> **CircuitCompilerTask**: *typeof* `CircuitCompilerTask` + +##### RuntimeProvingTask + +> **RuntimeProvingTask**: *typeof* [`RuntimeProvingTask`](RuntimeProvingTask.md) + +##### StateTransitionReductionTask + +> **StateTransitionReductionTask**: *typeof* [`StateTransitionReductionTask`](StateTransitionReductionTask.md) + +##### StateTransitionTask + +> **StateTransitionTask**: *typeof* [`StateTransitionTask`](StateTransitionTask.md) + +##### TransactionProvingTask + +> **TransactionProvingTask**: *typeof* [`TransactionProvingTask`](TransactionProvingTask.md) + +##### WorkerRegistrationTask + +> **WorkerRegistrationTask**: *typeof* `WorkerRegistrationTask` diff --git a/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md b/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md new file mode 100644 index 0000000..9dad882 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md @@ -0,0 +1,59 @@ +--- +title: VerificationKeySerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / VerificationKeySerializer + +# Class: VerificationKeySerializer + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L5) + +## Constructors + +### new VerificationKeySerializer() + +> **new VerificationKeySerializer**(): [`VerificationKeySerializer`](VerificationKeySerializer.md) + +#### Returns + +[`VerificationKeySerializer`](VerificationKeySerializer.md) + +## Methods + +### fromJSON() + +> `static` **fromJSON**(`json`): `VerificationKey` + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L13) + +#### Parameters + +##### json + +[`VerificationKeyJSON`](../type-aliases/VerificationKeyJSON.md) + +#### Returns + +`VerificationKey` + +*** + +### toJSON() + +> `static` **toJSON**(`verificationKey`): [`VerificationKeyJSON`](../type-aliases/VerificationKeyJSON.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L6) + +#### Parameters + +##### verificationKey + +`VerificationKey` + +#### Returns + +[`VerificationKeyJSON`](../type-aliases/VerificationKeyJSON.md) diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md b/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md new file mode 100644 index 0000000..3853456 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md @@ -0,0 +1,489 @@ +--- +title: WithdrawalEvent +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / WithdrawalEvent + +# Class: WithdrawalEvent + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L24) + +## Extends + +- `object` + +## Constructors + +### new WithdrawalEvent() + +> **new WithdrawalEvent**(`value`): [`WithdrawalEvent`](WithdrawalEvent.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +[`WithdrawalEvent`](WithdrawalEvent.md) + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).constructor` + +## Properties + +### key + +> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L25) + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).key` + +*** + +### value + +> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L26) + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).value` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### key + +> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +##### value + +> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### key + +> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +##### value + +> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### key + +\{ `index`: `string`; `tokenId`: `string`; \} = `WithdrawalKey` + +###### key.index + +`string` = `Field` + +###### key.tokenId + +`string` = `Field` + +###### value + +\{ `address`: `string`; `amount`: `string`; `tokenId`: `string`; \} = `Withdrawal` + +###### value.address + +`string` + +###### value.amount + +`string` + +###### value.tokenId + +`string` + +#### Returns + +`object` + +##### key + +> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +##### value + +> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`object` + +##### key + +> **key**: `object` = `WithdrawalKey` + +###### key.index + +> **key.index**: `string` = `Field` + +###### key.tokenId + +> **key.tokenId**: `string` = `Field` + +##### value + +> **value**: `object` = `Withdrawal` + +###### value.address + +> **value.address**: `string` + +###### value.amount + +> **value.amount**: `string` + +###### value.tokenId + +> **value.tokenId**: `string` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### key + +[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` + +###### value + +[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` + +#### Returns + +`object` + +##### key + +> **key**: `object` = `WithdrawalKey` + +###### key.index + +> **key.index**: `bigint` = `Field` + +###### key.tokenId + +> **key.tokenId**: `bigint` = `Field` + +##### value + +> **value**: `object` = `Withdrawal` + +###### value.address + +> **value.address**: `object` + +###### value.address.isOdd + +> **value.address.isOdd**: `boolean` + +###### value.address.x + +> **value.address.x**: `bigint` + +###### value.amount + +> **value.amount**: `bigint` + +###### value.tokenId + +> **value.tokenId**: `bigint` + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ key: WithdrawalKey, value: Withdrawal, }).sizeInFields` diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md b/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md new file mode 100644 index 0000000..d1c5bed --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md @@ -0,0 +1,421 @@ +--- +title: WithdrawalKey +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / WithdrawalKey + +# Class: WithdrawalKey + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L19) + +## Extends + +- `object` + +## Constructors + +### new WithdrawalKey() + +> **new WithdrawalKey**(`value`): [`WithdrawalKey`](WithdrawalKey.md) + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 + +#### Parameters + +##### value + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +[`WithdrawalKey`](WithdrawalKey.md) + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).constructor` + +## Properties + +### index + +> **index**: `Field` = `Field` + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L20) + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).index` + +*** + +### tokenId + +> **tokenId**: `Field` = `Field` + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L21) + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).tokenId` + +*** + +### \_isStruct + +> `static` **\_isStruct**: `true` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, })._isStruct` + +*** + +### check() + +> `static` **check**: (`value`) => `void` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 + +Add assertions to the proof to check if `value` is a valid member of type `T`. +This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. + +For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. + +#### Parameters + +##### value + +the element of type `T` to put assertions on. + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`void` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).check` + +*** + +### empty() + +> `static` **empty**: () => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).empty` + +*** + +### fromFields() + +> `static` **fromFields**: (`fields`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 + +#### Parameters + +##### fields + +`Field`[] + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).fromFields` + +*** + +### fromJSON() + +> `static` **fromJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 + +#### Parameters + +##### x + +###### index + +`string` = `Field` + +###### tokenId + +`string` = `Field` + +#### Returns + +`object` + +##### index + +> **index**: `Field` = `Field` + +##### tokenId + +> **tokenId**: `Field` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).fromJSON` + +*** + +### fromValue + +> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 + +Convert provable type from a normal JS type. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).fromValue` + +*** + +### toAuxiliary() + +> `static` **toAuxiliary**: (`value`?) => `any`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 + +A function that takes `value` (optional), an element of type `T`, as argument and +returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. + +#### Parameters + +##### value? + +the element of type `T` to generate the auxiliary data array from, optional. +If not provided, a default value for auxiliary data is returned. + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`any`[] + +An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toAuxiliary` + +*** + +### toFields() + +> `static` **toFields**: (`value`) => `Field`[] + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 + +A function that takes `value`, an element of type `T`, as argument and returns +an array of Field elements that make up the provable data of `value`. + +#### Parameters + +##### value + +the element of type `T` to generate the Field array from. + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`Field`[] + +A Field array describing how this `T` element is made up of Field elements. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toFields` + +*** + +### toInput() + +> `static` **toInput**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### fields? + +> `optional` **fields**: `Field`[] + +##### packed? + +> `optional` **packed**: \[`Field`, `number`\][] + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toInput` + +*** + +### toJSON() + +> `static` **toJSON**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### index + +> **index**: `string` = `Field` + +##### tokenId + +> **tokenId**: `string` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toJSON` + +*** + +### toValue() + +> `static` **toValue**: (`x`) => `object` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 + +Convert provable type to a normal JS type. + +#### Parameters + +##### x + +###### index + +`Field` = `Field` + +###### tokenId + +`Field` = `Field` + +#### Returns + +`object` + +##### index + +> **index**: `bigint` = `Field` + +##### tokenId + +> **tokenId**: `bigint` = `Field` + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).toValue` + +## Methods + +### sizeInFields() + +> `static` **sizeInFields**(): `number` + +Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 + +Return the size of the `T` type in terms of Field type, as Field is the primitive type. + +#### Returns + +`number` + +A `number` representing the size of the `T` type in terms of Field type. + +#### Inherited from + +`Struct({ index: Field, tokenId: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md b/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md new file mode 100644 index 0000000..2897488 --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md @@ -0,0 +1,214 @@ +--- +title: WithdrawalQueue +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / WithdrawalQueue + +# Class: WithdrawalQueue + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L44) + +This interface allows the SettlementModule to retrieve information about +pending L2-dispatched (outgoing) messages that it can then use to roll +them up on the L1 contract. + +In the future, this interface should be flexibly typed so that the +outgoing message type is not limited to Withdrawals + +## Extends + +- [`SequencerModule`](SequencerModule.md) + +## Implements + +- [`OutgoingMessageQueue`](../interfaces/OutgoingMessageQueue.md) + +## Constructors + +### new WithdrawalQueue() + +> **new WithdrawalQueue**(`sequencer`): [`WithdrawalQueue`](WithdrawalQueue.md) + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L54) + +#### Parameters + +##### sequencer + +[`Sequencer`](Sequencer.md)\<\{ `BlockTrigger`: *typeof* [`BlockTriggerBase`](BlockTriggerBase.md); `SettlementModule`: *typeof* [`SettlementModule`](SettlementModule.md); \}\> + +#### Returns + +[`WithdrawalQueue`](WithdrawalQueue.md) + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) + +## Properties + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) + +## Methods + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) + +*** + +### length() + +> **length**(): `number` + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L74) + +#### Returns + +`number` + +#### Implementation of + +[`OutgoingMessageQueue`](../interfaces/OutgoingMessageQueue.md).[`length`](../interfaces/OutgoingMessageQueue.md#length) + +*** + +### peek() + +> **peek**(`num`): [`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L64) + +#### Parameters + +##### num + +`number` + +#### Returns + +[`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] + +#### Implementation of + +[`OutgoingMessageQueue`](../interfaces/OutgoingMessageQueue.md).[`peek`](../interfaces/OutgoingMessageQueue.md#peek) + +*** + +### pop() + +> **pop**(`num`): [`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L68) + +#### Parameters + +##### num + +`number` + +#### Returns + +[`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] + +#### Implementation of + +[`OutgoingMessageQueue`](../interfaces/OutgoingMessageQueue.md).[`pop`](../interfaces/OutgoingMessageQueue.md#pop) + +*** + +### start() + +> **start**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L78) + +Start the module and all it's functionality. +The returned Promise has to resolve after initialization, +since it will block in the sequencer init. +That means that you mustn't await server.start() for example. + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md b/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md new file mode 100644 index 0000000..2965cff --- /dev/null +++ b/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md @@ -0,0 +1,46 @@ +--- +title: WorkerReadyModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / WorkerReadyModule + +# Class: WorkerReadyModule + +Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L11) + +Module to safely wait for the finish of the worker startup +Behaves like a noop for non-worker appchain configurations + +## Constructors + +### new WorkerReadyModule() + +> **new WorkerReadyModule**(`localTaskWorkerModule`): [`WorkerReadyModule`](WorkerReadyModule.md) + +Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L12) + +#### Parameters + +##### localTaskWorkerModule + +`undefined` | [`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`any`\> + +#### Returns + +[`WorkerReadyModule`](WorkerReadyModule.md) + +## Methods + +### waitForReady() + +> **waitForReady**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L20) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/functions/closeable.md b/src/pages/docs/reference/sequencer/functions/closeable.md new file mode 100644 index 0000000..8e78633 --- /dev/null +++ b/src/pages/docs/reference/sequencer/functions/closeable.md @@ -0,0 +1,29 @@ +--- +title: closeable +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / closeable + +# Function: closeable() + +> **closeable**(): (`target`) => `void` + +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/Closeable.ts#L7) + +## Returns + +`Function` + +### Parameters + +#### target + +[`TypedClass`](../type-aliases/TypedClass.md)\<[`Closeable`](../interfaces/Closeable.md)\> + +### Returns + +`void` diff --git a/src/pages/docs/reference/sequencer/functions/distinct.md b/src/pages/docs/reference/sequencer/functions/distinct.md new file mode 100644 index 0000000..d6f8256 --- /dev/null +++ b/src/pages/docs/reference/sequencer/functions/distinct.md @@ -0,0 +1,37 @@ +--- +title: distinct +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / distinct + +# Function: distinct() + +> **distinct**\<`Value`\>(`value`, `index`, `array`): `boolean` + +Defined in: [packages/sequencer/src/helpers/utils.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L7) + +## Type Parameters + +• **Value** + +## Parameters + +### value + +`Value` + +### index + +`number` + +### array + +`Value`[] + +## Returns + +`boolean` diff --git a/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md b/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md new file mode 100644 index 0000000..b9104f3 --- /dev/null +++ b/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md @@ -0,0 +1,47 @@ +--- +title: distinctByPredicate +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / distinctByPredicate + +# Function: distinctByPredicate() + +> **distinctByPredicate**\<`Value`\>(`predicate`): (`value`, `index`, `array`) => `boolean` + +Defined in: [packages/sequencer/src/helpers/utils.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L15) + +## Type Parameters + +• **Value** + +## Parameters + +### predicate + +(`a`, `b`) => `boolean` + +## Returns + +`Function` + +### Parameters + +#### value + +`Value` + +#### index + +`number` + +#### array + +`Value`[] + +### Returns + +`boolean` diff --git a/src/pages/docs/reference/sequencer/functions/distinctByString.md b/src/pages/docs/reference/sequencer/functions/distinctByString.md new file mode 100644 index 0000000..f6f4886 --- /dev/null +++ b/src/pages/docs/reference/sequencer/functions/distinctByString.md @@ -0,0 +1,37 @@ +--- +title: distinctByString +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / distinctByString + +# Function: distinctByString() + +> **distinctByString**\<`Value`\>(`value`, `index`, `array`): `boolean` + +Defined in: [packages/sequencer/src/helpers/utils.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L23) + +## Type Parameters + +• **Value** *extends* `object` + +## Parameters + +### value + +`Value` + +### index + +`number` + +### array + +`Value`[] + +## Returns + +`boolean` diff --git a/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md b/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md new file mode 100644 index 0000000..f40a54b --- /dev/null +++ b/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md @@ -0,0 +1,37 @@ +--- +title: executeWithExecutionContext +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / executeWithExecutionContext + +# Function: executeWithExecutionContext() + +> **executeWithExecutionContext**\<`MethodResult`\>(`method`, `contextInputs`, `runSimulated`): `Promise`\<[`RuntimeContextReducedExecutionResult`](../type-aliases/RuntimeContextReducedExecutionResult.md) & `object`\> + +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L109) + +## Type Parameters + +• **MethodResult** + +## Parameters + +### method + +() => `Promise`\<`MethodResult`\> + +### contextInputs + +[`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) + +### runSimulated + +`boolean` = `false` + +## Returns + +`Promise`\<[`RuntimeContextReducedExecutionResult`](../type-aliases/RuntimeContextReducedExecutionResult.md) & `object`\> diff --git a/src/pages/docs/reference/sequencer/functions/sequencerModule.md b/src/pages/docs/reference/sequencer/functions/sequencerModule.md new file mode 100644 index 0000000..b9478b7 --- /dev/null +++ b/src/pages/docs/reference/sequencer/functions/sequencerModule.md @@ -0,0 +1,32 @@ +--- +title: sequencerModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / sequencerModule + +# Function: sequencerModule() + +> **sequencerModule**(): (`target`) => `void` + +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L33) + +Marks the decorated class as a sequencer module, while also +making it injectable with our dependency injection solution. + +## Returns + +`Function` + +### Parameters + +#### target + +[`StaticConfigurableModule`](../../common/interfaces/StaticConfigurableModule.md)\<`unknown`\> & [`TypedClass`](../type-aliases/TypedClass.md)\<[`SequencerModule`](../classes/SequencerModule.md)\<`unknown`\>\> + +### Returns + +`void` diff --git a/src/pages/docs/reference/sequencer/globals.md b/src/pages/docs/reference/sequencer/globals.md new file mode 100644 index 0000000..7eb0500 --- /dev/null +++ b/src/pages/docs/reference/sequencer/globals.md @@ -0,0 +1,198 @@ +--- +title: "@proto-kit/sequencer" +--- + +[**@proto-kit/sequencer**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/sequencer + +# @proto-kit/sequencer + +## Classes + +- [AbstractTaskQueue](classes/AbstractTaskQueue.md) +- [ArtifactRecordSerializer](classes/ArtifactRecordSerializer.md) +- [BatchProducerModule](classes/BatchProducerModule.md) +- [BlockProducerModule](classes/BlockProducerModule.md) +- [BlockProofSerializer](classes/BlockProofSerializer.md) +- [BlockTaskFlowService](classes/BlockTaskFlowService.md) +- [BlockTriggerBase](classes/BlockTriggerBase.md) +- [CachedMerkleTreeStore](classes/CachedMerkleTreeStore.md) +- [CachedStateService](classes/CachedStateService.md) +- [CompressedSignature](classes/CompressedSignature.md) +- [DatabasePruneModule](classes/DatabasePruneModule.md) +- [DecodedStateSerializer](classes/DecodedStateSerializer.md) +- [DummyStateService](classes/DummyStateService.md) +- [DynamicProofTaskSerializer](classes/DynamicProofTaskSerializer.md) +- [Flow](classes/Flow.md) +- [FlowCreator](classes/FlowCreator.md) +- [FlowTaskWorker](classes/FlowTaskWorker.md) +- [InMemoryAsyncMerkleTreeStore](classes/InMemoryAsyncMerkleTreeStore.md) +- [InMemoryBatchStorage](classes/InMemoryBatchStorage.md) +- [InMemoryBlockStorage](classes/InMemoryBlockStorage.md) +- [InMemoryDatabase](classes/InMemoryDatabase.md) +- [InMemoryMessageStorage](classes/InMemoryMessageStorage.md) +- [InMemorySettlementStorage](classes/InMemorySettlementStorage.md) +- [InMemoryTransactionStorage](classes/InMemoryTransactionStorage.md) +- [ListenerList](classes/ListenerList.md) +- [LocalTaskQueue](classes/LocalTaskQueue.md) +- [LocalTaskWorkerModule](classes/LocalTaskWorkerModule.md) +- [ManualBlockTrigger](classes/ManualBlockTrigger.md) +- [MinaBaseLayer](classes/MinaBaseLayer.md) +- [MinaIncomingMessageAdapter](classes/MinaIncomingMessageAdapter.md) +- [MinaSimulationService](classes/MinaSimulationService.md) +- [MinaTransactionSender](classes/MinaTransactionSender.md) +- [MinaTransactionSimulator](classes/MinaTransactionSimulator.md) +- [NetworkStateQuery](classes/NetworkStateQuery.md) +- [NewBlockProvingParametersSerializer](classes/NewBlockProvingParametersSerializer.md) +- [NewBlockTask](classes/NewBlockTask.md) +- [NoopBaseLayer](classes/NoopBaseLayer.md) +- [PairProofTaskSerializer](classes/PairProofTaskSerializer.md) +- [PendingTransaction](classes/PendingTransaction.md) +- [PreFilledStateService](classes/PreFilledStateService.md) +- [PrivateMempool](classes/PrivateMempool.md) +- [ProofTaskSerializer](classes/ProofTaskSerializer.md) +- [ProvenSettlementPermissions](classes/ProvenSettlementPermissions.md) +- [ReductionTaskFlow](classes/ReductionTaskFlow.md) +- [RuntimeProofParametersSerializer](classes/RuntimeProofParametersSerializer.md) +- [RuntimeProvingTask](classes/RuntimeProvingTask.md) +- [RuntimeVerificationKeyAttestationSerializer](classes/RuntimeVerificationKeyAttestationSerializer.md) +- [Sequencer](classes/Sequencer.md) +- [SequencerModule](classes/SequencerModule.md) +- [SequencerStartupModule](classes/SequencerStartupModule.md) +- [SettlementModule](classes/SettlementModule.md) +- [SettlementProvingTask](classes/SettlementProvingTask.md) +- [SignedSettlementPermissions](classes/SignedSettlementPermissions.md) +- [SomeProofSubclass](classes/SomeProofSubclass.md) +- [StateTransitionParametersSerializer](classes/StateTransitionParametersSerializer.md) +- [StateTransitionReductionTask](classes/StateTransitionReductionTask.md) +- [StateTransitionTask](classes/StateTransitionTask.md) +- [SyncCachedMerkleTreeStore](classes/SyncCachedMerkleTreeStore.md) +- [TaskWorkerModule](classes/TaskWorkerModule.md) +- [TimedBlockTrigger](classes/TimedBlockTrigger.md) +- [TransactionExecutionService](classes/TransactionExecutionService.md) +- [TransactionProvingTask](classes/TransactionProvingTask.md) +- [TransactionProvingTaskParameterSerializer](classes/TransactionProvingTaskParameterSerializer.md) +- [TransactionTraceService](classes/TransactionTraceService.md) +- [UnsignedTransaction](classes/UnsignedTransaction.md) +- [UntypedOption](classes/UntypedOption.md) +- [UntypedStateTransition](classes/UntypedStateTransition.md) +- [VanillaTaskWorkerModules](classes/VanillaTaskWorkerModules.md) +- [VerificationKeySerializer](classes/VerificationKeySerializer.md) +- [WithdrawalEvent](classes/WithdrawalEvent.md) +- [WithdrawalKey](classes/WithdrawalKey.md) +- [WithdrawalQueue](classes/WithdrawalQueue.md) +- [WorkerReadyModule](classes/WorkerReadyModule.md) + +## Interfaces + +- [AsyncMerkleTreeStore](interfaces/AsyncMerkleTreeStore.md) +- [AsyncStateService](interfaces/AsyncStateService.md) +- [BaseLayer](interfaces/BaseLayer.md) +- [BaseLayerContractPermissions](interfaces/BaseLayerContractPermissions.md) +- [BaseLayerDependencyRecord](interfaces/BaseLayerDependencyRecord.md) +- [Batch](interfaces/Batch.md) +- [BatchStorage](interfaces/BatchStorage.md) +- [BatchTransaction](interfaces/BatchTransaction.md) +- [Block](interfaces/Block.md) +- [BlockConfig](interfaces/BlockConfig.md) +- [BlockProverParameters](interfaces/BlockProverParameters.md) +- [BlockQueue](interfaces/BlockQueue.md) +- [BlockResult](interfaces/BlockResult.md) +- [BlockStorage](interfaces/BlockStorage.md) +- [BlockTrace](interfaces/BlockTrace.md) +- [BlockTrigger](interfaces/BlockTrigger.md) +- [BlockWithMaybeResult](interfaces/BlockWithMaybeResult.md) +- [BlockWithPreviousResult](interfaces/BlockWithPreviousResult.md) +- [BlockWithResult](interfaces/BlockWithResult.md) +- [Closeable](interfaces/Closeable.md) +- [Database](interfaces/Database.md) +- [HistoricalBatchStorage](interfaces/HistoricalBatchStorage.md) +- [HistoricalBlockStorage](interfaces/HistoricalBlockStorage.md) +- [IncomingMessageAdapter](interfaces/IncomingMessageAdapter.md) +- [InstantiatedQueue](interfaces/InstantiatedQueue.md) +- [LocalTaskQueueConfig](interfaces/LocalTaskQueueConfig.md) +- [Mempool](interfaces/Mempool.md) +- [MerkleTreeNode](interfaces/MerkleTreeNode.md) +- [MerkleTreeNodeQuery](interfaces/MerkleTreeNodeQuery.md) +- [MessageStorage](interfaces/MessageStorage.md) +- [MinaBaseLayerConfig](interfaces/MinaBaseLayerConfig.md) +- [NetworkStateTransportModule](interfaces/NetworkStateTransportModule.md) +- [NewBlockProverParameters](interfaces/NewBlockProverParameters.md) +- [OutgoingMessage](interfaces/OutgoingMessage.md) +- [OutgoingMessageQueue](interfaces/OutgoingMessageQueue.md) +- [PairingDerivedInput](interfaces/PairingDerivedInput.md) +- [QueryGetterState](interfaces/QueryGetterState.md) +- [QueryGetterStateMap](interfaces/QueryGetterStateMap.md) +- [QueryTransportModule](interfaces/QueryTransportModule.md) +- [RuntimeProofParameters](interfaces/RuntimeProofParameters.md) +- [Sequenceable](interfaces/Sequenceable.md) +- [SettleableBatch](interfaces/SettleableBatch.md) +- [Settlement](interfaces/Settlement.md) +- [SettlementModuleConfig](interfaces/SettlementModuleConfig.md) +- [SettlementStorage](interfaces/SettlementStorage.md) +- [StateEntry](interfaces/StateEntry.md) +- [StateTransitionProofParameters](interfaces/StateTransitionProofParameters.md) +- [StorageDependencyFactory](interfaces/StorageDependencyFactory.md) +- [StorageDependencyMinimumDependencies](interfaces/StorageDependencyMinimumDependencies.md) +- [Task](interfaces/Task.md) +- [TaskPayload](interfaces/TaskPayload.md) +- [TaskQueue](interfaces/TaskQueue.md) +- [TaskSerializer](interfaces/TaskSerializer.md) +- [TimedBlockTriggerConfig](interfaces/TimedBlockTriggerConfig.md) +- [TimedBlockTriggerEvent](interfaces/TimedBlockTriggerEvent.md) +- [TransactionExecutionResult](interfaces/TransactionExecutionResult.md) +- [TransactionStorage](interfaces/TransactionStorage.md) +- [TransactionTrace](interfaces/TransactionTrace.md) +- [TxEvents](interfaces/TxEvents.md) + +## Type Aliases + +- [AllTaskWorkerModules](type-aliases/AllTaskWorkerModules.md) +- [BlockEvents](type-aliases/BlockEvents.md) +- [ChainStateTaskArgs](type-aliases/ChainStateTaskArgs.md) +- [DatabasePruneConfig](type-aliases/DatabasePruneConfig.md) +- [JSONEncodableState](type-aliases/JSONEncodableState.md) +- [MapStateMapToQuery](type-aliases/MapStateMapToQuery.md) +- [MapStateToQuery](type-aliases/MapStateToQuery.md) +- [MempoolEvents](type-aliases/MempoolEvents.md) +- [ModuleQuery](type-aliases/ModuleQuery.md) +- [NewBlockProvingParameters](type-aliases/NewBlockProvingParameters.md) +- [PairTuple](type-aliases/PairTuple.md) +- [PickByType](type-aliases/PickByType.md) +- [PickStateMapProperties](type-aliases/PickStateMapProperties.md) +- [PickStateProperties](type-aliases/PickStateProperties.md) +- [Query](type-aliases/Query.md) +- [RuntimeContextReducedExecutionResult](type-aliases/RuntimeContextReducedExecutionResult.md) +- [SequencerModulesRecord](type-aliases/SequencerModulesRecord.md) +- [SerializedArtifactRecord](type-aliases/SerializedArtifactRecord.md) +- [SettlementModuleEvents](type-aliases/SettlementModuleEvents.md) +- [SomeRuntimeMethod](type-aliases/SomeRuntimeMethod.md) +- [StateRecord](type-aliases/StateRecord.md) +- [TaskStateRecord](type-aliases/TaskStateRecord.md) +- [TaskWorkerModulesRecord](type-aliases/TaskWorkerModulesRecord.md) +- [TaskWorkerModulesWithoutSettlement](type-aliases/TaskWorkerModulesWithoutSettlement.md) +- [TransactionProvingTaskParameters](type-aliases/TransactionProvingTaskParameters.md) +- [TransactionTaskArgs](type-aliases/TransactionTaskArgs.md) +- [TransactionTaskResult](type-aliases/TransactionTaskResult.md) +- [TypedClass](type-aliases/TypedClass.md) +- [UnsignedTransactionBody](type-aliases/UnsignedTransactionBody.md) +- [VerificationKeyJSON](type-aliases/VerificationKeyJSON.md) + +## Variables + +- [Block](variables/Block.md) +- [BlockWithResult](variables/BlockWithResult.md) +- [JSONTaskSerializer](variables/JSONTaskSerializer.md) +- [QueryBuilderFactory](variables/QueryBuilderFactory.md) + +## Functions + +- [closeable](functions/closeable.md) +- [distinct](functions/distinct.md) +- [distinctByPredicate](functions/distinctByPredicate.md) +- [distinctByString](functions/distinctByString.md) +- [executeWithExecutionContext](functions/executeWithExecutionContext.md) +- [sequencerModule](functions/sequencerModule.md) diff --git a/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md b/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md new file mode 100644 index 0000000..ee8a336 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md @@ -0,0 +1,73 @@ +--- +title: AsyncMerkleTreeStore +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / AsyncMerkleTreeStore + +# Interface: AsyncMerkleTreeStore + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L10) + +## Properties + +### commit() + +> **commit**: () => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L13) + +#### Returns + +`Promise`\<`void`\> + +*** + +### getNodesAsync() + +> **getNodesAsync**: (`nodes`) => `Promise`\<(`undefined` \| `bigint`)[]\> + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L17) + +#### Parameters + +##### nodes + +[`MerkleTreeNodeQuery`](MerkleTreeNodeQuery.md)[] + +#### Returns + +`Promise`\<(`undefined` \| `bigint`)[]\> + +*** + +### openTransaction() + +> **openTransaction**: () => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L11) + +#### Returns + +`Promise`\<`void`\> + +*** + +### writeNodes() + +> **writeNodes**: (`nodes`) => `void` + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L15) + +#### Parameters + +##### nodes + +[`MerkleTreeNode`](MerkleTreeNode.md)[] + +#### Returns + +`void` diff --git a/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md b/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md new file mode 100644 index 0000000..b7ac43f --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md @@ -0,0 +1,95 @@ +--- +title: AsyncStateService +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / AsyncStateService + +# Interface: AsyncStateService + +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L13) + +This Interface should be implemented for services that store the state +in an external storage (like a DB). This can be used in conjunction with +CachedStateService to preload keys for In-Circuit usage. + +## Properties + +### commit() + +> **commit**: () => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L16) + +#### Returns + +`Promise`\<`void`\> + +*** + +### get() + +> **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> + +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L22) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| `Field`[]\> + +*** + +### getMany() + +> **getMany**: (`keys`) => `Promise`\<[`StateEntry`](StateEntry.md)[]\> + +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L20) + +#### Parameters + +##### keys + +`Field`[] + +#### Returns + +`Promise`\<[`StateEntry`](StateEntry.md)[]\> + +*** + +### openTransaction() + +> **openTransaction**: () => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L14) + +#### Returns + +`Promise`\<`void`\> + +*** + +### writeStates() + +> **writeStates**: (`entries`) => `void` + +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L18) + +#### Parameters + +##### entries + +[`StateEntry`](StateEntry.md)[] + +#### Returns + +`void` diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md new file mode 100644 index 0000000..80d9be5 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md @@ -0,0 +1,44 @@ +--- +title: BaseLayer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BaseLayer + +# Interface: BaseLayer + +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L16) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Extends + +- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) + +## Properties + +### dependencies() + +> **dependencies**: () => [`BaseLayerDependencyRecord`](BaseLayerDependencyRecord.md) + +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L17) + +#### Returns + +[`BaseLayerDependencyRecord`](BaseLayerDependencyRecord.md) + +#### Overrides + +[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md new file mode 100644 index 0000000..6fa71a0 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md @@ -0,0 +1,61 @@ +--- +title: BaseLayerContractPermissions +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BaseLayerContractPermissions + +# Interface: BaseLayerContractPermissions + +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L3) + +## Methods + +### bridgeContractMina() + +> **bridgeContractMina**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L6) + +#### Returns + +`Permissions` + +*** + +### bridgeContractToken() + +> **bridgeContractToken**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L9) + +#### Returns + +`Permissions` + +*** + +### dispatchContract() + +> **dispatchContract**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L5) + +#### Returns + +`Permissions` + +*** + +### settlementContract() + +> **settlementContract**(): `Permissions` + +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L4) + +#### Returns + +`Permissions` diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md new file mode 100644 index 0000000..0475234 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md @@ -0,0 +1,37 @@ +--- +title: BaseLayerDependencyRecord +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BaseLayerDependencyRecord + +# Interface: BaseLayerDependencyRecord + +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L10) + +## Extends + +- [`DependencyRecord`](../../common/type-aliases/DependencyRecord.md) + +## Indexable + +\[`key`: `string`\]: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<`unknown`\> & `object` + +## Properties + +### IncomingMessageAdapter + +> **IncomingMessageAdapter**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`IncomingMessageAdapter`](IncomingMessageAdapter.md)\> + +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L11) + +*** + +### OutgoingMessageQueue + +> **OutgoingMessageQueue**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`OutgoingMessageQueue`](OutgoingMessageQueue.md)\> + +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L13) diff --git a/src/pages/docs/reference/sequencer/interfaces/Batch.md b/src/pages/docs/reference/sequencer/interfaces/Batch.md new file mode 100644 index 0000000..4087445 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/Batch.md @@ -0,0 +1,41 @@ +--- +title: Batch +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Batch + +# Interface: Batch + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L12) + +## Extended by + +- [`SettleableBatch`](SettleableBatch.md) + +## Properties + +### blockHashes + +> **blockHashes**: `string`[] + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L14) + +*** + +### height + +> **height**: `number` + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L15) + +*** + +### proof + +> **proof**: `JsonProof` + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L13) diff --git a/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md b/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md new file mode 100644 index 0000000..5120b82 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md @@ -0,0 +1,55 @@ +--- +title: BatchStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BatchStorage + +# Interface: BatchStorage + +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L3) + +## Properties + +### getCurrentBatchHeight() + +> **getCurrentBatchHeight**: () => `Promise`\<`number`\> + +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L5) + +#### Returns + +`Promise`\<`number`\> + +*** + +### getLatestBatch() + +> **getLatestBatch**: () => `Promise`\<`undefined` \| [`Batch`](Batch.md)\> + +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L6) + +#### Returns + +`Promise`\<`undefined` \| [`Batch`](Batch.md)\> + +*** + +### pushBatch() + +> **pushBatch**: (`block`) => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L7) + +#### Parameters + +##### block + +[`Batch`](Batch.md) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md b/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md new file mode 100644 index 0000000..dbf1fc2 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md @@ -0,0 +1,37 @@ +--- +title: BatchTransaction +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BatchTransaction + +# Interface: BatchTransaction + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L6) + +## Properties + +### status + +> **status**: `boolean` + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L8) + +*** + +### statusMessage? + +> `optional` **statusMessage**: `string` + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L9) + +*** + +### tx + +> **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L7) diff --git a/src/pages/docs/reference/sequencer/interfaces/Block.md b/src/pages/docs/reference/sequencer/interfaces/Block.md new file mode 100644 index 0000000..3336bf1 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/Block.md @@ -0,0 +1,109 @@ +--- +title: Block +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Block + +# Interface: Block + +Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L22) + +## Properties + +### fromBlockHashRoot + +> **fromBlockHashRoot**: `Field` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L33) + +*** + +### fromEternalTransactionsHash + +> **fromEternalTransactionsHash**: `Field` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L32) + +*** + +### fromMessagesHash + +> **fromMessagesHash**: `Field` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L34) + +*** + +### hash + +> **hash**: `Field` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L23) + +*** + +### height + +> **height**: `Field` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L24) + +*** + +### networkState + +> **networkState**: `object` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L25) + +#### before + +> **before**: [`NetworkState`](../../protocol/classes/NetworkState.md) + +#### during + +> **during**: [`NetworkState`](../../protocol/classes/NetworkState.md) + +*** + +### previousBlockHash + +> **previousBlockHash**: `undefined` \| `Field` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L36) + +*** + +### toEternalTransactionsHash + +> **toEternalTransactionsHash**: `Field` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L31) + +*** + +### toMessagesHash + +> **toMessagesHash**: `Field` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L35) + +*** + +### transactions + +> **transactions**: [`TransactionExecutionResult`](TransactionExecutionResult.md)[] + +Defined in: [packages/sequencer/src/storage/model/Block.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L29) + +*** + +### transactionsHash + +> **transactionsHash**: `Field` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L30) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md b/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md new file mode 100644 index 0000000..c00e5ca --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md @@ -0,0 +1,29 @@ +--- +title: BlockConfig +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockConfig + +# Interface: BlockConfig + +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L33) + +## Properties + +### allowEmptyBlock? + +> `optional` **allowEmptyBlock**: `boolean` + +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L34) + +*** + +### maximumBlockSize? + +> `optional` **maximumBlockSize**: `number` + +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L35) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md b/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md new file mode 100644 index 0000000..7a1ecba --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md @@ -0,0 +1,45 @@ +--- +title: BlockProverParameters +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockProverParameters + +# Interface: BlockProverParameters + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L35) + +## Properties + +### executionData + +> **executionData**: [`BlockProverExecutionData`](../../protocol/classes/BlockProverExecutionData.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L37) + +*** + +### publicInput + +> **publicInput**: [`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L36) + +*** + +### startingState + +> **startingState**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L38) + +*** + +### verificationKeyAttestation + +> **verificationKeyAttestation**: [`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L39) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md b/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md new file mode 100644 index 0000000..db35012 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md @@ -0,0 +1,73 @@ +--- +title: BlockQueue +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockQueue + +# Interface: BlockQueue + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L9) + +## Properties + +### getLatestBlockAndResult() + +> **getLatestBlockAndResult**: () => `Promise`\<`undefined` \| [`BlockWithMaybeResult`](BlockWithMaybeResult.md)\> + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L13) + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithMaybeResult`](BlockWithMaybeResult.md)\> + +*** + +### getNewBlocks() + +> **getNewBlocks**: () => `Promise`\<[`BlockWithPreviousResult`](BlockWithPreviousResult.md)[]\> + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L12) + +#### Returns + +`Promise`\<[`BlockWithPreviousResult`](BlockWithPreviousResult.md)[]\> + +*** + +### pushBlock() + +> **pushBlock**: (`block`) => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L10) + +#### Parameters + +##### block + +[`Block`](Block.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### pushResult() + +> **pushResult**: (`result`) => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L11) + +#### Parameters + +##### result + +[`BlockResult`](BlockResult.md) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockResult.md new file mode 100644 index 0000000..73571ce --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BlockResult.md @@ -0,0 +1,61 @@ +--- +title: BlockResult +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockResult + +# Interface: BlockResult + +Defined in: [packages/sequencer/src/storage/model/Block.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L50) + +## Properties + +### afterNetworkState + +> **afterNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) + +Defined in: [packages/sequencer/src/storage/model/Block.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L54) + +*** + +### blockHash + +> **blockHash**: `bigint` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L51) + +*** + +### blockHashRoot + +> **blockHashRoot**: `bigint` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L53) + +*** + +### blockHashWitness + +> **blockHashWitness**: [`BlockHashMerkleTreeWitness`](../../protocol/classes/BlockHashMerkleTreeWitness.md) + +Defined in: [packages/sequencer/src/storage/model/Block.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L56) + +*** + +### blockStateTransitions + +> **blockStateTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] + +Defined in: [packages/sequencer/src/storage/model/Block.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L55) + +*** + +### stateRoot + +> **stateRoot**: `bigint` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L52) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md b/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md new file mode 100644 index 0000000..01c977a --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md @@ -0,0 +1,55 @@ +--- +title: BlockStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockStorage + +# Interface: BlockStorage + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L16) + +## Properties + +### getCurrentBlockHeight() + +> **getCurrentBlockHeight**: () => `Promise`\<`number`\> + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L17) + +#### Returns + +`Promise`\<`number`\> + +*** + +### getLatestBlock() + +> **getLatestBlock**: () => `Promise`\<`undefined` \| [`BlockWithResult`](BlockWithResult.md)\> + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L18) + +#### Returns + +`Promise`\<`undefined` \| [`BlockWithResult`](BlockWithResult.md)\> + +*** + +### pushBlock() + +> **pushBlock**: (`block`) => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L19) + +#### Parameters + +##### block + +[`Block`](Block.md) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md b/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md new file mode 100644 index 0000000..3ca4b01 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md @@ -0,0 +1,37 @@ +--- +title: BlockTrace +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockTrace + +# Interface: BlockTrace + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L43) + +## Properties + +### block + +> **block**: [`NewBlockProverParameters`](NewBlockProverParameters.md) + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L44) + +*** + +### stateTransitionProver + +> **stateTransitionProver**: [`StateTransitionProofParameters`](StateTransitionProofParameters.md)[] + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L45) + +*** + +### transactions + +> **transactions**: [`TransactionTrace`](TransactionTrace.md)[] + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L46) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md b/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md new file mode 100644 index 0000000..5fdae78 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md @@ -0,0 +1,16 @@ +--- +title: BlockTrigger +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockTrigger + +# Interface: BlockTrigger + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L24) + +A BlockTrigger is the primary method to start the production of a block and +all associated processes. diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md new file mode 100644 index 0000000..2d4f40b --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md @@ -0,0 +1,29 @@ +--- +title: BlockWithMaybeResult +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockWithMaybeResult + +# Interface: BlockWithMaybeResult + +Defined in: [packages/sequencer/src/storage/model/Block.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L64) + +## Properties + +### block + +> **block**: [`Block`](Block.md) + +Defined in: [packages/sequencer/src/storage/model/Block.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L65) + +*** + +### result? + +> `optional` **result**: [`BlockResult`](BlockResult.md) + +Defined in: [packages/sequencer/src/storage/model/Block.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L66) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md new file mode 100644 index 0000000..9336ff7 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md @@ -0,0 +1,29 @@ +--- +title: BlockWithPreviousResult +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockWithPreviousResult + +# Interface: BlockWithPreviousResult + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L49) + +## Properties + +### block + +> **block**: [`BlockWithResult`](BlockWithResult.md) + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L50) + +*** + +### lastBlockResult? + +> `optional` **lastBlockResult**: [`BlockResult`](BlockResult.md) + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L51) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md new file mode 100644 index 0000000..45490f5 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md @@ -0,0 +1,33 @@ +--- +title: BlockWithResult +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockWithResult + +# Interface: BlockWithResult + +Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L59) + +## Extended by + +- [`IndexBlockTaskParameters`](../../indexer/interfaces/IndexBlockTaskParameters.md) + +## Properties + +### block + +> **block**: [`Block`](Block.md) + +Defined in: [packages/sequencer/src/storage/model/Block.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L60) + +*** + +### result + +> **result**: [`BlockResult`](BlockResult.md) + +Defined in: [packages/sequencer/src/storage/model/Block.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L61) diff --git a/src/pages/docs/reference/sequencer/interfaces/Closeable.md b/src/pages/docs/reference/sequencer/interfaces/Closeable.md new file mode 100644 index 0000000..2157d65 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/Closeable.md @@ -0,0 +1,30 @@ +--- +title: Closeable +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Closeable + +# Interface: Closeable + +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/Closeable.ts#L3) + +## Extended by + +- [`InstantiatedQueue`](InstantiatedQueue.md) +- [`Database`](Database.md) + +## Properties + +### close() + +> **close**: () => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/Database.md b/src/pages/docs/reference/sequencer/interfaces/Database.md new file mode 100644 index 0000000..ef4f2a3 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/Database.md @@ -0,0 +1,94 @@ +--- +title: Database +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Database + +# Interface: Database + +Defined in: [packages/sequencer/src/storage/Database.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/Database.ts#L5) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Extends + +- [`StorageDependencyFactory`](StorageDependencyFactory.md).[`Closeable`](Closeable.md) + +## Properties + +### close() + +> **close**: () => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`Closeable`](Closeable.md).[`close`](Closeable.md#close) + +*** + +### dependencies() + +> **dependencies**: () => [`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) + +#### Returns + +[`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) + +#### Inherited from + +[`StorageDependencyFactory`](StorageDependencyFactory.md).[`dependencies`](StorageDependencyFactory.md#dependencies) + +## Methods + +### executeInTransaction() + +> **executeInTransaction**(`f`): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/Database.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/Database.ts#L13) + +#### Parameters + +##### f + +() => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### pruneDatabase() + +> **pruneDatabase**(): `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/Database.ts#L11) + +Prunes all data from the database connection. +Note: This function should only be called immediately at startup, +everything else will lead to unexpected behaviour and errors + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md b/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md new file mode 100644 index 0000000..3d4f6cc --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md @@ -0,0 +1,31 @@ +--- +title: HistoricalBatchStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / HistoricalBatchStorage + +# Interface: HistoricalBatchStorage + +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L10) + +## Properties + +### getBatchAt() + +> **getBatchAt**: (`height`) => `Promise`\<`undefined` \| [`Batch`](Batch.md)\> + +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L11) + +#### Parameters + +##### height + +`number` + +#### Returns + +`Promise`\<`undefined` \| [`Batch`](Batch.md)\> diff --git a/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md b/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md new file mode 100644 index 0000000..a476af7 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md @@ -0,0 +1,49 @@ +--- +title: HistoricalBlockStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / HistoricalBlockStorage + +# Interface: HistoricalBlockStorage + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L22) + +## Properties + +### getBlock() + +> **getBlock**: (`hash`) => `Promise`\<`undefined` \| [`Block`](Block.md)\> + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L24) + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<`undefined` \| [`Block`](Block.md)\> + +*** + +### getBlockAt() + +> **getBlockAt**: (`height`) => `Promise`\<`undefined` \| [`Block`](Block.md)\> + +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L23) + +#### Parameters + +##### height + +`number` + +#### Returns + +`Promise`\<`undefined` \| [`Block`](Block.md)\> diff --git a/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md b/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md new file mode 100644 index 0000000..fb5af5b --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md @@ -0,0 +1,50 @@ +--- +title: IncomingMessageAdapter +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / IncomingMessageAdapter + +# Interface: IncomingMessageAdapter + +Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L11) + +An interface provided by the BaseLayer via DependencyFactory, +which implements a function that allows us to retrieve +unconsumed incoming messages from the BaseLayer +(Dispatched Deposit Actions for example) + +## Properties + +### getPendingMessages() + +> **getPendingMessages**: (`address`, `params`) => `Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](../classes/PendingTransaction.md)[]; `to`: `string`; \}\> + +Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L12) + +#### Parameters + +##### address + +`PublicKey` + +##### params + +###### fromActionHash + +`string` + +###### fromL1BlockHeight + +`number` + +###### toActionHash + +`string` + +#### Returns + +`Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](../classes/PendingTransaction.md)[]; `to`: `string`; \}\> diff --git a/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md b/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md new file mode 100644 index 0000000..7dd0e85 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md @@ -0,0 +1,105 @@ +--- +title: InstantiatedQueue +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InstantiatedQueue + +# Interface: InstantiatedQueue + +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L20) + +Object that abstracts a concrete connection to a queue instance. + +## Extends + +- [`Closeable`](Closeable.md) + +## Properties + +### addTask() + +> **addTask**: (`payload`, `taskId`?) => `Promise`\<\{ `taskId`: `string`; \}\> + +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L26) + +Adds a specific payload to the queue and returns a unique jobId + +#### Parameters + +##### payload + +[`TaskPayload`](TaskPayload.md) + +##### taskId? + +`string` + +#### Returns + +`Promise`\<\{ `taskId`: `string`; \}\> + +*** + +### close() + +> **close**: () => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`Closeable`](Closeable.md).[`close`](Closeable.md#close) + +*** + +### name + +> **name**: `string` + +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L21) + +*** + +### offCompleted() + +> **offCompleted**: (`listenerId`) => `void` + +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L38) + +#### Parameters + +##### listenerId + +`number` + +#### Returns + +`void` + +*** + +### onCompleted() + +> **onCompleted**: (`listener`) => `Promise`\<`number`\> + +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L34) + +Registers a listener for the completion of jobs + +#### Parameters + +##### listener + +(`payload`) => `Promise`\<`void`\> + +#### Returns + +`Promise`\<`number`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md b/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md new file mode 100644 index 0000000..096aad2 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md @@ -0,0 +1,21 @@ +--- +title: LocalTaskQueueConfig +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / LocalTaskQueueConfig + +# Interface: LocalTaskQueueConfig + +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L22) + +## Properties + +### simulatedDuration? + +> `optional` **simulatedDuration**: `number` + +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L23) diff --git a/src/pages/docs/reference/sequencer/interfaces/Mempool.md b/src/pages/docs/reference/sequencer/interfaces/Mempool.md new file mode 100644 index 0000000..608e86b --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/Mempool.md @@ -0,0 +1,75 @@ +--- +title: Mempool +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Mempool + +# Interface: Mempool\ + +Defined in: [packages/sequencer/src/mempool/Mempool.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/Mempool.ts#L9) + +## Extends + +- [`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md)\<`Events`\> + +## Type Parameters + +• **Events** *extends* [`MempoolEvents`](../type-aliases/MempoolEvents.md) = [`MempoolEvents`](../type-aliases/MempoolEvents.md) + +## Properties + +### add() + +> **add**: (`tx`) => `Promise`\<`boolean`\> + +Defined in: [packages/sequencer/src/mempool/Mempool.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/Mempool.ts#L15) + +Add a transaction to the mempool + +#### Parameters + +##### tx + +[`PendingTransaction`](../classes/PendingTransaction.md) + +#### Returns + +`Promise`\<`boolean`\> + +The new commitment to the mempool + +*** + +### events + +> **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<`Events`\> + +Defined in: packages/common/dist/events/EventEmittingComponent.d.ts:4 + +#### Inherited from + +[`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md).[`events`](../../common/interfaces/EventEmittingComponent.md#events) + +*** + +### getTxs() + +> **getTxs**: (`limit`?) => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> + +Defined in: [packages/sequencer/src/mempool/Mempool.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/Mempool.ts#L20) + +Retrieve all transactions that are currently in the mempool + +#### Parameters + +##### limit? + +`number` + +#### Returns + +`Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> diff --git a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md new file mode 100644 index 0000000..ec468fc --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md @@ -0,0 +1,49 @@ +--- +title: MerkleTreeNode +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MerkleTreeNode + +# Interface: MerkleTreeNode + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L6) + +## Extends + +- [`MerkleTreeNodeQuery`](MerkleTreeNodeQuery.md) + +## Properties + +### key + +> **key**: `bigint` + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) + +#### Inherited from + +[`MerkleTreeNodeQuery`](MerkleTreeNodeQuery.md).[`key`](MerkleTreeNodeQuery.md#key) + +*** + +### level + +> **level**: `number` + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) + +#### Inherited from + +[`MerkleTreeNodeQuery`](MerkleTreeNodeQuery.md).[`level`](MerkleTreeNodeQuery.md#level) + +*** + +### value + +> **value**: `bigint` + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L7) diff --git a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md new file mode 100644 index 0000000..5047d14 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md @@ -0,0 +1,33 @@ +--- +title: MerkleTreeNodeQuery +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MerkleTreeNodeQuery + +# Interface: MerkleTreeNodeQuery + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L1) + +## Extended by + +- [`MerkleTreeNode`](MerkleTreeNode.md) + +## Properties + +### key + +> **key**: `bigint` + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) + +*** + +### level + +> **level**: `number` + +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) diff --git a/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md b/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md new file mode 100644 index 0000000..1d5fc54 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md @@ -0,0 +1,59 @@ +--- +title: MessageStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MessageStorage + +# Interface: MessageStorage + +Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/MessageStorage.ts#L6) + +Interface to store Messages previously fetched by a IncomingMessageadapter + +## Properties + +### getMessages() + +> **getMessages**: (`fromMessagesHash`) => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> + +Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/MessageStorage.ts#L12) + +#### Parameters + +##### fromMessagesHash + +`string` + +#### Returns + +`Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> + +*** + +### pushMessages() + +> **pushMessages**: (`fromMessagesHash`, `toMessagesHash`, `messages`) => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/MessageStorage.ts#L7) + +#### Parameters + +##### fromMessagesHash + +`string` + +##### toMessagesHash + +`string` + +##### messages + +[`PendingTransaction`](../classes/PendingTransaction.md)[] + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md b/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md new file mode 100644 index 0000000..3989bfc --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md @@ -0,0 +1,21 @@ +--- +title: MinaBaseLayerConfig +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaBaseLayerConfig + +# Interface: MinaBaseLayerConfig + +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L16) + +## Properties + +### network + +> **network**: \{ `type`: `"local"`; \} \| \{ `accountManager`: `string`; `archive`: `string`; `graphql`: `string`; `type`: `"lightnet"`; \} \| \{ `archive`: `string`; `graphql`: `string`; `type`: `"remote"`; \} + +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L17) diff --git a/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md b/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md new file mode 100644 index 0000000..02f4645 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md @@ -0,0 +1,49 @@ +--- +title: NetworkStateTransportModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NetworkStateTransportModule + +# Interface: NetworkStateTransportModule + +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L3) + +## Properties + +### getProvenNetworkState() + +> **getProvenNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L6) + +#### Returns + +`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +*** + +### getStagedNetworkState() + +> **getStagedNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L5) + +#### Returns + +`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +*** + +### getUnprovenNetworkState() + +> **getUnprovenNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> + +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L4) + +#### Returns + +`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> diff --git a/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md b/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md new file mode 100644 index 0000000..9f70a81 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md @@ -0,0 +1,45 @@ +--- +title: NewBlockProverParameters +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NewBlockProverParameters + +# Interface: NewBlockProverParameters + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L30) + +## Properties + +### blockWitness + +> **blockWitness**: [`BlockHashMerkleTreeWitness`](../../protocol/classes/BlockHashMerkleTreeWitness.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L33) + +*** + +### networkState + +> **networkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L32) + +*** + +### publicInput + +> **publicInput**: [`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L31) + +*** + +### startingState + +> **startingState**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L34) diff --git a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md new file mode 100644 index 0000000..1988356 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md @@ -0,0 +1,33 @@ +--- +title: OutgoingMessage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / OutgoingMessage + +# Interface: OutgoingMessage\ + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L13) + +## Type Parameters + +• **Type** + +## Properties + +### index + +> **index**: `number` + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L14) + +*** + +### value + +> **value**: `Type` + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L15) diff --git a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md new file mode 100644 index 0000000..9a29482 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md @@ -0,0 +1,68 @@ +--- +title: OutgoingMessageQueue +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / OutgoingMessageQueue + +# Interface: OutgoingMessageQueue + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L37) + +This interface allows the SettlementModule to retrieve information about +pending L2-dispatched (outgoing) messages that it can then use to roll +them up on the L1 contract. + +In the future, this interface should be flexibly typed so that the +outgoing message type is not limited to Withdrawals + +## Properties + +### length() + +> **length**: () => `number` + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L40) + +#### Returns + +`number` + +*** + +### peek() + +> **peek**: (`num`) => [`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L38) + +#### Parameters + +##### num + +`number` + +#### Returns + +[`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] + +*** + +### pop() + +> **pop**: (`num`) => [`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] + +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L39) + +#### Parameters + +##### num + +`number` + +#### Returns + +[`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] diff --git a/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md b/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md new file mode 100644 index 0000000..9f736bf --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md @@ -0,0 +1,48 @@ +--- +title: PairingDerivedInput +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PairingDerivedInput + +# Interface: PairingDerivedInput\ + +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L16) + +This type is used to consistently define the input type of a MapReduce flow + that is depenend on the result a pairing. + +## Type Parameters + +• **Input1** + +• **Input2** + +• **AdditionalParameters** + +## Properties + +### input1 + +> **input1**: `Input1` + +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L17) + +*** + +### input2 + +> **input2**: `Input2` + +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L18) + +*** + +### params + +> **params**: `AdditionalParameters` + +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L19) diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md b/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md new file mode 100644 index 0000000..faf274f --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md @@ -0,0 +1,53 @@ +--- +title: QueryGetterState +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / QueryGetterState + +# Interface: QueryGetterState\ + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L24) + +## Type Parameters + +• **Value** + +## Properties + +### get() + +> **get**: () => `Promise`\<`undefined` \| `Value`\> + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L25) + +#### Returns + +`Promise`\<`undefined` \| `Value`\> + +*** + +### merkleWitness() + +> **merkleWitness**: () => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L27) + +#### Returns + +`Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> + +*** + +### path() + +> **path**: () => `string` + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L26) + +#### Returns + +`string` diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md b/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md new file mode 100644 index 0000000..cb495b9 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md @@ -0,0 +1,73 @@ +--- +title: QueryGetterStateMap +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / QueryGetterStateMap + +# Interface: QueryGetterStateMap\ + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L30) + +## Type Parameters + +• **Key** + +• **Value** + +## Properties + +### get() + +> **get**: (`key`) => `Promise`\<`undefined` \| `Value`\> + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L31) + +#### Parameters + +##### key + +`Key` + +#### Returns + +`Promise`\<`undefined` \| `Value`\> + +*** + +### merkleWitness() + +> **merkleWitness**: (`key`) => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L33) + +#### Parameters + +##### key + +`Key` + +#### Returns + +`Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> + +*** + +### path() + +> **path**: (`key`) => `string` + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L32) + +#### Parameters + +##### key + +`Key` + +#### Returns + +`string` diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md b/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md new file mode 100644 index 0000000..c267750 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md @@ -0,0 +1,49 @@ +--- +title: QueryTransportModule +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / QueryTransportModule + +# Interface: QueryTransportModule + +Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L4) + +## Properties + +### get() + +> **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> + +Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L5) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| `Field`[]\> + +*** + +### merkleWitness() + +> **merkleWitness**: (`key`) => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> + +Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L6) + +#### Parameters + +##### key + +`Field` + +#### Returns + +`Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> diff --git a/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md b/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md new file mode 100644 index 0000000..1ebcebf --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md @@ -0,0 +1,37 @@ +--- +title: RuntimeProofParameters +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / RuntimeProofParameters + +# Interface: RuntimeProofParameters + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L26) + +## Properties + +### networkState + +> **networkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L28) + +*** + +### state + +> **state**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L29) + +*** + +### tx + +> **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L27) diff --git a/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md b/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md new file mode 100644 index 0000000..08072c1 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md @@ -0,0 +1,25 @@ +--- +title: Sequenceable +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Sequenceable + +# Interface: Sequenceable + +Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L1) + +## Properties + +### start() + +> **start**: () => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:2](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L2) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md b/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md new file mode 100644 index 0000000..db36521 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md @@ -0,0 +1,69 @@ +--- +title: SettleableBatch +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettleableBatch + +# Interface: SettleableBatch + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L18) + +## Extends + +- [`Batch`](Batch.md) + +## Properties + +### blockHashes + +> **blockHashes**: `string`[] + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L14) + +#### Inherited from + +[`Batch`](Batch.md).[`blockHashes`](Batch.md#blockhashes) + +*** + +### fromNetworkState + +> **fromNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L19) + +*** + +### height + +> **height**: `number` + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L15) + +#### Inherited from + +[`Batch`](Batch.md).[`height`](Batch.md#height) + +*** + +### proof + +> **proof**: `JsonProof` + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L13) + +#### Inherited from + +[`Batch`](Batch.md).[`proof`](Batch.md#proof) + +*** + +### toNetworkState + +> **toNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) + +Defined in: [packages/sequencer/src/storage/model/Batch.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L20) diff --git a/src/pages/docs/reference/sequencer/interfaces/Settlement.md b/src/pages/docs/reference/sequencer/interfaces/Settlement.md new file mode 100644 index 0000000..98808c7 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/Settlement.md @@ -0,0 +1,29 @@ +--- +title: Settlement +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Settlement + +# Interface: Settlement + +Defined in: [packages/sequencer/src/storage/model/Settlement.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Settlement.ts#L1) + +## Properties + +### batches + +> **batches**: `number`[] + +Defined in: [packages/sequencer/src/storage/model/Settlement.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Settlement.ts#L6) + +*** + +### promisedMessagesHash + +> **promisedMessagesHash**: `string` + +Defined in: [packages/sequencer/src/storage/model/Settlement.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Settlement.ts#L5) diff --git a/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md b/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md new file mode 100644 index 0000000..a7dab0b --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md @@ -0,0 +1,29 @@ +--- +title: SettlementModuleConfig +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettlementModuleConfig + +# Interface: SettlementModuleConfig + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L52) + +## Properties + +### address? + +> `optional` **address**: `PublicKey` + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L54) + +*** + +### feepayer + +> **feepayer**: `PrivateKey` + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L53) diff --git a/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md b/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md new file mode 100644 index 0000000..a58d403 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md @@ -0,0 +1,31 @@ +--- +title: SettlementStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettlementStorage + +# Interface: SettlementStorage + +Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L3) + +## Properties + +### pushSettlement() + +> **pushSettlement**: (`settlement`) => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L4) + +#### Parameters + +##### settlement + +[`Settlement`](Settlement.md) + +#### Returns + +`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/StateEntry.md b/src/pages/docs/reference/sequencer/interfaces/StateEntry.md new file mode 100644 index 0000000..848650c --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/StateEntry.md @@ -0,0 +1,29 @@ +--- +title: StateEntry +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateEntry + +# Interface: StateEntry + +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L3) + +## Properties + +### key + +> **key**: `Field` + +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L4) + +*** + +### value + +> **value**: `undefined` \| `Field`[] + +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L5) diff --git a/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md b/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md new file mode 100644 index 0000000..4544fbd --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md @@ -0,0 +1,45 @@ +--- +title: StateTransitionProofParameters +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateTransitionProofParameters + +# Interface: StateTransitionProofParameters + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L27) + +## Properties + +### merkleWitnesses + +> **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L33) + +*** + +### publicInput + +> **publicInput**: [`StateTransitionProverPublicInput`](../../protocol/classes/StateTransitionProverPublicInput.md) + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L28) + +*** + +### stateTransitions + +> **stateTransitions**: `object`[] + +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L29) + +#### transition + +> **transition**: [`ProvableStateTransition`](../../protocol/classes/ProvableStateTransition.md) + +#### type + +> **type**: [`ProvableStateTransitionType`](../../protocol/classes/ProvableStateTransitionType.md) diff --git a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md new file mode 100644 index 0000000..95d63a7 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md @@ -0,0 +1,48 @@ +--- +title: StorageDependencyFactory +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StorageDependencyFactory + +# Interface: StorageDependencyFactory + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L30) + +This is an abstract class for creating DependencyFactories, a pattern +to bundle multiple smaller services into one and register them into the +injection context. + +This can for example be a StorageDependencyFactory that creates dependencies +like StateService, MerkleWitnessService, etc. So in general, services that +are not ConfigurableModules, but still are their own logical unit. + +DependencyFactories are designed to only be used statically for sets of +deps that are necessary for the sequencer to work. + +## Extends + +- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) + +## Extended by + +- [`Database`](Database.md) + +## Properties + +### dependencies() + +> **dependencies**: () => [`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) + +#### Returns + +[`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) + +#### Overrides + +[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) diff --git a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md new file mode 100644 index 0000000..235c385 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md @@ -0,0 +1,109 @@ +--- +title: StorageDependencyMinimumDependencies +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StorageDependencyMinimumDependencies + +# Interface: StorageDependencyMinimumDependencies + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L16) + +## Extends + +- [`DependencyRecord`](../../common/type-aliases/DependencyRecord.md) + +## Indexable + +\[`key`: `string`\]: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<`unknown`\> & `object` + +## Properties + +### asyncMerkleStore + +> **asyncMerkleStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L18) + +*** + +### asyncStateService + +> **asyncStateService**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncStateService`](AsyncStateService.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L17) + +*** + +### batchStorage + +> **batchStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BatchStorage`](BatchStorage.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L19) + +*** + +### blockQueue + +> **blockQueue**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BlockQueue`](BlockQueue.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L20) + +*** + +### blockStorage + +> **blockStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BlockStorage`](BlockStorage.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L21) + +*** + +### blockTreeStore + +> **blockTreeStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L24) + +*** + +### messageStorage + +> **messageStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`MessageStorage`](MessageStorage.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L25) + +*** + +### settlementStorage + +> **settlementStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`SettlementStorage`](SettlementStorage.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L26) + +*** + +### transactionStorage + +> **transactionStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`TransactionStorage`](TransactionStorage.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L27) + +*** + +### unprovenMerkleStore + +> **unprovenMerkleStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L23) + +*** + +### unprovenStateService + +> **unprovenStateService**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncStateService`](AsyncStateService.md)\> + +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L22) diff --git a/src/pages/docs/reference/sequencer/interfaces/Task.md b/src/pages/docs/reference/sequencer/interfaces/Task.md new file mode 100644 index 0000000..c1fa0e3 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/Task.md @@ -0,0 +1,81 @@ +--- +title: Task +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Task + +# Interface: Task\ + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L1) + +## Type Parameters + +• **Input** + +• **Result** + +## Properties + +### compute() + +> **compute**: (`input`) => `Promise`\<`Result`\> + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L6) + +#### Parameters + +##### input + +`Input` + +#### Returns + +`Promise`\<`Result`\> + +*** + +### inputSerializer() + +> **inputSerializer**: () => [`TaskSerializer`](TaskSerializer.md)\<`Input`\> + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L8) + +#### Returns + +[`TaskSerializer`](TaskSerializer.md)\<`Input`\> + +*** + +### name + +> **name**: `string` + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:2](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L2) + +*** + +### prepare() + +> **prepare**: () => `Promise`\<`void`\> + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L4) + +#### Returns + +`Promise`\<`void`\> + +*** + +### resultSerializer() + +> **resultSerializer**: () => [`TaskSerializer`](TaskSerializer.md)\<`Result`\> + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L9) + +#### Returns + +[`TaskSerializer`](TaskSerializer.md)\<`Result`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md b/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md new file mode 100644 index 0000000..5b2b0ca --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md @@ -0,0 +1,53 @@ +--- +title: TaskPayload +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskPayload + +# Interface: TaskPayload + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L17) + +## Properties + +### flowId + +> **flowId**: `string` + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L22) + +*** + +### name + +> **name**: `string` + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L19) + +*** + +### payload + +> **payload**: `string` + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L20) + +*** + +### status? + +> `optional` **status**: `"error"` \| `"success"` + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L18) + +*** + +### taskId? + +> `optional` **taskId**: `string` + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L21) diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md b/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md new file mode 100644 index 0000000..5e19223 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md @@ -0,0 +1,62 @@ +--- +title: TaskQueue +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskQueue + +# Interface: TaskQueue + +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L8) + +Definition of a connection-object that can generate queues and workers +for a specific connection type (e.g. BullMQ, In-memory) + +## Properties + +### createWorker() + +> **createWorker**: (`name`, `executor`, `options`?) => [`Closeable`](Closeable.md) + +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L11) + +#### Parameters + +##### name + +`string` + +##### executor + +(`data`) => `Promise`\<[`TaskPayload`](TaskPayload.md)\> + +##### options? + +###### concurrency + +`number` + +#### Returns + +[`Closeable`](Closeable.md) + +*** + +### getQueue() + +> **getQueue**: (`name`) => `Promise`\<[`InstantiatedQueue`](InstantiatedQueue.md)\> + +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L9) + +#### Parameters + +##### name + +`string` + +#### Returns + +`Promise`\<[`InstantiatedQueue`](InstantiatedQueue.md)\> diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md b/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md new file mode 100644 index 0000000..d3f9c61 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md @@ -0,0 +1,53 @@ +--- +title: TaskSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskSerializer + +# Interface: TaskSerializer\ + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L12) + +## Type Parameters + +• **Type** + +## Properties + +### fromJSON() + +> **fromJSON**: (`json`) => `Type` \| `Promise`\<`Type`\> + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L14) + +#### Parameters + +##### json + +`string` + +#### Returns + +`Type` \| `Promise`\<`Type`\> + +*** + +### toJSON() + +> **toJSON**: (`input`) => `string` \| `Promise`\<`string`\> + +Defined in: [packages/sequencer/src/worker/flow/Task.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L13) + +#### Parameters + +##### input + +`Type` + +#### Returns + +`string` \| `Promise`\<`string`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md new file mode 100644 index 0000000..d545bc2 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md @@ -0,0 +1,51 @@ +--- +title: TimedBlockTriggerConfig +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TimedBlockTriggerConfig + +# Interface: TimedBlockTriggerConfig + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L16) + +## Properties + +### blockInterval + +> **blockInterval**: `number` + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L26) + +*** + +### produceEmptyBlocks? + +> `optional` **produceEmptyBlocks**: `boolean` + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L27) + +*** + +### settlementInterval? + +> `optional` **settlementInterval**: `number` + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L25) + +*** + +### tick? + +> `optional` **tick**: `number` + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L24) + +Interval for the tick event to be fired. +The time x of any block trigger time is always guaranteed to be +tick % x == 0. +Value has to be a divisor of gcd(blockInterval, settlementInterval). +If it doesn't satisfy this requirement, this config will not be respected diff --git a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md new file mode 100644 index 0000000..a6468b2 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md @@ -0,0 +1,61 @@ +--- +title: TimedBlockTriggerEvent +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TimedBlockTriggerEvent + +# Interface: TimedBlockTriggerEvent + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L30) + +## Extends + +- [`BlockEvents`](../type-aliases/BlockEvents.md) + +## Properties + +### batch-produced + +> **batch-produced**: \[[`Batch`](Batch.md)\] + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L31) + +#### Inherited from + +`BlockEvents.batch-produced` + +*** + +### block-metadata-produced + +> **block-metadata-produced**: \[[`BlockWithResult`](BlockWithResult.md)\] + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L30) + +#### Inherited from + +`BlockEvents.block-metadata-produced` + +*** + +### block-produced + +> **block-produced**: \[[`Block`](Block.md)\] + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L29) + +#### Inherited from + +`BlockEvents.block-produced` + +*** + +### tick + +> **tick**: \[`number`\] + +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L31) diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md b/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md new file mode 100644 index 0000000..49d1f5e --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md @@ -0,0 +1,69 @@ +--- +title: TransactionExecutionResult +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionExecutionResult + +# Interface: TransactionExecutionResult + +Defined in: [packages/sequencer/src/storage/model/Block.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L13) + +## Properties + +### events + +> **events**: `object`[] + +Defined in: [packages/sequencer/src/storage/model/Block.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L19) + +#### data + +> **data**: `Field`[] + +#### eventName + +> **eventName**: `string` + +*** + +### protocolTransitions + +> **protocolTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] + +Defined in: [packages/sequencer/src/storage/model/Block.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L16) + +*** + +### stateTransitions + +> **stateTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] + +Defined in: [packages/sequencer/src/storage/model/Block.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L15) + +*** + +### status + +> **status**: `Bool` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L17) + +*** + +### statusMessage? + +> `optional` **statusMessage**: `string` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L18) + +*** + +### tx + +> **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) + +Defined in: [packages/sequencer/src/storage/model/Block.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L14) diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md b/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md new file mode 100644 index 0000000..b2cca4b --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md @@ -0,0 +1,66 @@ +--- +title: TransactionStorage +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionStorage + +# Interface: TransactionStorage + +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L3) + +## Properties + +### findTransaction() + +> **findTransaction**: (`hash`) => `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../classes/PendingTransaction.md); \}\> + +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L15) + +Finds a transaction by its hash. +It returns both pending transaction and already included transactions +In case the transaction has been included, it also returns the block hash +and batch number where applicable. + +#### Parameters + +##### hash + +`string` + +#### Returns + +`Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../classes/PendingTransaction.md); \}\> + +*** + +### getPendingUserTransactions() + +> **getPendingUserTransactions**: () => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> + +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L6) + +#### Returns + +`Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> + +*** + +### pushUserTransaction() + +> **pushUserTransaction**: (`tx`) => `Promise`\<`boolean`\> + +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L4) + +#### Parameters + +##### tx + +[`PendingTransaction`](../classes/PendingTransaction.md) + +#### Returns + +`Promise`\<`boolean`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md b/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md new file mode 100644 index 0000000..4e1951e --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md @@ -0,0 +1,37 @@ +--- +title: TransactionTrace +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionTrace + +# Interface: TransactionTrace + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L37) + +## Properties + +### blockProver + +> **blockProver**: [`BlockProverParameters`](BlockProverParameters.md) + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L40) + +*** + +### runtimeProver + +> **runtimeProver**: [`RuntimeProofParameters`](RuntimeProofParameters.md) + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L38) + +*** + +### stateTransitionProver + +> **stateTransitionProver**: [`StateTransitionProofParameters`](StateTransitionProofParameters.md)[] + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L39) diff --git a/src/pages/docs/reference/sequencer/interfaces/TxEvents.md b/src/pages/docs/reference/sequencer/interfaces/TxEvents.md new file mode 100644 index 0000000..981a0a0 --- /dev/null +++ b/src/pages/docs/reference/sequencer/interfaces/TxEvents.md @@ -0,0 +1,45 @@ +--- +title: TxEvents +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TxEvents + +# Interface: TxEvents + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L22) + +## Extends + +- [`EventsRecord`](../../common/type-aliases/EventsRecord.md) + +## Indexable + +\[`key`: `string`\]: `unknown`[] + +## Properties + +### included + +> **included**: \[\{ `hash`: `string`; \}\] + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L24) + +*** + +### rejected + +> **rejected**: \[`any`\] + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L25) + +*** + +### sent + +> **sent**: \[\{ `hash`: `string`; \}\] + +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L23) diff --git a/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md b/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md new file mode 100644 index 0000000..c7abbc5 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md @@ -0,0 +1,15 @@ +--- +title: AllTaskWorkerModules +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / AllTaskWorkerModules + +# Type Alias: AllTaskWorkerModules + +> **AllTaskWorkerModules**: [`ReturnType`](../../protocol/type-aliases/ReturnType.md)\<*typeof* [`allTasks`](../classes/VanillaTaskWorkerModules.md#alltasks)\> + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:171](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L171) diff --git a/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md b/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md new file mode 100644 index 0000000..011b92b --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md @@ -0,0 +1,29 @@ +--- +title: BlockEvents +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockEvents + +# Type Alias: BlockEvents + +> **BlockEvents**: `object` + +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L28) + +## Type declaration + +### batch-produced + +> **batch-produced**: \[[`Batch`](../interfaces/Batch.md)\] + +### block-metadata-produced + +> **block-metadata-produced**: \[[`BlockWithResult`](../interfaces/BlockWithResult.md)\] + +### block-produced + +> **block-produced**: \[[`Block`](../interfaces/Block.md)\] diff --git a/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md b/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md new file mode 100644 index 0000000..80ed595 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md @@ -0,0 +1,25 @@ +--- +title: ChainStateTaskArgs +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ChainStateTaskArgs + +# Type Alias: ChainStateTaskArgs + +> **ChainStateTaskArgs**: `object` + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L44) + +## Type declaration + +### accounts + +> **accounts**: `Account`[] + +### graphql + +> **graphql**: `string` \| `undefined` diff --git a/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md b/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md new file mode 100644 index 0000000..2703fd6 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md @@ -0,0 +1,21 @@ +--- +title: DatabasePruneConfig +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / DatabasePruneConfig + +# Type Alias: DatabasePruneConfig + +> **DatabasePruneConfig**: `object` + +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/DatabasePruneModule.ts#L11) + +## Type declaration + +### pruneOnStartup? + +> `optional` **pruneOnStartup**: `boolean` diff --git a/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md b/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md new file mode 100644 index 0000000..980d80d --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md @@ -0,0 +1,15 @@ +--- +title: JSONEncodableState +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / JSONEncodableState + +# Type Alias: JSONEncodableState + +> **JSONEncodableState**: `Record`\<`string`, `string`[]\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L32) diff --git a/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md b/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md new file mode 100644 index 0000000..19cceb8 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md @@ -0,0 +1,19 @@ +--- +title: MapStateMapToQuery +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MapStateMapToQuery + +# Type Alias: MapStateMapToQuery\ + +> **MapStateMapToQuery**\<`StateProperty`\>: `StateProperty` *extends* [`StateMap`](../../protocol/classes/StateMap.md)\ ? [`QueryGetterStateMap`](../interfaces/QueryGetterStateMap.md)\<`Key`, `Value`\> : `never` + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L43) + +## Type Parameters + +• **StateProperty** diff --git a/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md b/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md new file mode 100644 index 0000000..2acdb1d --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md @@ -0,0 +1,19 @@ +--- +title: MapStateToQuery +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MapStateToQuery + +# Type Alias: MapStateToQuery\ + +> **MapStateToQuery**\<`StateProperty`\>: `StateProperty` *extends* [`State`](../../protocol/classes/State.md)\ ? [`QueryGetterState`](../interfaces/QueryGetterState.md)\<`Value`\> : `never` + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L40) + +## Type Parameters + +• **StateProperty** diff --git a/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md b/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md new file mode 100644 index 0000000..3a916e0 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md @@ -0,0 +1,21 @@ +--- +title: MempoolEvents +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MempoolEvents + +# Type Alias: MempoolEvents + +> **MempoolEvents**: `object` + +Defined in: [packages/sequencer/src/mempool/Mempool.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/Mempool.ts#L5) + +## Type declaration + +### mempool-transaction-added + +> **mempool-transaction-added**: \[[`PendingTransaction`](../classes/PendingTransaction.md)\] diff --git a/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md b/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md new file mode 100644 index 0000000..465bab5 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md @@ -0,0 +1,19 @@ +--- +title: ModuleQuery +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ModuleQuery + +# Type Alias: ModuleQuery\ + +> **ModuleQuery**\<`Module`\>: `{ [Key in keyof PickStateMapProperties]: MapStateMapToQuery[Key]> }` & `{ [Key in keyof PickStateProperties]: MapStateToQuery[Key]> }` + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L48) + +## Type Parameters + +• **Module** diff --git a/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md b/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md new file mode 100644 index 0000000..7162735 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md @@ -0,0 +1,15 @@ +--- +title: NewBlockProvingParameters +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NewBlockProvingParameters + +# Type Alias: NewBlockProvingParameters + +> **NewBlockProvingParameters**: [`PairingDerivedInput`](../interfaces/PairingDerivedInput.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md), `BlockProof`, [`NewBlockProverParameters`](../interfaces/NewBlockProverParameters.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L37) diff --git a/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md b/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md new file mode 100644 index 0000000..a8156f4 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md @@ -0,0 +1,19 @@ +--- +title: PairTuple +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PairTuple + +# Type Alias: PairTuple\ + +> **PairTuple**\<`Type`\>: \[`Type`, `Type`\] + +Defined in: [packages/sequencer/src/helpers/utils.ts:162](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L162) + +## Type Parameters + +• **Type** diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickByType.md b/src/pages/docs/reference/sequencer/type-aliases/PickByType.md new file mode 100644 index 0000000..ce6e7e7 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/PickByType.md @@ -0,0 +1,21 @@ +--- +title: PickByType +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PickByType + +# Type Alias: PickByType\ + +> **PickByType**\<`Type`, `Value`\>: \{ \[Key in keyof Type as Type\[Key\] extends Value \| undefined ? Key : never\]: Type\[Key\] \} + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L18) + +## Type Parameters + +• **Type** + +• **Value** diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md b/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md new file mode 100644 index 0000000..2ef1863 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md @@ -0,0 +1,19 @@ +--- +title: PickStateMapProperties +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PickStateMapProperties + +# Type Alias: PickStateMapProperties\ + +> **PickStateMapProperties**\<`Type`\>: [`PickByType`](PickByType.md)\<`Type`, [`StateMap`](../../protocol/classes/StateMap.md)\<`any`, `any`\>\> + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L38) + +## Type Parameters + +• **Type** diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md b/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md new file mode 100644 index 0000000..99dbd85 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md @@ -0,0 +1,19 @@ +--- +title: PickStateProperties +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PickStateProperties + +# Type Alias: PickStateProperties\ + +> **PickStateProperties**\<`Type`\>: [`PickByType`](PickByType.md)\<`Type`, [`State`](../../protocol/classes/State.md)\<`any`\>\> + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L36) + +## Type Parameters + +• **Type** diff --git a/src/pages/docs/reference/sequencer/type-aliases/Query.md b/src/pages/docs/reference/sequencer/type-aliases/Query.md new file mode 100644 index 0000000..133a8c9 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/Query.md @@ -0,0 +1,21 @@ +--- +title: Query +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Query + +# Type Alias: Query\ + +> **Query**\<`ModuleType`, `ModuleRecord`\>: `{ [Key in keyof ModuleRecord]: ModuleQuery> }` + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L58) + +## Type Parameters + +• **ModuleType** + +• **ModuleRecord** *extends* `Record`\<`string`, [`TypedClass`](TypedClass.md)\<`ModuleType`\>\> diff --git a/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md b/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md new file mode 100644 index 0000000..3a4c8c7 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md @@ -0,0 +1,15 @@ +--- +title: RuntimeContextReducedExecutionResult +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / RuntimeContextReducedExecutionResult + +# Type Alias: RuntimeContextReducedExecutionResult + +> **RuntimeContextReducedExecutionResult**: `Pick`\<[`RuntimeProvableMethodExecutionResult`](../../protocol/classes/RuntimeProvableMethodExecutionResult.md), `"stateTransitions"` \| `"status"` \| `"statusMessage"` \| `"stackTrace"` \| `"events"`\> + +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L37) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md b/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md new file mode 100644 index 0000000..28e4f0e --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md @@ -0,0 +1,15 @@ +--- +title: SequencerModulesRecord +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SequencerModulesRecord + +# Type Alias: SequencerModulesRecord + +> **SequencerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](TypedClass.md)\<[`SequencerModule`](../classes/SequencerModule.md)\<`unknown`\>\>\> + +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L25) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md b/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md new file mode 100644 index 0000000..70947ec --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md @@ -0,0 +1,15 @@ +--- +title: SerializedArtifactRecord +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SerializedArtifactRecord + +# Type Alias: SerializedArtifactRecord + +> **SerializedArtifactRecord**: `Record`\<`string`, \{ `verificationKey`: \{ `data`: `string`; `hash`: `string`; \}; \}\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L5) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md b/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md new file mode 100644 index 0000000..6e4eb3c --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md @@ -0,0 +1,21 @@ +--- +title: SettlementModuleEvents +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettlementModuleEvents + +# Type Alias: SettlementModuleEvents + +> **SettlementModuleEvents**: `object` + +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L57) + +## Type declaration + +### settlement-submitted + +> **settlement-submitted**: \[[`Batch`](../interfaces/Batch.md)\] diff --git a/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md b/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md new file mode 100644 index 0000000..979fc5a --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md @@ -0,0 +1,25 @@ +--- +title: SomeRuntimeMethod +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SomeRuntimeMethod + +# Type Alias: SomeRuntimeMethod() + +> **SomeRuntimeMethod**: (...`args`) => `Promise`\<`unknown`\> + +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L35) + +## Parameters + +### args + +...`unknown`[] + +## Returns + +`Promise`\<`unknown`\> diff --git a/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md b/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md new file mode 100644 index 0000000..5e254a3 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md @@ -0,0 +1,15 @@ +--- +title: StateRecord +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateRecord + +# Type Alias: StateRecord + +> **StateRecord**: `Record`\<`string`, `Field`[] \| `undefined`\> + +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L35) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md b/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md new file mode 100644 index 0000000..c0eb45b --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md @@ -0,0 +1,15 @@ +--- +title: TaskStateRecord +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskStateRecord + +# Type Alias: TaskStateRecord + +> **TaskStateRecord**: `Record`\<`string`, `Field`[]\> + +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L32) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md new file mode 100644 index 0000000..30e074e --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md @@ -0,0 +1,15 @@ +--- +title: TaskWorkerModulesRecord +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskWorkerModulesRecord + +# Type Alias: TaskWorkerModulesRecord + +> **TaskWorkerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](TypedClass.md)\<[`TaskWorkerModule`](../classes/TaskWorkerModule.md) & [`Task`](../interfaces/Task.md)\<`any`, `any`\>\>\> + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L41) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md new file mode 100644 index 0000000..58a61e6 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md @@ -0,0 +1,15 @@ +--- +title: TaskWorkerModulesWithoutSettlement +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskWorkerModulesWithoutSettlement + +# Type Alias: TaskWorkerModulesWithoutSettlement + +> **TaskWorkerModulesWithoutSettlement**: [`ReturnType`](../../protocol/type-aliases/ReturnType.md)\<*typeof* [`withoutSettlement`](../classes/VanillaTaskWorkerModules.md#withoutsettlement)\> + +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:168](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L168) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md new file mode 100644 index 0000000..401826d --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md @@ -0,0 +1,15 @@ +--- +title: TransactionProvingTaskParameters +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionProvingTaskParameters + +# Type Alias: TransactionProvingTaskParameters + +> **TransactionProvingTaskParameters**: [`PairingDerivedInput`](../interfaces/PairingDerivedInput.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md), `RuntimeProof`, [`BlockProverParameters`](../interfaces/BlockProverParameters.md)\> + +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L42) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md new file mode 100644 index 0000000..70e7e69 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md @@ -0,0 +1,25 @@ +--- +title: TransactionTaskArgs +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionTaskArgs + +# Type Alias: TransactionTaskArgs + +> **TransactionTaskArgs**: `object` + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L49) + +## Type declaration + +### chainState + +> **chainState**: [`ChainStateTaskArgs`](ChainStateTaskArgs.md) + +### transaction + +> **transaction**: `Transaction`\<`false`, `true`\> diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md new file mode 100644 index 0000000..85d1976 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md @@ -0,0 +1,21 @@ +--- +title: TransactionTaskResult +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionTaskResult + +# Type Alias: TransactionTaskResult + +> **TransactionTaskResult**: `object` + +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L54) + +## Type declaration + +### transaction + +> **transaction**: `Mina.Transaction`\<`true`, `true`\> diff --git a/src/pages/docs/reference/sequencer/type-aliases/TypedClass.md b/src/pages/docs/reference/sequencer/type-aliases/TypedClass.md new file mode 100644 index 0000000..d03b937 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/TypedClass.md @@ -0,0 +1,29 @@ +--- +title: TypedClass +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TypedClass + +# Type Alias: TypedClass()\ + +> **TypedClass**\<`Class`\>: (...`args`) => `Class` + +Defined in: packages/common/dist/types.d.ts:2 + +## Type Parameters + +• **Class** + +## Parameters + +### args + +...`any`[] + +## Returns + +`Class` diff --git a/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md b/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md new file mode 100644 index 0000000..5eb0a65 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md @@ -0,0 +1,44 @@ +--- +title: UnsignedTransactionBody +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / UnsignedTransactionBody + +# Type Alias: UnsignedTransactionBody + +> **UnsignedTransactionBody**: `object` + +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L17) + +## Type declaration + +### argsFields + +> **argsFields**: `Field`[] + +### auxiliaryData + +> **auxiliaryData**: `string`[] + +Used to transport non-provable data, mainly proof data for now +These values will not be part of the signature message or transaction hash + +### isMessage + +> **isMessage**: `boolean` + +### methodId + +> **methodId**: `Field` + +### nonce + +> **nonce**: `UInt64` + +### sender + +> **sender**: `PublicKey` diff --git a/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md b/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md new file mode 100644 index 0000000..6e112c4 --- /dev/null +++ b/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md @@ -0,0 +1,25 @@ +--- +title: VerificationKeyJSON +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / VerificationKeyJSON + +# Type Alias: VerificationKeyJSON + +> **VerificationKeyJSON**: `object` + +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L3) + +## Type declaration + +### data + +> **data**: `string` + +### hash + +> **hash**: `string` diff --git a/src/pages/docs/reference/sequencer/variables/Block.md b/src/pages/docs/reference/sequencer/variables/Block.md new file mode 100644 index 0000000..a668c6c --- /dev/null +++ b/src/pages/docs/reference/sequencer/variables/Block.md @@ -0,0 +1,45 @@ +--- +title: Block +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Block + +# Variable: Block + +> **Block**: `object` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L22) + +## Type declaration + +### calculateHash() + +#### Parameters + +##### height + +`Field` + +##### transactionsHash + +`Field` + +#### Returns + +`Field` + +### hash() + +#### Parameters + +##### block + +`Omit`\<[`Block`](../interfaces/Block.md), `"hash"`\> + +#### Returns + +`Field` diff --git a/src/pages/docs/reference/sequencer/variables/BlockWithResult.md b/src/pages/docs/reference/sequencer/variables/BlockWithResult.md new file mode 100644 index 0000000..b987186 --- /dev/null +++ b/src/pages/docs/reference/sequencer/variables/BlockWithResult.md @@ -0,0 +1,109 @@ +--- +title: BlockWithResult +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockWithResult + +# Variable: BlockWithResult + +> **BlockWithResult**: `object` + +Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L59) + +## Type declaration + +### createEmpty() + +> **createEmpty**: () => `object` + +#### Returns + +`object` + +##### block + +> **block**: `object` + +###### block.fromBlockHashRoot + +> **block.fromBlockHashRoot**: `Field` + +###### block.fromEternalTransactionsHash + +> **block.fromEternalTransactionsHash**: `Field` + +###### block.fromMessagesHash + +> **block.fromMessagesHash**: `Field` + +###### block.hash + +> **block.hash**: `Field` + +###### block.height + +> **block.height**: `Field` + +###### block.networkState + +> **block.networkState**: `object` + +###### block.networkState.before + +> **block.networkState.before**: [`NetworkState`](../../protocol/classes/NetworkState.md) + +###### block.networkState.during + +> **block.networkState.during**: [`NetworkState`](../../protocol/classes/NetworkState.md) + +###### block.previousBlockHash + +> **block.previousBlockHash**: `undefined` = `undefined` + +###### block.toEternalTransactionsHash + +> **block.toEternalTransactionsHash**: `Field` + +###### block.toMessagesHash + +> **block.toMessagesHash**: `Field` = `ACTIONS_EMPTY_HASH` + +###### block.transactions + +> **block.transactions**: `never`[] = `[]` + +###### block.transactionsHash + +> **block.transactionsHash**: `Field` + +##### result + +> **result**: `object` + +###### result.afterNetworkState + +> **result.afterNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) + +###### result.blockHash + +> **result.blockHash**: `bigint` = `0n` + +###### result.blockHashRoot + +> **result.blockHashRoot**: `bigint` = `BlockHashMerkleTree.EMPTY_ROOT` + +###### result.blockHashWitness + +> **result.blockHashWitness**: [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) + +###### result.blockStateTransitions + +> **result.blockStateTransitions**: `never`[] = `[]` + +###### result.stateRoot + +> **result.stateRoot**: `bigint` = `RollupMerkleTree.EMPTY_ROOT` diff --git a/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md b/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md new file mode 100644 index 0000000..3feec66 --- /dev/null +++ b/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md @@ -0,0 +1,27 @@ +--- +title: JSONTaskSerializer +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / JSONTaskSerializer + +# Variable: JSONTaskSerializer + +> `const` **JSONTaskSerializer**: `object` + +Defined in: [packages/sequencer/src/worker/flow/JSONTaskSerializer.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/JSONTaskSerializer.ts#L3) + +## Type declaration + +### fromType() + +#### Type Parameters + +• **Type** + +#### Returns + +[`TaskSerializer`](../interfaces/TaskSerializer.md)\<`Type`\> diff --git a/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md b/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md new file mode 100644 index 0000000..5f7b5fe --- /dev/null +++ b/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md @@ -0,0 +1,77 @@ +--- +title: QueryBuilderFactory +--- + +[**@proto-kit/sequencer**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / QueryBuilderFactory + +# Variable: QueryBuilderFactory + +> `const` **QueryBuilderFactory**: `object` + +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L71) + +## Type declaration + +### fillQuery() + +#### Type Parameters + +• **Module** *extends* `Object` + +#### Parameters + +##### runtimeModule + +`Module` + +##### queryTransportModule + +[`QueryTransportModule`](../interfaces/QueryTransportModule.md) + +#### Returns + +[`ModuleQuery`](../type-aliases/ModuleQuery.md)\<`Module`\> + +### fromProtocol() + +#### Type Parameters + +• **ProtocolModules** *extends* [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) + +#### Parameters + +##### protocol + +[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> + +##### queryTransportModule + +[`QueryTransportModule`](../interfaces/QueryTransportModule.md) + +#### Returns + +[`Query`](../type-aliases/Query.md)\<[`ProtocolModule`](../../protocol/classes/ProtocolModule.md)\<`unknown`\>, `ProtocolModules`\> + +### fromRuntime() + +#### Type Parameters + +• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) + +#### Parameters + +##### runtime + +[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> + +##### queryTransportModule + +[`QueryTransportModule`](../interfaces/QueryTransportModule.md) + +#### Returns + +[`Query`](../type-aliases/Query.md)\<[`RuntimeModule`](../../module/classes/RuntimeModule.md)\<`unknown`\>, `RuntimeModules`\> diff --git a/src/pages/docs/reference/stack/README.md b/src/pages/docs/reference/stack/README.md new file mode 100644 index 0000000..1fee6ba --- /dev/null +++ b/src/pages/docs/reference/stack/README.md @@ -0,0 +1,15 @@ +--- +title: "@proto-kit/stack" +--- + +**@proto-kit/stack** + +*** + +[Documentation](../../README.md) / @proto-kit/stack + +`docker-compose up --build` + +Select services to use in .env using profiles + +See deployment `README.md` for more information diff --git a/src/pages/docs/reference/stack/_meta.tsx b/src/pages/docs/reference/stack/_meta.tsx new file mode 100644 index 0000000..997bed8 --- /dev/null +++ b/src/pages/docs/reference/stack/_meta.tsx @@ -0,0 +1,3 @@ +export default { + "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/stack/classes/TestBalances.md b/src/pages/docs/reference/stack/classes/TestBalances.md new file mode 100644 index 0000000..e760196 --- /dev/null +++ b/src/pages/docs/reference/stack/classes/TestBalances.md @@ -0,0 +1,491 @@ +--- +title: TestBalances +--- + +[**@proto-kit/stack**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/stack](../README.md) / TestBalances + +# Class: TestBalances + +Defined in: [stack/src/scripts/graphql/server.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/stack/src/scripts/graphql/server.ts#L51) + +Base class for runtime modules providing the necessary utilities. + +## Extends + +- [`Balances`](../../library/classes/Balances.md) + +## Constructors + +### new TestBalances() + +> **new TestBalances**(): [`TestBalances`](TestBalances.md) + +Defined in: module/dist/runtime/RuntimeModule.d.ts:31 + +#### Returns + +[`TestBalances`](TestBalances.md) + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`constructor`](../../library/classes/Balances.md#constructors) + +## Properties + +### balances + +> **balances**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`BalancesKey`](../../library/classes/BalancesKey.md), [`Balance`](../../library/classes/Balance.md)\> + +Defined in: library/dist/runtime/Balances.d.ts:84 + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`balances`](../../library/classes/Balances.md#balances) + +*** + +### currentConfig + +> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) + +Defined in: common/dist/config/ConfigurableModule.d.ts:17 + +Store the config separately, so that we can apply additional +checks when retrieving it via the getter + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`currentConfig`](../../library/classes/Balances.md#currentconfig) + +*** + +### events? + +> `optional` **events**: [`RuntimeEvents`](../../module/classes/RuntimeEvents.md)\<`any`\> + +Defined in: module/dist/runtime/RuntimeModule.d.ts:30 + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`events`](../../library/classes/Balances.md#events) + +*** + +### isRuntimeModule + +> **isRuntimeModule**: `boolean` + +Defined in: module/dist/runtime/RuntimeModule.d.ts:27 + +This property exists only to typecheck that the RuntimeModule +was extended correctly in e.g. a decorator. We need at least +one non-optional property in this class to make the typechecking work. + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`isRuntimeModule`](../../library/classes/Balances.md#isruntimemodule) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: module/dist/runtime/RuntimeModule.d.ts:28 + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`name`](../../library/classes/Balances.md#name) + +*** + +### runtime? + +> `optional` **runtime**: [`RuntimeEnvironment`](../../module/interfaces/RuntimeEnvironment.md) + +Defined in: module/dist/runtime/RuntimeModule.d.ts:29 + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`runtime`](../../library/classes/Balances.md#runtime) + +*** + +### runtimeMethodNames + +> `readonly` **runtimeMethodNames**: `string`[] + +Defined in: module/dist/runtime/RuntimeModule.d.ts:21 + +Holds all method names that are callable throw transactions + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`runtimeMethodNames`](../../library/classes/Balances.md#runtimemethodnames) + +*** + +### totalSupply + +> **totalSupply**: [`State`](../../protocol/classes/State.md)\<[`UInt64`](../../library/classes/UInt64.md)\> + +Defined in: [stack/src/scripts/graphql/server.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/stack/src/scripts/graphql/server.ts#L58) + +We use `satisfies` here in order to be able to access +presets by key in a type safe way. + +*** + +### presets + +> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> + +Defined in: module/dist/runtime/RuntimeModule.d.ts:17 + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`presets`](../../library/classes/Balances.md#presets) + +## Accessors + +### config + +#### Get Signature + +> **get** **config**(): `Config` + +Defined in: common/dist/config/ConfigurableModule.d.ts:18 + +##### Returns + +`Config` + +#### Set Signature + +> **set** **config**(`config`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:19 + +##### Parameters + +###### config + +`Config` + +##### Returns + +`void` + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`config`](../../library/classes/Balances.md#config) + +*** + +### network + +#### Get Signature + +> **get** **network**(): [`NetworkState`](../../protocol/classes/NetworkState.md) + +Defined in: module/dist/runtime/RuntimeModule.d.ts:34 + +##### Returns + +[`NetworkState`](../../protocol/classes/NetworkState.md) + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`network`](../../library/classes/Balances.md#network) + +*** + +### transaction + +#### Get Signature + +> **get** **transaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +Defined in: module/dist/runtime/RuntimeModule.d.ts:33 + +##### Returns + +[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`transaction`](../../library/classes/Balances.md#transaction) + +## Methods + +### addBalance() + +> **addBalance**(`tokenId`, `address`, `balance`): `Promise`\<`void`\> + +Defined in: [stack/src/scripts/graphql/server.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/stack/src/scripts/graphql/server.ts#L69) + +#### Parameters + +##### tokenId + +[`TokenId`](../../library/classes/TokenId.md) + +##### address + +`PublicKey` + +##### balance + +[`UInt64`](../../library/classes/UInt64.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### burn() + +> **burn**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> + +Defined in: library/dist/runtime/Balances.d.ts:89 + +#### Parameters + +##### tokenId + +[`TokenId`](../../library/classes/TokenId.md) + +##### address + +`PublicKey` + +##### amount + +[`Balance`](../../library/classes/Balance.md) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`burn`](../../library/classes/Balances.md#burn) + +*** + +### create() + +> **create**(`childContainerProvider`): `void` + +Defined in: common/dist/config/ConfigurableModule.d.ts:20 + +#### Parameters + +##### childContainerProvider + +[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) + +#### Returns + +`void` + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`create`](../../library/classes/Balances.md#create) + +*** + +### getBalance() + +> **getBalance**(`tokenId`, `address`): `Promise`\<[`Balance`](../../library/classes/Balance.md)\> + +Defined in: library/dist/runtime/Balances.d.ts:85 + +#### Parameters + +##### tokenId + +[`TokenId`](../../library/classes/TokenId.md) + +##### address + +`PublicKey` + +#### Returns + +`Promise`\<[`Balance`](../../library/classes/Balance.md)\> + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`getBalance`](../../library/classes/Balances.md#getbalance) + +*** + +### getBalanceForUser() + +> **getBalanceForUser**(`tokenId`, `address`): `Promise`\<[`Balance`](../../library/classes/Balance.md)\> + +Defined in: [stack/src/scripts/graphql/server.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/stack/src/scripts/graphql/server.ts#L61) + +#### Parameters + +##### tokenId + +[`TokenId`](../../library/classes/TokenId.md) + +##### address + +`PublicKey` + +#### Returns + +`Promise`\<[`Balance`](../../library/classes/Balance.md)\> + +*** + +### getInputs() + +> **getInputs**(): [`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) + +Defined in: module/dist/runtime/RuntimeModule.d.ts:32 + +#### Returns + +[`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`getInputs`](../../library/classes/Balances.md#getinputs) + +*** + +### mint() + +> **mint**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> + +Defined in: library/dist/runtime/Balances.d.ts:88 + +#### Parameters + +##### tokenId + +[`TokenId`](../../library/classes/TokenId.md) + +##### address + +`PublicKey` + +##### amount + +[`Balance`](../../library/classes/Balance.md) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`mint`](../../library/classes/Balances.md#mint) + +*** + +### setBalance() + +> **setBalance**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> + +Defined in: library/dist/runtime/Balances.d.ts:86 + +#### Parameters + +##### tokenId + +[`TokenId`](../../library/classes/TokenId.md) + +##### address + +`PublicKey` + +##### amount + +[`Balance`](../../library/classes/Balance.md) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`setBalance`](../../library/classes/Balances.md#setbalance) + +*** + +### transfer() + +> **transfer**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> + +Defined in: library/dist/runtime/Balances.d.ts:87 + +#### Parameters + +##### tokenId + +[`TokenId`](../../library/classes/TokenId.md) + +##### from + +`PublicKey` + +##### to + +`PublicKey` + +##### amount + +[`Balance`](../../library/classes/Balance.md) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`transfer`](../../library/classes/Balances.md#transfer) + +*** + +### transferSigned() + +> **transferSigned**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> + +Defined in: library/dist/runtime/Balances.d.ts:90 + +#### Parameters + +##### tokenId + +[`TokenId`](../../library/classes/TokenId.md) + +##### from + +`PublicKey` + +##### to + +`PublicKey` + +##### amount + +[`Balance`](../../library/classes/Balance.md) + +#### Returns + +`Promise`\<`void`\> + +#### Inherited from + +[`Balances`](../../library/classes/Balances.md).[`transferSigned`](../../library/classes/Balances.md#transfersigned) diff --git a/src/pages/docs/reference/stack/functions/startServer.md b/src/pages/docs/reference/stack/functions/startServer.md new file mode 100644 index 0000000..0c5e654 --- /dev/null +++ b/src/pages/docs/reference/stack/functions/startServer.md @@ -0,0 +1,19 @@ +--- +title: startServer +--- + +[**@proto-kit/stack**](../README.md) + +*** + +[Documentation](../../../README.md) / [@proto-kit/stack](../README.md) / startServer + +# Function: startServer() + +> **startServer**(): `Promise`\<[`AppChain`](../../sdk/classes/AppChain.md)\<`object` & `object`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `Graphql`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md)\<\{ `BatchStorageResolver`: *typeof* [`BatchStorageResolver`](../../api/classes/BatchStorageResolver.md); `BlockResolver`: *typeof* [`BlockResolver`](../../api/classes/BlockResolver.md); `MempoolResolver`: *typeof* [`MempoolResolver`](../../api/classes/MempoolResolver.md); `MerkleWitnessResolver`: *typeof* [`MerkleWitnessResolver`](../../api/classes/MerkleWitnessResolver.md); `NodeStatusResolver`: *typeof* [`NodeStatusResolver`](../../api/classes/NodeStatusResolver.md); `QueryGraphqlModule`: *typeof* [`QueryGraphqlModule`](../../api/classes/QueryGraphqlModule.md); \}\>\>; `GraphqlServer`: *typeof* [`GraphqlServer`](../../api/classes/GraphqlServer.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](../../sdk/classes/BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](../../sdk/classes/StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](../../sdk/classes/InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](../../sdk/classes/InMemoryTransactionSender.md); \}\>\> + +Defined in: [stack/src/scripts/graphql/server.ts:87](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/stack/src/scripts/graphql/server.ts#L87) + +## Returns + +`Promise`\<[`AppChain`](../../sdk/classes/AppChain.md)\<`object` & `object`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `Graphql`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md)\<\{ `BatchStorageResolver`: *typeof* [`BatchStorageResolver`](../../api/classes/BatchStorageResolver.md); `BlockResolver`: *typeof* [`BlockResolver`](../../api/classes/BlockResolver.md); `MempoolResolver`: *typeof* [`MempoolResolver`](../../api/classes/MempoolResolver.md); `MerkleWitnessResolver`: *typeof* [`MerkleWitnessResolver`](../../api/classes/MerkleWitnessResolver.md); `NodeStatusResolver`: *typeof* [`NodeStatusResolver`](../../api/classes/NodeStatusResolver.md); `QueryGraphqlModule`: *typeof* [`QueryGraphqlModule`](../../api/classes/QueryGraphqlModule.md); \}\>\>; `GraphqlServer`: *typeof* [`GraphqlServer`](../../api/classes/GraphqlServer.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](../../sdk/classes/BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](../../sdk/classes/StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](../../sdk/classes/InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](../../sdk/classes/InMemoryTransactionSender.md); \}\>\> diff --git a/src/pages/docs/reference/stack/globals.md b/src/pages/docs/reference/stack/globals.md new file mode 100644 index 0000000..d85433c --- /dev/null +++ b/src/pages/docs/reference/stack/globals.md @@ -0,0 +1,19 @@ +--- +title: "@proto-kit/stack" +--- + +[**@proto-kit/stack**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/stack + +# @proto-kit/stack + +## Classes + +- [TestBalances](classes/TestBalances.md) + +## Functions + +- [startServer](functions/startServer.md) diff --git a/src/pages/docs/runtime/_meta.json b/src/pages/docs/runtime/_meta.json deleted file mode 100644 index ffe1e0f..0000000 --- a/src/pages/docs/runtime/_meta.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "state": "State", - "methods": "Methods", - "network-transaction": "Network & Transaction APIs", - "composability": "Composability", - "testing": "Testing" -} diff --git a/src/pages/docs/runtime/_meta.tsx b/src/pages/docs/runtime/_meta.tsx new file mode 100644 index 0000000..e7753b0 --- /dev/null +++ b/src/pages/docs/runtime/_meta.tsx @@ -0,0 +1,7 @@ +export default { + state: "State", + methods: "Methods", + "network-transaction": "Network & Transaction APIs", + composability: "Composability", + testing: "Testing", +}; diff --git a/theme.config.tsx b/theme.config.tsx index 75400c5..8294b37 100644 --- a/theme.config.tsx +++ b/theme.config.tsx @@ -32,39 +32,42 @@ const config: DocsThemeConfig = { }, sidebar: { toggleButton: true, + titleComponent({ title }) {}, }, head: null, - useNextSeoProps() { - return { - titleTemplate: "%s – Protokit", - canonical: "https://protokit.dev", - title: - "Protocol development framework for privacy enabled application chains", - description: - "Protokit enables developers to build zero-knowledge, interoperable and privacy preserving application chains with a minimal learning curve.", - openGraph: { - type: "website", - title: "Protokit", - description: - "Protokit enables developers to build zero-knowledge, interoperable and privacy preserving application chains with a minimal learning curve.", - images: [ - { - url: "https://protokit.dev/og.png", - width: 1200, - height: 630, - alt: "Protokit OG Image", - }, - ], - }, - additionalLinkTags: [ - { - rel: "shortcul icon", - href: "/logo-symbol.svg", - }, - ], - }; + // useNextSeoProps() { + // return { + // titleTemplate: "%s – Protokit", + // canonical: "https://protokit.dev", + // title: + // "Protocol development framework for privacy enabled application chains", + // description: + // "Protokit enables developers to build zero-knowledge, interoperable and privacy preserving application chains with a minimal learning curve.", + // openGraph: { + // type: "website", + // title: "Protokit", + // description: + // "Protokit enables developers to build zero-knowledge, interoperable and privacy preserving application chains with a minimal learning curve.", + // images: [ + // { + // url: "https://protokit.dev/og.png", + // width: 1200, + // height: 630, + // alt: "Protokit OG Image", + // }, + // ], + // }, + // additionalLinkTags: [ + // { + // rel: "shortcul icon", + // href: "/logo-symbol.svg", + // }, + // ], + // }; + // }, + color: { + hue: { light: 28, dark: 28 }, }, - primaryHue: { light: 28, dark: 28 }, }; export default { diff --git a/tsconfig.json b/tsconfig.json index 972099d..94c0a5d 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -2,16 +2,10 @@ "compilerOptions": { "baseUrl": "./src", "paths": { - "@/*": [ - "./*" - ] + "@/*": ["./*"] }, "target": "es5", - "lib": [ - "dom", - "dom.iterable", - "esnext" - ], + "lib": ["dom", "dom.iterable", "esnext"], "allowJs": true, "skipLibCheck": true, "strict": false, @@ -25,11 +19,6 @@ "isolatedModules": true, "jsx": "preserve" }, - "include": [ - "next-env.d.ts", - "src/**/*.ts" - ], - "exclude": [ - "node_modules" - ] + "include": ["next-env.d.ts", "src/**/*.ts", "src/pages/**/*.tsx"], + "exclude": ["node_modules"] } From 7e1347e6e26dc0726a773246a62619711f33d35f Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Mon, 3 Feb 2025 15:59:23 +0100 Subject: [PATCH 13/37] add reference docs --- .gitignore | 1 + README.md | 2 +- generate-reference-meta.mjs | 36 +++-- generate-typedoc.sh | 16 +++ package.json | 3 +- src/pages/docs/_meta.tsx | 3 - src/pages/docs/common/_meta.tsx | 3 - .../docs/common/modularity-configuration.mdx | 17 --- src/pages/docs/provable-events.mdx | 27 ---- src/pages/docs/reference/_meta.tsx | 15 +- src/pages/docs/reference/api/_meta.tsx | 2 +- .../api/classes/AdvancedNodeStatusResolver.md | 6 +- .../api/classes/BatchStorageResolver.md | 6 +- .../docs/reference/api/classes/BlockModel.md | 14 +- .../reference/api/classes/BlockResolver.md | 6 +- .../api/classes/ComputedBlockModel.md | 10 +- .../reference/api/classes/GraphqlModule.md | 4 +- .../api/classes/GraphqlSequencerModule.md | 10 +- .../reference/api/classes/GraphqlServer.md | 18 +-- .../reference/api/classes/MempoolResolver.md | 10 +- .../reference/api/classes/MerkleWitnessDTO.md | 10 +- .../api/classes/MerkleWitnessResolver.md | 6 +- .../api/classes/NodeInformationObject.md | 10 +- .../reference/api/classes/NodeStatusObject.md | 10 +- .../api/classes/NodeStatusResolver.md | 6 +- .../api/classes/NodeStatusService.md | 8 +- .../api/classes/ProcessInformationObject.md | 20 +-- .../api/classes/QueryGraphqlModule.md | 14 +- .../classes/ResolverFactoryGraphqlModule.md | 6 +- .../classes/SchemaGeneratingGraphqlModule.md | 6 +- .../docs/reference/api/classes/Signature.md | 8 +- .../api/classes/TransactionObject.md | 22 +-- .../api/classes/VanillaGraphqlModules.md | 6 +- .../reference/api/functions/graphqlModule.md | 2 +- src/pages/docs/reference/api/globals.md | 51 +++++++ .../api/interfaces/GraphqlModulesDefintion.md | 6 +- .../api/interfaces/NodeInformation.md | 6 +- .../api/interfaces/ProcessInformation.md | 16 +-- .../api/type-aliases/GraphqlModulesRecord.md | 2 +- .../VanillaGraphqlModulesRecord.md | 2 +- src/pages/docs/reference/common/_meta.tsx | 2 +- .../common/classes/AtomicCompileHelper.md | 6 +- .../classes/ChildVerificationKeyService.md | 6 +- .../common/classes/CompileRegistry.md | 14 +- .../common/classes/ConfigurableModule.md | 10 +- .../reference/common/classes/EventEmitter.md | 14 +- .../common/classes/EventEmitterProxy.md | 16 +-- .../classes/InMemoryMerkleTreeStorage.md | 8 +- .../classes/MockAsyncMerkleTreeStore.md | 12 +- .../common/classes/ModuleContainer.md | 50 +++---- .../classes/ProvableMethodExecutionContext.md | 22 +-- .../classes/ProvableMethodExecutionResult.md | 12 +- .../classes/ReplayingSingleUseEventEmitter.md | 16 +-- .../common/classes/RollupMerkleTree.md | 28 ++-- .../common/classes/RollupMerkleTreeWitness.md | 20 +-- .../common/classes/ZkProgrammable.md | 10 +- .../functions/assertValidTextLogLevel.md | 2 +- .../common/functions/compileToMockable.md | 2 +- .../common/functions/createMerkleTree.md | 2 +- .../reference/common/functions/dummyValue.md | 2 +- .../common/functions/expectDefined.md | 2 +- .../common/functions/filterNonNull.md | 2 +- .../common/functions/filterNonUndefined.md | 2 +- .../common/functions/getInjectAliases.md | 2 +- .../common/functions/hashWithPrefix.md | 2 +- .../reference/common/functions/implement.md | 2 +- .../reference/common/functions/injectAlias.md | 2 +- .../common/functions/injectOptional.md | 2 +- .../common/functions/isSubtypeOfName.md | 2 +- .../common/functions/mapSequential.md | 2 +- .../docs/reference/common/functions/noop.md | 2 +- .../common/functions/prefixToField.md | 2 +- .../common/functions/provableMethod.md | 2 +- .../docs/reference/common/functions/range.md | 2 +- .../common/functions/reduceSequential.md | 2 +- .../reference/common/functions/requireTrue.md | 2 +- .../common/functions/safeParseJson.md | 2 +- .../docs/reference/common/functions/sleep.md | 2 +- .../reference/common/functions/splitArray.md | 2 +- .../reference/common/functions/toProver.md | 2 +- .../common/functions/verifyToMockable.md | 2 +- src/pages/docs/reference/common/globals.md | 136 ++++++++++++++++++ .../common/interfaces/AbstractMerkleTree.md | 18 +-- .../interfaces/AbstractMerkleTreeClass.md | 12 +- .../interfaces/AbstractMerkleWitness.md | 18 +-- .../common/interfaces/AreProofsEnabled.md | 6 +- .../interfaces/BaseModuleInstanceType.md | 6 +- .../interfaces/ChildContainerCreatable.md | 4 +- .../interfaces/ChildContainerProvider.md | 4 +- .../common/interfaces/CompilableModule.md | 4 +- .../reference/common/interfaces/Compile.md | 4 +- .../common/interfaces/CompileArtifact.md | 4 +- .../common/interfaces/Configurable.md | 4 +- .../common/interfaces/DependencyFactory.md | 4 +- .../interfaces/EventEmittingComponent.md | 4 +- .../interfaces/EventEmittingContainer.md | 4 +- .../common/interfaces/MerkleTreeStore.md | 6 +- .../interfaces/ModuleContainerDefinition.md | 6 +- .../common/interfaces/ModulesRecord.md | 2 +- .../common/interfaces/PlainZkProgram.md | 14 +- .../interfaces/StaticConfigurableModule.md | 4 +- .../common/interfaces/ToFieldable.md | 4 +- .../common/interfaces/ToFieldableStatic.md | 4 +- .../common/interfaces/ToJSONableStatic.md | 4 +- .../reference/common/interfaces/Verify.md | 4 +- .../common/interfaces/WithZkProgrammable.md | 4 +- .../common/type-aliases/ArgumentTypes.md | 2 +- .../common/type-aliases/ArrayElement.md | 2 +- .../common/type-aliases/ArtifactRecord.md | 2 +- .../common/type-aliases/BaseModuleType.md | 2 +- .../common/type-aliases/CapitalizeAny.md | 2 +- .../common/type-aliases/CastToEventsRecord.md | 2 +- .../common/type-aliases/CompileTarget.md | 2 +- .../common/type-aliases/ContainerEvents.md | 2 +- .../common/type-aliases/DecoratedMethod.md | 2 +- .../type-aliases/DependenciesFromModules.md | 2 +- .../type-aliases/DependencyDeclaration.md | 2 +- .../common/type-aliases/DependencyRecord.md | 2 +- .../common/type-aliases/EventListenable.md | 2 +- .../common/type-aliases/EventsRecord.md | 2 +- .../common/type-aliases/FilterNeverValues.md | 2 +- .../common/type-aliases/FlattenObject.md | 2 +- .../type-aliases/FlattenedContainerEvents.md | 2 +- .../common/type-aliases/InferDependencies.md | 2 +- .../common/type-aliases/InferProofBase.md | 2 +- .../MapDependencyRecordToTypes.md | 2 +- .../common/type-aliases/MergeObjects.md | 2 +- .../common/type-aliases/ModuleEvents.md | 2 +- .../common/type-aliases/ModulesConfig.md | 2 +- .../reference/common/type-aliases/NoConfig.md | 2 +- .../common/type-aliases/NonMethods.md | 2 +- .../common/type-aliases/O1JSPrimitive.md | 2 +- .../reference/common/type-aliases/OmitKeys.md | 2 +- .../type-aliases/OverwriteObjectType.md | 2 +- .../reference/common/type-aliases/Preset.md | 2 +- .../reference/common/type-aliases/Presets.md | 2 +- .../common/type-aliases/ProofTypes.md | 2 +- .../common/type-aliases/RecursivePartial.md | 2 +- .../common/type-aliases/ResolvableModules.md | 2 +- .../common/type-aliases/StringKeyOf.md | 2 +- .../TypeFromDependencyDeclaration.md | 2 +- .../common/type-aliases/TypedClass.md | 2 +- .../common/type-aliases/UnTypedClass.md | 2 +- .../type-aliases/UnionToIntersection.md | 2 +- .../common/variables/EMPTY_PUBLICKEY.md | 2 +- .../common/variables/EMPTY_PUBLICKEY_X.md | 2 +- .../reference/common/variables/MAX_FIELD.md | 2 +- .../reference/common/variables/MOCK_PROOF.md | 2 +- .../common/variables/MOCK_VERIFICATION_KEY.md | 2 +- .../common/variables/ModuleContainerErrors.md | 2 +- .../variables/injectAliasMetadataKey.md | 2 +- .../docs/reference/common/variables/log.md | 2 +- .../reference/deployment/classes/BullQueue.md | 10 +- .../deployment/classes/Environment.md | 12 +- .../deployment/interfaces/BullQueueConfig.md | 6 +- .../deployment/interfaces/Startable.md | 4 +- .../type-aliases/StartableEnvironment.md | 2 +- src/pages/docs/reference/indexer/_meta.tsx | 2 +- .../GeneratedResolverFactoryGraphqlModule.md | 10 +- .../indexer/classes/IndexBlockTask.md | 18 +-- .../IndexBlockTaskParametersSerializer.md | 14 +- .../docs/reference/indexer/classes/Indexer.md | 8 +- .../indexer/classes/IndexerModule.md | 4 +- .../indexer/classes/IndexerNotifier.md | 14 +- .../indexer/functions/ValidateTakeArg.md | 2 +- .../indexer/functions/cleanResolvers.md | 2 +- src/pages/docs/reference/indexer/globals.md | 34 +++++ .../interfaces/IndexBlockTaskParameters.md | 2 +- .../type-aliases/IndexerModulesRecord.md | 2 +- .../NotifierMandatorySequencerModules.md | 2 +- src/pages/docs/reference/library/_meta.tsx | 2 +- .../docs/reference/library/classes/Balance.md | 72 +++++----- .../reference/library/classes/Balances.md | 16 +-- .../reference/library/classes/BalancesKey.md | 8 +- .../docs/reference/library/classes/FeeTree.md | 2 +- .../classes/InMemorySequencerModules.md | 4 +- .../library/classes/MethodFeeConfigData.md | 12 +- .../classes/RuntimeFeeAnalyzerService.md | 18 +-- .../library/classes/SimpleSequencerModules.md | 10 +- .../docs/reference/library/classes/TokenId.md | 2 +- .../library/classes/TransactionFeeHook.md | 26 ++-- .../docs/reference/library/classes/UInt.md | 60 ++++---- .../docs/reference/library/classes/UInt112.md | 74 +++++----- .../docs/reference/library/classes/UInt224.md | 72 +++++----- .../docs/reference/library/classes/UInt32.md | 74 +++++----- .../docs/reference/library/classes/UInt64.md | 72 +++++----- .../library/classes/VanillaProtocolModules.md | 10 +- .../library/classes/VanillaRuntimeModules.md | 6 +- .../library/classes/WithdrawalEvent.md | 6 +- .../library/classes/WithdrawalKey.md | 6 +- .../reference/library/classes/Withdrawals.md | 14 +- src/pages/docs/reference/library/globals.md | 60 ++++++++ .../library/interfaces/BalancesEvents.md | 4 +- .../library/interfaces/FeeIndexes.md | 2 +- .../library/interfaces/FeeTreeValues.md | 2 +- .../library/interfaces/MethodFeeConfig.md | 10 +- .../RuntimeFeeAnalyzerServiceConfig.md | 12 +- .../interfaces/TransactionFeeHookConfig.md | 12 +- .../AdditionalSequencerModules.md | 2 +- .../InMemorySequencerModulesRecord.md | 2 +- .../library/type-aliases/MinimalBalances.md | 2 +- .../MinimumAdditionalSequencerModules.md | 2 +- .../SimpleSequencerModulesRecord.md | 2 +- .../SimpleSequencerWorkerModulesRecord.md | 2 +- .../library/type-aliases/UIntConstructor.md | 2 +- .../VanillaProtocolModulesRecord.md | 2 +- .../VanillaRuntimeModulesRecord.md | 2 +- .../reference/library/variables/errors.md | 2 +- .../library/variables/treeFeeHeight.md | 2 +- .../module/classes/InMemoryStateService.md | 8 +- .../module/classes/MethodIdFactory.md | 4 +- .../module/classes/MethodIdResolver.md | 10 +- .../module/classes/MethodParameterEncoder.md | 14 +- .../docs/reference/module/classes/Runtime.md | 32 ++--- .../reference/module/classes/RuntimeEvents.md | 8 +- .../reference/module/classes/RuntimeModule.md | 22 +-- .../module/classes/RuntimeZkProgrammable.md | 10 +- .../module/functions/combineMethodName.md | 2 +- .../module/functions/getAllPropertyNames.md | 2 +- .../module/functions/isRuntimeMethod.md | 2 +- .../module/functions/runtimeMessage.md | 2 +- .../module/functions/runtimeMethod.md | 2 +- .../module/functions/runtimeModule.md | 2 +- .../docs/reference/module/functions/state.md | 2 +- .../module/functions/toEventsHash.md | 2 +- .../functions/toStateTransitionsHash.md | 2 +- .../module/functions/toWrappedMethod.md | 2 +- .../module/interfaces/RuntimeDefinition.md | 6 +- .../module/interfaces/RuntimeEnvironment.md | 10 +- .../module/type-aliases/AsyncWrappedMethod.md | 2 +- .../RuntimeMethodInvocationType.md | 2 +- .../type-aliases/RuntimeModulesRecord.md | 2 +- .../module/type-aliases/WrappedMethod.md | 2 +- .../variables/runtimeMethodMetadataKey.md | 2 +- .../runtimeMethodNamesMetadataKey.md | 2 +- .../variables/runtimeMethodTypeMetadataKey.md | 2 +- .../docs/reference/persistance/_meta.tsx | 2 +- .../persistance/classes/BatchMapper.md | 6 +- .../persistance/classes/BlockMapper.md | 6 +- .../persistance/classes/BlockResultMapper.md | 8 +- .../persistance/classes/FieldMapper.md | 6 +- .../persistance/classes/PrismaBatchStore.md | 12 +- .../persistance/classes/PrismaBlockStorage.md | 20 +-- .../classes/PrismaDatabaseConnection.md | 14 +- .../classes/PrismaMessageStorage.md | 8 +- .../classes/PrismaRedisDatabase.md | 26 ++-- .../classes/PrismaSettlementStorage.md | 6 +- .../persistance/classes/PrismaStateService.md | 14 +- .../classes/PrismaTransactionStorage.md | 10 +- .../classes/RedisConnectionModule.md | 20 +-- .../classes/RedisMerkleTreeStore.md | 12 +- .../persistance/classes/SettlementMapper.md | 6 +- .../classes/StateTransitionArrayMapper.md | 8 +- .../classes/StateTransitionMapper.md | 6 +- .../TransactionExecutionResultMapper.md | 8 +- .../persistance/classes/TransactionMapper.md | 6 +- .../docs/reference/persistance/globals.md | 45 ++++++ .../interfaces/PrismaConnection.md | 4 +- .../interfaces/PrismaDatabaseConfig.md | 4 +- .../interfaces/PrismaRedisCombinedConfig.md | 6 +- .../persistance/interfaces/RedisConnection.md | 6 +- .../interfaces/RedisConnectionConfig.md | 10 +- .../type-aliases/RedisTransaction.md | 2 +- src/pages/docs/reference/processor/_meta.tsx | 2 +- .../processor/classes/BlockFetching.md | 14 +- .../reference/processor/classes/Database.md | 14 +- .../processor/classes/DatabasePruneModule.md | 6 +- .../processor/classes/HandlersExecutor.md | 20 +-- .../reference/processor/classes/Processor.md | 6 +- .../processor/classes/ProcessorModule.md | 4 +- .../classes/ResolverFactoryGraphqlModule.md | 14 +- .../classes/TimedProcessorTrigger.md | 18 +-- .../processor/functions/ValidateTakeArg.md | 2 +- .../processor/functions/cleanResolvers.md | 2 +- src/pages/docs/reference/processor/globals.md | 42 ++++++ .../interfaces/BlockFetchingConfig.md | 4 +- .../processor/interfaces/BlockResponse.md | 4 +- .../interfaces/DatabasePruneModuleConfig.md | 4 +- .../interfaces/HandlersExecutorConfig.md | 6 +- .../processor/interfaces/HandlersRecord.md | 4 +- .../interfaces/TimedProcessorTriggerConfig.md | 4 +- .../processor/type-aliases/BlockHandler.md | 2 +- .../type-aliases/ClientTransaction.md | 2 +- .../type-aliases/ProcessorModulesRecord.md | 2 +- .../protocol/classes/AccountState.md | 4 +- .../protocol/classes/AccountStateHook.md | 16 +-- .../protocol/classes/BlockHashMerkleTree.md | 2 +- .../classes/BlockHashMerkleTreeWitness.md | 2 +- .../protocol/classes/BlockHashTreeEntry.md | 8 +- .../protocol/classes/BlockHeightHook.md | 16 +-- .../reference/protocol/classes/BlockProver.md | 26 ++-- .../classes/BlockProverExecutionData.md | 8 +- .../classes/BlockProverProgrammable.md | 24 ++-- .../classes/BlockProverPublicInput.md | 16 +-- .../classes/BlockProverPublicOutput.md | 20 +-- .../protocol/classes/BridgeContract.md | 26 ++-- .../protocol/classes/BridgeContractBase.md | 20 +-- .../classes/BridgeContractProtocolModule.md | 6 +- .../protocol/classes/ContractModule.md | 6 +- .../protocol/classes/CurrentBlock.md | 4 +- .../classes/DefaultProvableHashList.md | 16 +-- .../reference/protocol/classes/Deposit.md | 8 +- .../classes/DispatchContractProtocolModule.md | 10 +- .../protocol/classes/DispatchSmartContract.md | 32 ++--- .../classes/DispatchSmartContractBase.md | 24 ++-- .../protocol/classes/DynamicBlockProof.md | 8 +- .../protocol/classes/DynamicRuntimeProof.md | 8 +- .../classes/LastStateRootBlockHook.md | 16 +-- .../protocol/classes/MethodPublicOutput.md | 14 +- .../protocol/classes/MethodVKConfigData.md | 8 +- .../reference/protocol/classes/MinaActions.md | 4 +- .../protocol/classes/MinaActionsHashList.md | 18 +-- .../reference/protocol/classes/MinaEvents.md | 4 +- .../classes/MinaPrefixedProvableHashList.md | 18 +-- .../protocol/classes/NetworkState.md | 10 +- .../classes/NetworkStateSettlementModule.md | 12 +- .../docs/reference/protocol/classes/Option.md | 36 ++--- .../reference/protocol/classes/OptionBase.md | 22 +-- .../classes/OutgoingMessageArgument.md | 8 +- .../classes/OutgoingMessageArgumentBatch.md | 8 +- .../protocol/classes/OutgoingMessageKey.md | 6 +- .../docs/reference/protocol/classes/Path.md | 8 +- .../classes/PrefixedProvableHashList.md | 16 +-- .../protocol/classes/PreviousBlock.md | 4 +- .../reference/protocol/classes/Protocol.md | 26 ++-- .../protocol/classes/ProtocolModule.md | 10 +- .../protocol/classes/ProvableBlockHook.md | 16 +-- .../protocol/classes/ProvableHashList.md | 16 +-- .../protocol/classes/ProvableOption.md | 8 +- .../classes/ProvableReductionHashList.md | 20 +-- .../classes/ProvableSettlementHook.md | 12 +- .../classes/ProvableStateTransition.md | 10 +- .../classes/ProvableStateTransitionType.md | 12 +- .../classes/ProvableTransactionHook.md | 14 +- .../protocol/classes/PublicKeyOption.md | 10 +- .../classes/RuntimeMethodExecutionContext.md | 28 ++-- .../RuntimeMethodExecutionDataStruct.md | 6 +- .../RuntimeProvableMethodExecutionResult.md | 12 +- .../protocol/classes/RuntimeTransaction.md | 24 ++-- .../RuntimeVerificationKeyAttestation.md | 6 +- .../RuntimeVerificationKeyRootService.md | 6 +- .../classes/SettlementContractModule.md | 26 ++-- .../SettlementContractProtocolModule.md | 8 +- .../classes/SettlementSmartContract.md | 36 ++--- .../classes/SettlementSmartContractBase.md | 28 ++-- .../protocol/classes/SignedTransaction.md | 16 +-- .../docs/reference/protocol/classes/State.md | 20 +-- .../reference/protocol/classes/StateMap.md | 24 ++-- .../protocol/classes/StateServiceProvider.md | 8 +- .../protocol/classes/StateTransition.md | 24 ++-- .../classes/StateTransitionProvableBatch.md | 12 +- .../protocol/classes/StateTransitionProver.md | 20 +-- .../StateTransitionProverProgrammable.md | 16 +-- .../StateTransitionProverPublicInput.md | 10 +- .../StateTransitionProverPublicOutput.md | 10 +- .../classes/StateTransitionReductionList.md | 22 +-- .../protocol/classes/StateTransitionType.md | 10 +- .../classes/TokenBridgeAttestation.md | 6 +- .../classes/TokenBridgeDeploymentAuth.md | 10 +- .../protocol/classes/TokenBridgeEntry.md | 8 +- .../protocol/classes/TokenBridgeTree.md | 8 +- .../classes/TokenBridgeTreeAddition.md | 6 +- .../classes/TokenBridgeTreeWitness.md | 2 +- .../protocol/classes/TokenMapping.md | 6 +- .../TransitionMethodExecutionResult.md | 4 +- .../protocol/classes/UInt64Option.md | 10 +- .../classes/UpdateMessagesHashAuth.md | 10 +- .../docs/reference/protocol/classes/VKTree.md | 2 +- .../protocol/classes/VKTreeWitness.md | 2 +- .../reference/protocol/classes/WithPath.md | 6 +- .../classes/WithStateServiceProvider.md | 6 +- .../reference/protocol/classes/Withdrawal.md | 10 +- .../reference/protocol/functions/assert.md | 2 +- .../protocol/functions/emptyActions.md | 2 +- .../protocol/functions/emptyEvents.md | 2 +- .../protocol/functions/notInCircuit.md | 2 +- .../protocol/functions/protocolState.md | 2 +- .../functions/reduceStateTransitions.md | 2 +- .../protocol/functions/singleFieldToString.md | 2 +- .../protocol/functions/stringToField.md | 2 +- .../protocol/interfaces/BlockProvable.md | 8 +- .../protocol/interfaces/BlockProverState.md | 14 +- .../protocol/interfaces/BlockProverType.md | 16 +-- .../interfaces/ContractAuthorization.md | 6 +- .../interfaces/DispatchContractType.md | 10 +- .../interfaces/MinimalVKTreeService.md | 4 +- .../protocol/interfaces/ProtocolDefinition.md | 6 +- .../interfaces/ProtocolEnvironment.md | 8 +- .../protocol/interfaces/RuntimeLike.md | 4 +- .../interfaces/RuntimeMethodExecutionData.md | 6 +- .../interfaces/SettlementContractType.md | 12 +- .../interfaces/SimpleAsyncStateService.md | 6 +- .../interfaces/StateTransitionProvable.md | 6 +- .../interfaces/StateTransitionProverType.md | 14 +- .../TransitionMethodExecutionContext.md | 8 +- .../protocol/type-aliases/BlockProof.md | 2 +- .../protocol/type-aliases/BlockProverProof.md | 2 +- .../type-aliases/BridgeContractConfig.md | 2 +- .../type-aliases/BridgeContractType.md | 2 +- .../type-aliases/DispatchContractConfig.md | 2 +- .../protocol/type-aliases/InputBlockProof.md | 2 +- .../MandatoryProtocolModulesRecord.md | 2 +- .../MandatorySettlementModulesRecord.md | 2 +- .../type-aliases/ProtocolModulesRecord.md | 2 +- .../protocol/type-aliases/ReturnType.md | 2 +- .../type-aliases/RuntimeMethodIdMapping.md | 2 +- .../RuntimeMethodInvocationType.md | 2 +- .../protocol/type-aliases/RuntimeProof.md | 2 +- .../type-aliases/SettlementContractConfig.md | 2 +- .../type-aliases/SettlementHookInputs.md | 2 +- .../type-aliases/SettlementModulesRecord.md | 2 +- .../type-aliases/SettlementStateRecord.md | 2 +- .../SmartContractClassFromInterface.md | 2 +- .../type-aliases/StateTransitionProof.md | 2 +- .../protocol/type-aliases/Subclass.md | 2 +- .../protocol/variables/ACTIONS_EMPTY_HASH.md | 2 +- .../variables/BATCH_SIGNATURE_PREFIX.md | 2 +- .../protocol/variables/MINA_EVENT_PREFIXES.md | 2 +- .../variables/OUTGOING_MESSAGE_BATCH_SIZE.md | 2 +- .../protocol/variables/ProtocolConstants.md | 2 +- .../protocol/variables/treeFeeHeight.md | 2 +- .../docs/reference/sdk/classes/AppChain.md | 22 +-- .../reference/sdk/classes/AppChainModule.md | 6 +- .../sdk/classes/AppChainTransaction.md | 20 +-- .../sdk/classes/AreProofsEnabledFactory.md | 4 +- .../docs/reference/sdk/classes/AuroSigner.md | 8 +- .../classes/BlockStorageNetworkStateModule.md | 14 +- .../reference/sdk/classes/ClientAppChain.md | 24 ++-- .../reference/sdk/classes/GraphqlClient.md | 8 +- .../GraphqlNetworkStateTransportModule.md | 14 +- .../classes/GraphqlQueryTransportModule.md | 12 +- .../sdk/classes/GraphqlTransactionSender.md | 10 +- .../sdk/classes/InMemoryAreProofsEnabled.md | 6 +- .../reference/sdk/classes/InMemorySigner.md | 10 +- .../sdk/classes/InMemoryTransactionSender.md | 14 +- .../sdk/classes/SharedDependencyFactory.md | 4 +- .../sdk/classes/StateServiceQueryModule.md | 18 +-- .../reference/sdk/classes/TestingAppChain.md | 30 ++-- .../sdk/interfaces/AppChainConfig.md | 10 +- .../sdk/interfaces/AppChainDefinition.md | 10 +- .../interfaces/ExpandAppChainDefinition.md | 4 +- .../sdk/interfaces/GraphqlClientConfig.md | 4 +- .../sdk/interfaces/InMemorySignerConfig.md | 4 +- .../sdk/interfaces/SharedDependencyRecord.md | 6 +- .../docs/reference/sdk/interfaces/Signer.md | 4 +- .../sdk/interfaces/TransactionSender.md | 6 +- .../sdk/type-aliases/AppChainModulesRecord.md | 2 +- .../sdk/type-aliases/ExpandAppChainModules.md | 2 +- .../PartialVanillaRuntimeModulesRecord.md | 2 +- .../TestingSequencerModulesRecord.md | 2 +- .../sdk/variables/randomFeeRecipient.md | 2 +- .../sequencer/classes/AbstractTaskQueue.md | 12 +- .../classes/ArtifactRecordSerializer.md | 6 +- .../sequencer/classes/BatchProducerModule.md | 10 +- .../sequencer/classes/BlockProducerModule.md | 14 +- .../sequencer/classes/BlockProofSerializer.md | 6 +- .../sequencer/classes/BlockTaskFlowService.md | 10 +- .../sequencer/classes/BlockTriggerBase.md | 30 ++-- .../classes/CachedMerkleTreeStore.md | 28 ++-- .../sequencer/classes/CachedStateService.md | 22 +-- .../sequencer/classes/CompressedSignature.md | 12 +- .../sequencer/classes/DatabasePruneModule.md | 8 +- .../classes/DecodedStateSerializer.md | 6 +- .../sequencer/classes/DummyStateService.md | 6 +- .../classes/DynamicProofTaskSerializer.md | 14 +- .../docs/reference/sequencer/classes/Flow.md | 22 +-- .../sequencer/classes/FlowCreator.md | 6 +- .../sequencer/classes/FlowTaskWorker.md | 16 +-- .../classes/InMemoryAsyncMerkleTreeStore.md | 10 +- .../sequencer/classes/InMemoryBatchStorage.md | 10 +- .../sequencer/classes/InMemoryBlockStorage.md | 22 +-- .../sequencer/classes/InMemoryDatabase.md | 14 +- .../classes/InMemoryMessageStorage.md | 6 +- .../classes/InMemorySettlementStorage.md | 6 +- .../classes/InMemoryTransactionStorage.md | 10 +- .../sequencer/classes/ListenerList.md | 10 +- .../sequencer/classes/LocalTaskQueue.md | 22 +-- .../classes/LocalTaskWorkerModule.md | 14 +- .../sequencer/classes/ManualBlockTrigger.md | 32 ++--- .../sequencer/classes/MinaBaseLayer.md | 16 +-- .../classes/MinaIncomingMessageAdapter.md | 6 +- .../classes/MinaSimulationService.md | 10 +- .../classes/MinaTransactionSender.md | 6 +- .../classes/MinaTransactionSimulator.md | 20 +-- .../sequencer/classes/NetworkStateQuery.md | 10 +- .../NewBlockProvingParametersSerializer.md | 8 +- .../sequencer/classes/NewBlockTask.md | 14 +- .../sequencer/classes/NoopBaseLayer.md | 10 +- .../classes/PairProofTaskSerializer.md | 8 +- .../sequencer/classes/PendingTransaction.md | 36 ++--- .../classes/PreFilledStateService.md | 4 +- .../sequencer/classes/PrivateMempool.md | 16 +-- .../sequencer/classes/ProofTaskSerializer.md | 14 +- .../classes/ProvenSettlementPermissions.md | 10 +- .../sequencer/classes/ReductionTaskFlow.md | 12 +- .../RuntimeProofParametersSerializer.md | 6 +- .../sequencer/classes/RuntimeProvingTask.md | 18 +-- ...imeVerificationKeyAttestationSerializer.md | 6 +- .../reference/sequencer/classes/Sequencer.md | 14 +- .../sequencer/classes/SequencerModule.md | 6 +- .../classes/SequencerStartupModule.md | 12 +- .../sequencer/classes/SettlementModule.md | 32 ++--- .../classes/SettlementProvingTask.md | 16 +-- .../classes/SignedSettlementPermissions.md | 10 +- .../sequencer/classes/SomeProofSubclass.md | 6 +- .../StateTransitionParametersSerializer.md | 6 +- .../classes/StateTransitionReductionTask.md | 16 +-- .../sequencer/classes/StateTransitionTask.md | 16 +-- .../classes/SyncCachedMerkleTreeStore.md | 10 +- .../sequencer/classes/TaskWorkerModule.md | 2 +- .../sequencer/classes/TimedBlockTrigger.md | 32 ++--- .../classes/TransactionExecutionService.md | 6 +- .../classes/TransactionProvingTask.md | 14 +- ...ansactionProvingTaskParameterSerializer.md | 8 +- .../classes/TransactionTraceService.md | 6 +- .../sequencer/classes/UnsignedTransaction.md | 28 ++-- .../sequencer/classes/UntypedOption.md | 14 +- .../classes/UntypedStateTransition.md | 22 +-- .../classes/VanillaTaskWorkerModules.md | 8 +- .../classes/VerificationKeySerializer.md | 6 +- .../sequencer/classes/WithdrawalEvent.md | 6 +- .../sequencer/classes/WithdrawalKey.md | 6 +- .../sequencer/classes/WithdrawalQueue.md | 14 +- .../sequencer/classes/WorkerReadyModule.md | 6 +- .../sequencer/functions/closeable.md | 2 +- .../reference/sequencer/functions/distinct.md | 2 +- .../functions/distinctByPredicate.md | 2 +- .../sequencer/functions/distinctByString.md | 2 +- .../functions/executeWithExecutionContext.md | 2 +- .../sequencer/functions/sequencerModule.md | 2 +- .../interfaces/AsyncMerkleTreeStore.md | 10 +- .../sequencer/interfaces/AsyncStateService.md | 12 +- .../sequencer/interfaces/BaseLayer.md | 4 +- .../BaseLayerContractPermissions.md | 10 +- .../interfaces/BaseLayerDependencyRecord.md | 6 +- .../reference/sequencer/interfaces/Batch.md | 8 +- .../sequencer/interfaces/BatchStorage.md | 8 +- .../sequencer/interfaces/BatchTransaction.md | 8 +- .../reference/sequencer/interfaces/Block.md | 24 ++-- .../sequencer/interfaces/BlockConfig.md | 6 +- .../interfaces/BlockProverParameters.md | 10 +- .../sequencer/interfaces/BlockQueue.md | 10 +- .../sequencer/interfaces/BlockResult.md | 14 +- .../sequencer/interfaces/BlockStorage.md | 8 +- .../sequencer/interfaces/BlockTrace.md | 8 +- .../sequencer/interfaces/BlockTrigger.md | 2 +- .../interfaces/BlockWithMaybeResult.md | 6 +- .../interfaces/BlockWithPreviousResult.md | 6 +- .../sequencer/interfaces/BlockWithResult.md | 6 +- .../sequencer/interfaces/Closeable.md | 4 +- .../sequencer/interfaces/Database.md | 10 +- .../interfaces/HistoricalBatchStorage.md | 4 +- .../interfaces/HistoricalBlockStorage.md | 6 +- .../interfaces/IncomingMessageAdapter.md | 4 +- .../sequencer/interfaces/InstantiatedQueue.md | 12 +- .../interfaces/LocalTaskQueueConfig.md | 4 +- .../reference/sequencer/interfaces/Mempool.md | 6 +- .../sequencer/interfaces/MerkleTreeNode.md | 8 +- .../interfaces/MerkleTreeNodeQuery.md | 6 +- .../sequencer/interfaces/MessageStorage.md | 6 +- .../interfaces/MinaBaseLayerConfig.md | 4 +- .../interfaces/NetworkStateTransportModule.md | 8 +- .../interfaces/NewBlockProverParameters.md | 10 +- .../sequencer/interfaces/OutgoingMessage.md | 6 +- .../interfaces/OutgoingMessageQueue.md | 8 +- .../interfaces/PairingDerivedInput.md | 8 +- .../sequencer/interfaces/QueryGetterState.md | 8 +- .../interfaces/QueryGetterStateMap.md | 8 +- .../interfaces/QueryTransportModule.md | 6 +- .../interfaces/RuntimeProofParameters.md | 8 +- .../sequencer/interfaces/Sequenceable.md | 4 +- .../sequencer/interfaces/SettleableBatch.md | 12 +- .../sequencer/interfaces/Settlement.md | 6 +- .../interfaces/SettlementModuleConfig.md | 6 +- .../sequencer/interfaces/SettlementStorage.md | 4 +- .../sequencer/interfaces/StateEntry.md | 6 +- .../StateTransitionProofParameters.md | 8 +- .../interfaces/StorageDependencyFactory.md | 4 +- .../StorageDependencyMinimumDependencies.md | 24 ++-- .../reference/sequencer/interfaces/Task.md | 12 +- .../sequencer/interfaces/TaskPayload.md | 12 +- .../sequencer/interfaces/TaskQueue.md | 6 +- .../sequencer/interfaces/TaskSerializer.md | 6 +- .../interfaces/TimedBlockTriggerConfig.md | 10 +- .../interfaces/TimedBlockTriggerEvent.md | 10 +- .../interfaces/TransactionExecutionResult.md | 14 +- .../interfaces/TransactionStorage.md | 8 +- .../sequencer/interfaces/TransactionTrace.md | 8 +- .../sequencer/interfaces/TxEvents.md | 8 +- .../type-aliases/AllTaskWorkerModules.md | 2 +- .../sequencer/type-aliases/BlockEvents.md | 2 +- .../type-aliases/ChainStateTaskArgs.md | 2 +- .../type-aliases/DatabasePruneConfig.md | 2 +- .../type-aliases/JSONEncodableState.md | 2 +- .../type-aliases/MapStateMapToQuery.md | 2 +- .../sequencer/type-aliases/MapStateToQuery.md | 2 +- .../sequencer/type-aliases/MempoolEvents.md | 2 +- .../sequencer/type-aliases/ModuleQuery.md | 2 +- .../type-aliases/NewBlockProvingParameters.md | 2 +- .../sequencer/type-aliases/PairTuple.md | 2 +- .../sequencer/type-aliases/PickByType.md | 2 +- .../type-aliases/PickStateMapProperties.md | 2 +- .../type-aliases/PickStateProperties.md | 2 +- .../reference/sequencer/type-aliases/Query.md | 2 +- .../RuntimeContextReducedExecutionResult.md | 2 +- .../type-aliases/SequencerModulesRecord.md | 2 +- .../type-aliases/SerializedArtifactRecord.md | 2 +- .../type-aliases/SettlementModuleEvents.md | 2 +- .../type-aliases/SomeRuntimeMethod.md | 2 +- .../sequencer/type-aliases/StateRecord.md | 2 +- .../sequencer/type-aliases/TaskStateRecord.md | 2 +- .../type-aliases/TaskWorkerModulesRecord.md | 2 +- .../TaskWorkerModulesWithoutSettlement.md | 2 +- .../TransactionProvingTaskParameters.md | 2 +- .../type-aliases/TransactionTaskArgs.md | 2 +- .../type-aliases/TransactionTaskResult.md | 2 +- .../type-aliases/UnsignedTransactionBody.md | 2 +- .../type-aliases/VerificationKeyJSON.md | 2 +- .../reference/sequencer/variables/Block.md | 2 +- .../sequencer/variables/BlockWithResult.md | 2 +- .../sequencer/variables/JSONTaskSerializer.md | 2 +- .../variables/QueryBuilderFactory.md | 2 +- .../reference/stack/classes/TestBalances.md | 8 +- .../reference/stack/functions/startServer.md | 2 +- src/pages/docs/workers.mdx | 75 ---------- 625 files changed, 3006 insertions(+), 2744 deletions(-) create mode 100755 generate-typedoc.sh delete mode 100644 src/pages/docs/common/_meta.tsx delete mode 100644 src/pages/docs/common/modularity-configuration.mdx delete mode 100644 src/pages/docs/provable-events.mdx create mode 100644 src/pages/docs/reference/api/globals.md create mode 100644 src/pages/docs/reference/common/globals.md create mode 100644 src/pages/docs/reference/indexer/globals.md create mode 100644 src/pages/docs/reference/library/globals.md create mode 100644 src/pages/docs/reference/persistance/globals.md create mode 100644 src/pages/docs/reference/processor/globals.md delete mode 100644 src/pages/docs/workers.mdx diff --git a/.gitignore b/.gitignore index 304bbfe..bdb63ac 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ node_modules .DS_Store .git .idea +framework \ No newline at end of file diff --git a/README.md b/README.md index 1a63a3a..c6bef08 100644 --- a/README.md +++ b/README.md @@ -24,4 +24,4 @@ Typedoc / reference docs must be generated in the `framework` repo first, and th ## License -This project is licensed under the MIT License. +This project is licensed under the MIT License. \ No newline at end of file diff --git a/generate-reference-meta.mjs b/generate-reference-meta.mjs index 8afc207..6aff7c8 100644 --- a/generate-reference-meta.mjs +++ b/generate-reference-meta.mjs @@ -1,5 +1,9 @@ import fs from "fs"; -const references = fs.readdirSync("./src/pages/docs/reference"); +const references = fs + .readdirSync("./src/pages/docs/reference") + .filter((reference) => + fs.lstatSync(`./src/pages/docs/reference/${reference}`).isDirectory() + ); const sidebarTitles = { README: "Overview", @@ -15,23 +19,33 @@ function categoryToSidebarTitle(category) { return sidebarTitles[category]; } +function referenceToSidebarTitle(reference) { + return `@proto-kit/${reference}`; +} + references.forEach((reference) => { - if (fs.lstatSync(`./src/pages/docs/reference/${reference}`).isDirectory()) { - const metaTsxPath = `./src/pages/docs/reference/${reference}/_meta.tsx`; - fs.rmSync(metaTsxPath, { force: true }); + const metaTsxPath = `./src/pages/docs/reference/${reference}/_meta.tsx`; + fs.rmSync(metaTsxPath, { force: true }); - const categories = fs.readdirSync( - `./src/pages/docs/reference/${reference}`, - "utf8" - ); + const categories = fs.readdirSync( + `./src/pages/docs/reference/${reference}`, + "utf8" + ); - const metaTsx = `export default { + const metaTsx = `export default { ${categories.map((category) => { category = category.replace(".md", ""); return `"${category}": "${categoryToSidebarTitle(category) ?? category}"`; })} };`; - fs.writeFileSync(metaTsxPath, metaTsx); - } + fs.writeFileSync(metaTsxPath, metaTsx); }); + +const metaTsxPath = `./src/pages/docs/reference/_meta.tsx`; +const metaTsx = `export default { + ${references.map((reference) => { + return `"${reference}": "${referenceToSidebarTitle(reference)}"`; + })} +};`; +fs.writeFileSync(metaTsxPath, metaTsx); diff --git a/generate-typedoc.sh b/generate-typedoc.sh new file mode 100755 index 0000000..1477829 --- /dev/null +++ b/generate-typedoc.sh @@ -0,0 +1,16 @@ +# needs to be cloned to a one-up directory, otherwise README.md auto-discovery +# in framework's typedoc includes website's README.md, which is not desired +git clone git@github.com:proto-kit/framework.git ./../framework-typedoc +cd ./../framework-typedoc +# git checkout develop +git checkout feature/typedoc +npm ci --force +npm run prisma:generate +npm run build +npm run typedoc +cd ./../website +rm -rf *./src/pages/docs/reference +cp -r ./../framework-typedoc/docs/@proto-kit/ ./src/pages/docs/reference +node generate-reference-meta.mjs +rm -rf ./../framework-typedoc +echo "Typedoc generated successfully" \ No newline at end of file diff --git a/package.json b/package.json index 0c4ea50..8a0cd22 100644 --- a/package.json +++ b/package.json @@ -2,8 +2,7 @@ "name": "@protokit/website", "version": "0.0.1", "scripts": { - "generate-reference-meta": "node generate-reference-meta.mjs", - "typedoc:replace": "rm -rf *./src/pages/docs/reference && cp -r ../framework/docs/@proto-kit/ ./src/pages/docs/reference && npm run generate-reference-meta", + "typedoc:generate": "./generate-typedoc.sh", "dev": "next dev", "build": "next build", "start": "next start" diff --git a/src/pages/docs/_meta.tsx b/src/pages/docs/_meta.tsx index 7442f79..ce61aa3 100644 --- a/src/pages/docs/_meta.tsx +++ b/src/pages/docs/_meta.tsx @@ -20,8 +20,5 @@ export default { type: "separator", title: "Contributor Documentation", }, - common: "Common", - workers: "Worker Architecture", - "provable-events": "Provable Events", reference: "Reference", }; diff --git a/src/pages/docs/common/_meta.tsx b/src/pages/docs/common/_meta.tsx deleted file mode 100644 index 7c25b7c..0000000 --- a/src/pages/docs/common/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "modularity-configuration": "Modularity & Configuration", -}; diff --git a/src/pages/docs/common/modularity-configuration.mdx b/src/pages/docs/common/modularity-configuration.mdx deleted file mode 100644 index 93a9723..0000000 --- a/src/pages/docs/common/modularity-configuration.mdx +++ /dev/null @@ -1,17 +0,0 @@ -# Modularity - -The Protokit framework is built with modularity in mind. Under the hood, we use [`tsyringe`](https://github.com/microsoft/tsyringe) to facilitate -constructor based dependency injection. - -## Configurability - -Basic building block of our modular architecture is module configurability, implemented as `ConfigurableModule`. This ensures -that any module that requires upfront configuration to work properly, will be configured accordingly and in a type-safe manner. - -## Module containers - -Module containers are a way to group individual related modules into a single tsyringe DI container. At the same time these containers provide -an additional layer of functionality, such as additionaly decorating said modules with configs. - -### Container lifecycle - diff --git a/src/pages/docs/provable-events.mdx b/src/pages/docs/provable-events.mdx deleted file mode 100644 index 4abd28a..0000000 --- a/src/pages/docs/provable-events.mdx +++ /dev/null @@ -1,27 +0,0 @@ -# Provable Events -The ability for a runtime method to emit provable events gives the user a way to produce events that are verifiable. -The events appear in the output of the runtime method and are stored in the database. Note that due to variable like nature -of the number of events emitted, we commit to a hash of the events. - -Consider the below example for how to define a runtime module and method which outputs provable events. -```typescript {28-31,36-39} showLineNumbers" -export class TestEvent extends Struct({ - message: Bool, -}) {} - -@runtimeModule() -class EventMaker extends RuntimeModule { - public constructor() { - super(); - } - - public events = new RuntimeEvents({ - primary: TestEvent, - }); - - @runtimeMethod() - public async makeEvent() { - this.events.emit("primary", new TestEvent({ message: Bool(false) })); - } -} -``` \ No newline at end of file diff --git a/src/pages/docs/reference/_meta.tsx b/src/pages/docs/reference/_meta.tsx index c34b10d..fc34595 100644 --- a/src/pages/docs/reference/_meta.tsx +++ b/src/pages/docs/reference/_meta.tsx @@ -1,14 +1,3 @@ export default { - api: "API", - common: "Common", - deployment: "Deployment", - indexer: "Indexer", - library: "Library", - module: "Module", - persistance: "Persistance", - processor: "Processor", - protocol: "Protocol", - sdk: "SDK", - sequencer: "Sequencer", - stack: "Stack", -}; + "api": "@proto-kit/api","common": "@proto-kit/common","deployment": "@proto-kit/deployment","indexer": "@proto-kit/indexer","library": "@proto-kit/library","module": "@proto-kit/module","persistance": "@proto-kit/persistance","processor": "@proto-kit/processor","protocol": "@proto-kit/protocol","sdk": "@proto-kit/sdk","sequencer": "@proto-kit/sequencer","stack": "@proto-kit/stack" +}; \ No newline at end of file diff --git a/src/pages/docs/reference/api/_meta.tsx b/src/pages/docs/reference/api/_meta.tsx index a31554d..b6944c5 100644 --- a/src/pages/docs/reference/api/_meta.tsx +++ b/src/pages/docs/reference/api/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" + "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases" }; \ No newline at end of file diff --git a/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md b/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md index a09ce63..3bec116 100644 --- a/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md +++ b/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md @@ -10,7 +10,7 @@ title: AdvancedNodeStatusResolver # Class: AdvancedNodeStatusResolver -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L74) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L74) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new AdvancedNodeStatusResolver**(`nodeStatusService`): [`AdvancedNodeStatusResolver`](AdvancedNodeStatusResolver.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L75) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L75) #### Parameters @@ -117,7 +117,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **node**(): `Promise`\<[`NodeStatusObject`](NodeStatusObject.md)\> -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L83) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L83) #### Returns diff --git a/src/pages/docs/reference/api/classes/BatchStorageResolver.md b/src/pages/docs/reference/api/classes/BatchStorageResolver.md index 7c9492e..7e1841e 100644 --- a/src/pages/docs/reference/api/classes/BatchStorageResolver.md +++ b/src/pages/docs/reference/api/classes/BatchStorageResolver.md @@ -10,7 +10,7 @@ title: BatchStorageResolver # Class: BatchStorageResolver -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L41) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L41) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new BatchStorageResolver**(`batchStorage`, `blockResolver`): [`BatchStorageResolver`](BatchStorageResolver.md) -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L43) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L43) #### Parameters @@ -99,7 +99,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **batches**(`height`): `Promise`\<`undefined` \| [`ComputedBlockModel`](ComputedBlockModel.md)\> -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L56) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L56) #### Parameters diff --git a/src/pages/docs/reference/api/classes/BlockModel.md b/src/pages/docs/reference/api/classes/BlockModel.md index c6c66d7..aa762b7 100644 --- a/src/pages/docs/reference/api/classes/BlockModel.md +++ b/src/pages/docs/reference/api/classes/BlockModel.md @@ -10,7 +10,7 @@ title: BlockModel # Class: BlockModel -Defined in: [api/src/graphql/modules/BlockResolver.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L14) +Defined in: [api/src/graphql/modules/BlockResolver.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L14) ## Properties @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:14](https://github.com/pro > **hash**: `string` -Defined in: [api/src/graphql/modules/BlockResolver.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L32) +Defined in: [api/src/graphql/modules/BlockResolver.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L32) *** @@ -26,7 +26,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:32](https://github.com/pro > **height**: `number` -Defined in: [api/src/graphql/modules/BlockResolver.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L38) +Defined in: [api/src/graphql/modules/BlockResolver.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L38) *** @@ -34,7 +34,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:38](https://github.com/pro > **previousBlockHash**: `undefined` \| `string` -Defined in: [api/src/graphql/modules/BlockResolver.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L35) +Defined in: [api/src/graphql/modules/BlockResolver.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L35) *** @@ -42,7 +42,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:35](https://github.com/pro > **transactionsHash**: `string` -Defined in: [api/src/graphql/modules/BlockResolver.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L44) +Defined in: [api/src/graphql/modules/BlockResolver.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L44) *** @@ -50,7 +50,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:44](https://github.com/pro > **txs**: `BatchTransactionModel`[] -Defined in: [api/src/graphql/modules/BlockResolver.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L41) +Defined in: [api/src/graphql/modules/BlockResolver.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L41) ## Methods @@ -58,7 +58,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:41](https://github.com/pro > `static` **fromServiceLayerModel**(`block`): [`BlockModel`](BlockModel.md) -Defined in: [api/src/graphql/modules/BlockResolver.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L15) +Defined in: [api/src/graphql/modules/BlockResolver.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L15) #### Parameters diff --git a/src/pages/docs/reference/api/classes/BlockResolver.md b/src/pages/docs/reference/api/classes/BlockResolver.md index 8ada325..15aebcb 100644 --- a/src/pages/docs/reference/api/classes/BlockResolver.md +++ b/src/pages/docs/reference/api/classes/BlockResolver.md @@ -10,7 +10,7 @@ title: BlockResolver # Class: BlockResolver -Defined in: [api/src/graphql/modules/BlockResolver.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L62) +Defined in: [api/src/graphql/modules/BlockResolver.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L62) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new BlockResolver**(`blockStorage`): [`BlockResolver`](BlockResolver.md) -Defined in: [api/src/graphql/modules/BlockResolver.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L63) +Defined in: [api/src/graphql/modules/BlockResolver.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L63) #### Parameters @@ -95,7 +95,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **block**(`height`, `hash`): `Promise`\<`undefined` \| [`BlockModel`](BlockModel.md)\> -Defined in: [api/src/graphql/modules/BlockResolver.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BlockResolver.ts#L75) +Defined in: [api/src/graphql/modules/BlockResolver.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L75) #### Parameters diff --git a/src/pages/docs/reference/api/classes/ComputedBlockModel.md b/src/pages/docs/reference/api/classes/ComputedBlockModel.md index 7d74711..c107760 100644 --- a/src/pages/docs/reference/api/classes/ComputedBlockModel.md +++ b/src/pages/docs/reference/api/classes/ComputedBlockModel.md @@ -10,7 +10,7 @@ title: ComputedBlockModel # Class: ComputedBlockModel -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L15) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L15) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:15](https://github. > **new ComputedBlockModel**(`blocks`, `proof`): [`ComputedBlockModel`](ComputedBlockModel.md) -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L34) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L34) #### Parameters @@ -40,7 +40,7 @@ Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:34](https://github. > **blocks**: [`BlockModel`](BlockModel.md)[] -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L29) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L29) *** @@ -48,7 +48,7 @@ Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:29](https://github. > **proof**: `string` -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L32) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L32) ## Methods @@ -56,7 +56,7 @@ Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:32](https://github. > `static` **fromServiceLayerModel**(`__namedParameters`, `blocks`): [`ComputedBlockModel`](ComputedBlockModel.md) -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/BatchStorageResolver.ts#L16) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/api/classes/GraphqlModule.md b/src/pages/docs/reference/api/classes/GraphqlModule.md index 9e296fa..1c6a69a 100644 --- a/src/pages/docs/reference/api/classes/GraphqlModule.md +++ b/src/pages/docs/reference/api/classes/GraphqlModule.md @@ -10,7 +10,7 @@ title: GraphqlModule # Class: `abstract` GraphqlModule\ -Defined in: [api/src/graphql/GraphqlModule.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L8) +Defined in: [api/src/graphql/GraphqlModule.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L8) Used by various module sub-types that may need to be configured @@ -39,7 +39,7 @@ Used by various module sub-types that may need to be configured > **new GraphqlModule**\<`Config`\>(): [`GraphqlModule`](GraphqlModule.md)\<`Config`\> -Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L11) +Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L11) #### Returns diff --git a/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md b/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md index 319db14..2aa217c 100644 --- a/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md +++ b/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md @@ -10,7 +10,7 @@ title: GraphqlSequencerModule # Class: GraphqlSequencerModule\ -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L33) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L33) Lifecycle of a SequencerModule @@ -231,7 +231,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L98) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L98) #### Returns @@ -297,7 +297,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:115 > **create**(`childContainerProvider`): `void` -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L49) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L49) This is a placeholder for individual modules to override. This method will be called whenever the underlying container fully @@ -595,7 +595,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L55) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L55) Start the module and all it's functionality. The returned Promise has to resolve after initialization, @@ -645,7 +645,7 @@ such as only injecting other known modules. > `static` **from**\<`GraphQLModules`\>(`definition`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](GraphqlSequencerModule.md)\<`GraphQLModules`\>\> -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L37) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L37) #### Type Parameters diff --git a/src/pages/docs/reference/api/classes/GraphqlServer.md b/src/pages/docs/reference/api/classes/GraphqlServer.md index 5f72b57..c4866b5 100644 --- a/src/pages/docs/reference/api/classes/GraphqlServer.md +++ b/src/pages/docs/reference/api/classes/GraphqlServer.md @@ -10,7 +10,7 @@ title: GraphqlServer # Class: GraphqlServer -Defined in: [api/src/graphql/GraphqlServer.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L30) +Defined in: [api/src/graphql/GraphqlServer.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L30) Lifecycle of a SequencerModule @@ -101,7 +101,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **close**(): `Promise`\<`void`\> -Defined in: [api/src/graphql/GraphqlServer.ts:148](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L148) +Defined in: [api/src/graphql/GraphqlServer.ts:148](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L148) #### Returns @@ -135,7 +135,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **registerModule**(`module`): `void` -Defined in: [api/src/graphql/GraphqlServer.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L55) +Defined in: [api/src/graphql/GraphqlServer.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L55) #### Parameters @@ -153,7 +153,7 @@ Defined in: [api/src/graphql/GraphqlServer.ts:55](https://github.com/proto-kit/f > **registerResolvers**(`resolvers`): `void` -Defined in: [api/src/graphql/GraphqlServer.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L63) +Defined in: [api/src/graphql/GraphqlServer.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L63) #### Parameters @@ -171,7 +171,7 @@ Defined in: [api/src/graphql/GraphqlServer.ts:63](https://github.com/proto-kit/f > **registerSchema**(`schema`): `void` -Defined in: [api/src/graphql/GraphqlServer.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L59) +Defined in: [api/src/graphql/GraphqlServer.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L59) #### Parameters @@ -189,7 +189,7 @@ Defined in: [api/src/graphql/GraphqlServer.ts:59](https://github.com/proto-kit/f > **setContainer**(`container`): `void` -Defined in: [api/src/graphql/GraphqlServer.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L43) +Defined in: [api/src/graphql/GraphqlServer.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L43) #### Parameters @@ -207,7 +207,7 @@ Defined in: [api/src/graphql/GraphqlServer.ts:43](https://github.com/proto-kit/f > **setContext**(`context`): `void` -Defined in: [api/src/graphql/GraphqlServer.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L71) +Defined in: [api/src/graphql/GraphqlServer.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L71) #### Parameters @@ -223,7 +223,7 @@ Defined in: [api/src/graphql/GraphqlServer.ts:71](https://github.com/proto-kit/f > **start**(): `Promise`\<`void`\> -Defined in: [api/src/graphql/GraphqlServer.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L75) +Defined in: [api/src/graphql/GraphqlServer.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L75) Start the module and all it's functionality. The returned Promise has to resolve after initialization, @@ -244,7 +244,7 @@ That means that you mustn't await server.start() for example. > **startServer**(): `Promise`\<`void`\> -Defined in: [api/src/graphql/GraphqlServer.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlServer.ts#L79) +Defined in: [api/src/graphql/GraphqlServer.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L79) #### Returns diff --git a/src/pages/docs/reference/api/classes/MempoolResolver.md b/src/pages/docs/reference/api/classes/MempoolResolver.md index cfa7469..1e40396 100644 --- a/src/pages/docs/reference/api/classes/MempoolResolver.md +++ b/src/pages/docs/reference/api/classes/MempoolResolver.md @@ -10,7 +10,7 @@ title: MempoolResolver # Class: MempoolResolver -Defined in: [api/src/graphql/modules/MempoolResolver.ts:121](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L121) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:121](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L121) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new MempoolResolver**(`mempool`, `transactionStorage`): [`MempoolResolver`](MempoolResolver.md) -Defined in: [api/src/graphql/modules/MempoolResolver.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L122) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L122) #### Parameters @@ -121,7 +121,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **submitTx**(`tx`): `Promise`\<`string`\> -Defined in: [api/src/graphql/modules/MempoolResolver.ts:133](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L133) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:133](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L133) #### Parameters @@ -139,7 +139,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:133](https://github.com/ > **transactions**(): `Promise`\<`string`[]\> -Defined in: [api/src/graphql/modules/MempoolResolver.ts:169](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L169) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:169](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L169) #### Returns @@ -151,7 +151,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:169](https://github.com/ > **transactionState**(`hash`): `Promise`\<`InclusionStatus`\> -Defined in: [api/src/graphql/modules/MempoolResolver.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L144) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L144) #### Parameters diff --git a/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md b/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md index 895c56b..022be0d 100644 --- a/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md +++ b/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md @@ -10,7 +10,7 @@ title: MerkleWitnessDTO # Class: MerkleWitnessDTO -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L13) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L13) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:13](https://github > **new MerkleWitnessDTO**(`siblings`, `isLefts`): [`MerkleWitnessDTO`](MerkleWitnessDTO.md) -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L20) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L20) #### Parameters @@ -40,7 +40,7 @@ Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:20](https://github > **isLefts**: `boolean`[] -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L31) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L31) *** @@ -48,7 +48,7 @@ Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:31](https://github > **siblings**: `string`[] -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L27) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L27) ## Methods @@ -56,7 +56,7 @@ Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:27](https://github > `static` **fromServiceLayerObject**(`witness`): [`MerkleWitnessDTO`](MerkleWitnessDTO.md) -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L14) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L14) #### Parameters diff --git a/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md b/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md index 352369c..2ffe986 100644 --- a/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md +++ b/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md @@ -10,7 +10,7 @@ title: MerkleWitnessResolver # Class: MerkleWitnessResolver -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L35) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L35) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new MerkleWitnessResolver**(`treeStore`): [`MerkleWitnessResolver`](MerkleWitnessResolver.md) -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L36) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L36) #### Parameters @@ -117,7 +117,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **witness**(`path`): `Promise`\<[`MerkleWitnessDTO`](MerkleWitnessDTO.md)\> -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L46) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L46) #### Parameters diff --git a/src/pages/docs/reference/api/classes/NodeInformationObject.md b/src/pages/docs/reference/api/classes/NodeInformationObject.md index 5cafff1..552a934 100644 --- a/src/pages/docs/reference/api/classes/NodeInformationObject.md +++ b/src/pages/docs/reference/api/classes/NodeInformationObject.md @@ -10,7 +10,7 @@ title: NodeInformationObject # Class: NodeInformationObject -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L10) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L10) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:10](https://github.co > **new NodeInformationObject**(`blockHeight`, `batchHeight`): [`NodeInformationObject`](NodeInformationObject.md) -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L21) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L21) #### Parameters @@ -40,7 +40,7 @@ Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:21](https://github.co > **batchHeight**: `number` -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L19) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L19) *** @@ -48,7 +48,7 @@ Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:19](https://github.co > **blockHeight**: `number` -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L16) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L16) ## Methods @@ -56,7 +56,7 @@ Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:16](https://github.co > `static` **fromServiceLayerModel**(`status`): [`NodeInformationObject`](NodeInformationObject.md) -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L11) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L11) #### Parameters diff --git a/src/pages/docs/reference/api/classes/NodeStatusObject.md b/src/pages/docs/reference/api/classes/NodeStatusObject.md index fe2a04b..08ebf68 100644 --- a/src/pages/docs/reference/api/classes/NodeStatusObject.md +++ b/src/pages/docs/reference/api/classes/NodeStatusObject.md @@ -10,7 +10,7 @@ title: NodeStatusObject # Class: NodeStatusObject -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L53) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L53) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:53](https://g > **new NodeStatusObject**(`node`, `process`): [`NodeStatusObject`](NodeStatusObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L67) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L67) #### Parameters @@ -40,7 +40,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:67](https://g > **node**: [`NodeInformationObject`](NodeInformationObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L65) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L65) *** @@ -48,7 +48,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:65](https://g > **process**: [`ProcessInformationObject`](ProcessInformationObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L62) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L62) ## Methods @@ -56,7 +56,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:62](https://g > `static` **fromServiceLayerModel**(`node`, `process`): [`NodeStatusObject`](NodeStatusObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L54) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L54) #### Parameters diff --git a/src/pages/docs/reference/api/classes/NodeStatusResolver.md b/src/pages/docs/reference/api/classes/NodeStatusResolver.md index 905784a..749b0fd 100644 --- a/src/pages/docs/reference/api/classes/NodeStatusResolver.md +++ b/src/pages/docs/reference/api/classes/NodeStatusResolver.md @@ -10,7 +10,7 @@ title: NodeStatusResolver # Class: NodeStatusResolver -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L28) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L28) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new NodeStatusResolver**(`nodeStatusService`): [`NodeStatusResolver`](NodeStatusResolver.md) -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L29) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L29) #### Parameters @@ -117,7 +117,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **node**(): `Promise`\<[`NodeInformationObject`](NodeInformationObject.md)\> -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/NodeStatusResolver.ts#L36) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L36) #### Returns diff --git a/src/pages/docs/reference/api/classes/NodeStatusService.md b/src/pages/docs/reference/api/classes/NodeStatusService.md index c0c80c7..37706d7 100644 --- a/src/pages/docs/reference/api/classes/NodeStatusService.md +++ b/src/pages/docs/reference/api/classes/NodeStatusService.md @@ -10,7 +10,7 @@ title: NodeStatusService # Class: NodeStatusService -Defined in: [api/src/graphql/services/NodeStatusService.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L27) +Defined in: [api/src/graphql/services/NodeStatusService.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L27) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:27](https://github.co > **new NodeStatusService**(`blockStorage`, `batchStorage`, `settlementStorage`): [`NodeStatusService`](NodeStatusService.md) -Defined in: [api/src/graphql/services/NodeStatusService.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L28) +Defined in: [api/src/graphql/services/NodeStatusService.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L28) #### Parameters @@ -44,7 +44,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:28](https://github.co > **getNodeInformation**(): `Promise`\<[`NodeInformation`](../interfaces/NodeInformation.md)\> -Defined in: [api/src/graphql/services/NodeStatusService.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L56) +Defined in: [api/src/graphql/services/NodeStatusService.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L56) #### Returns @@ -56,7 +56,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:56](https://github.co > **getProcessInfo**(): [`ProcessInformation`](../interfaces/ProcessInformation.md) -Defined in: [api/src/graphql/services/NodeStatusService.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L36) +Defined in: [api/src/graphql/services/NodeStatusService.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L36) #### Returns diff --git a/src/pages/docs/reference/api/classes/ProcessInformationObject.md b/src/pages/docs/reference/api/classes/ProcessInformationObject.md index d32154d..6415639 100644 --- a/src/pages/docs/reference/api/classes/ProcessInformationObject.md +++ b/src/pages/docs/reference/api/classes/ProcessInformationObject.md @@ -10,7 +10,7 @@ title: ProcessInformationObject # Class: ProcessInformationObject -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L13) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L13) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:13](https://g > **new ProcessInformationObject**(`process`): [`ProcessInformationObject`](ProcessInformationObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L39) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L39) #### Parameters @@ -36,7 +36,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:39](https://g > **arch**: `string` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L34) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L34) *** @@ -44,7 +44,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:34](https://g > **headTotal**: `number` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L28) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L28) *** @@ -52,7 +52,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:28](https://g > **headUsed**: `number` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L25) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L25) *** @@ -60,7 +60,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:25](https://g > **nodeVersion**: `string` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L31) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L31) *** @@ -68,7 +68,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:31](https://g > **platform**: `string` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L37) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L37) *** @@ -76,7 +76,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:37](https://g > **uptime**: `number` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L19) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L19) *** @@ -84,7 +84,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:19](https://g > **uptimeHumanReadable**: `string` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L22) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L22) ## Methods @@ -92,7 +92,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:22](https://g > `static` **fromServiceLayerModel**(`process`): [`ProcessInformationObject`](ProcessInformationObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L14) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L14) #### Parameters diff --git a/src/pages/docs/reference/api/classes/QueryGraphqlModule.md b/src/pages/docs/reference/api/classes/QueryGraphqlModule.md index ff1c75f..47f1cad 100644 --- a/src/pages/docs/reference/api/classes/QueryGraphqlModule.md +++ b/src/pages/docs/reference/api/classes/QueryGraphqlModule.md @@ -10,7 +10,7 @@ title: QueryGraphqlModule # Class: QueryGraphqlModule\ -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L69) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L69) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new QueryGraphqlModule**\<`RuntimeModules`\>(`queryTransportModule`, `networkStateTransportModule`, `runtime`, `protocol`, `blockStorage`): [`QueryGraphqlModule`](QueryGraphqlModule.md)\<`RuntimeModules`\> -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L72) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L72) #### Parameters @@ -137,7 +137,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **generateSchema**(): `GraphQLSchema` -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:361](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L361) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:361](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L361) #### Returns @@ -153,7 +153,7 @@ Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:361](https://github.c > **generateSchemaForQuery**\<`ModuleType`, `ContainerModulesRecord`\>(`container`, `containerQuery`, `namePrefix`): `ObjMap`\<`GraphQLFieldConfig`\<`unknown`, `unknown`\>\> -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:310](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L310) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:310](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L310) #### Type Parameters @@ -185,7 +185,7 @@ Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:310](https://github.c > **generateStateMapResolver**\<`Key`, `Value`\>(`fieldKey`, `query`, `stateMap`): `GraphQLFieldConfig`\<`unknown`, `unknown`\> -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:222](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L222) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:222](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L222) #### Type Parameters @@ -217,7 +217,7 @@ Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:222](https://github.c > **generateStateResolver**\<`Value`\>(`fieldKey`, `query`, `state`): `object` -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:276](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L276) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:276](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L276) #### Type Parameters @@ -263,7 +263,7 @@ Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:276](https://github.c > **state**(`path`): `Promise`\<`undefined` \| `string`[]\> -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:93](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L93) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:93](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L93) #### Parameters diff --git a/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md b/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md index c0af246..11b7476 100644 --- a/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md +++ b/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md @@ -10,7 +10,7 @@ title: ResolverFactoryGraphqlModule # Class: `abstract` ResolverFactoryGraphqlModule\ -Defined in: [api/src/graphql/GraphqlModule.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L30) +Defined in: [api/src/graphql/GraphqlModule.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L30) Used by various module sub-types that may need to be configured @@ -33,7 +33,7 @@ Used by various module sub-types that may need to be configured > **new ResolverFactoryGraphqlModule**\<`Config`\>(): [`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`Config`\> -Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L11) +Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L11) #### Returns @@ -120,7 +120,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > `abstract` **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> -Defined in: [api/src/graphql/GraphqlModule.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L33) +Defined in: [api/src/graphql/GraphqlModule.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L33) #### Returns diff --git a/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md b/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md index 352b484..750f0b1 100644 --- a/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md +++ b/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md @@ -10,7 +10,7 @@ title: SchemaGeneratingGraphqlModule # Class: `abstract` SchemaGeneratingGraphqlModule\ -Defined in: [api/src/graphql/GraphqlModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L24) +Defined in: [api/src/graphql/GraphqlModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L24) Used by various module sub-types that may need to be configured @@ -32,7 +32,7 @@ Used by various module sub-types that may need to be configured > **new SchemaGeneratingGraphqlModule**\<`Config`\>(): [`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md)\<`Config`\> -Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L11) +Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L11) #### Returns @@ -119,7 +119,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > `abstract` **generateSchema**(): `GraphQLSchema` -Defined in: [api/src/graphql/GraphqlModule.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L27) +Defined in: [api/src/graphql/GraphqlModule.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L27) #### Returns diff --git a/src/pages/docs/reference/api/classes/Signature.md b/src/pages/docs/reference/api/classes/Signature.md index 98fa2e5..aaae6d8 100644 --- a/src/pages/docs/reference/api/classes/Signature.md +++ b/src/pages/docs/reference/api/classes/Signature.md @@ -10,7 +10,7 @@ title: Signature # Class: Signature -Defined in: [api/src/graphql/modules/MempoolResolver.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L22) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L22) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:22](https://github.com/p > **new Signature**(`r`, `s`): [`Signature`](Signature.md) -Defined in: [api/src/graphql/modules/MempoolResolver.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L31) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L31) #### Parameters @@ -40,7 +40,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:31](https://github.com/p > **r**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L25) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L25) *** @@ -48,4 +48,4 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:25](https://github.com/p > **s**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L29) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L29) diff --git a/src/pages/docs/reference/api/classes/TransactionObject.md b/src/pages/docs/reference/api/classes/TransactionObject.md index 2af5405..e65aa97 100644 --- a/src/pages/docs/reference/api/classes/TransactionObject.md +++ b/src/pages/docs/reference/api/classes/TransactionObject.md @@ -10,7 +10,7 @@ title: TransactionObject # Class: TransactionObject -Defined in: [api/src/graphql/modules/MempoolResolver.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L39) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L39) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:39](https://github.com/p > **new TransactionObject**(`hash`, `methodId`, `sender`, `nonce`, `signature`, `argsFields`, `auxiliaryData`, `isMessage`): [`TransactionObject`](TransactionObject.md) -Defined in: [api/src/graphql/modules/MempoolResolver.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L88) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L88) #### Parameters @@ -64,7 +64,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:88](https://github.com/p > **argsFields**: `string`[] -Defined in: [api/src/graphql/modules/MempoolResolver.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L80) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L80) *** @@ -72,7 +72,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:80](https://github.com/p > **auxiliaryData**: `string`[] -Defined in: [api/src/graphql/modules/MempoolResolver.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L83) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L83) *** @@ -80,7 +80,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:83](https://github.com/p > **hash**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L63) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L63) *** @@ -88,7 +88,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:63](https://github.com/p > **isMessage**: `boolean` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L86) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L86) *** @@ -96,7 +96,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:86](https://github.com/p > **methodId**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L67) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L67) *** @@ -104,7 +104,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:67](https://github.com/p > **nonce**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L74) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L74) *** @@ -112,7 +112,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:74](https://github.com/p > **sender**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L70) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L70) *** @@ -120,7 +120,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:70](https://github.com/p > **signature**: [`Signature`](Signature.md) -Defined in: [api/src/graphql/modules/MempoolResolver.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L77) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L77) ## Methods @@ -128,7 +128,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:77](https://github.com/p > `static` **fromServiceLayerModel**(`pt`): [`TransactionObject`](TransactionObject.md) -Defined in: [api/src/graphql/modules/MempoolResolver.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/modules/MempoolResolver.ts#L40) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L40) #### Parameters diff --git a/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md b/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md index f7a7061..83c11f6 100644 --- a/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md +++ b/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md @@ -10,7 +10,7 @@ title: VanillaGraphqlModules # Class: VanillaGraphqlModules -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/VanillaGraphqlModules.ts#L20) +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/VanillaGraphqlModules.ts#L20) ## Constructors @@ -28,7 +28,7 @@ Defined in: [api/src/graphql/VanillaGraphqlModules.ts:20](https://github.com/pro > `static` **defaultConfig**(): `object` -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/VanillaGraphqlModules.ts#L35) +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/VanillaGraphqlModules.ts#L35) #### Returns @@ -64,7 +64,7 @@ Defined in: [api/src/graphql/VanillaGraphqlModules.ts:35](https://github.com/pro > `static` **with**\<`AdditionalModules`\>(`additionalModules`): `object` & `AdditionalModules` -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/VanillaGraphqlModules.ts#L21) +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/VanillaGraphqlModules.ts#L21) #### Type Parameters diff --git a/src/pages/docs/reference/api/functions/graphqlModule.md b/src/pages/docs/reference/api/functions/graphqlModule.md index 27bd012..d327429 100644 --- a/src/pages/docs/reference/api/functions/graphqlModule.md +++ b/src/pages/docs/reference/api/functions/graphqlModule.md @@ -12,7 +12,7 @@ title: graphqlModule > **graphqlModule**(): (`target`) => `void` -Defined in: [api/src/graphql/GraphqlModule.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlModule.ts#L36) +Defined in: [api/src/graphql/GraphqlModule.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L36) ## Returns diff --git a/src/pages/docs/reference/api/globals.md b/src/pages/docs/reference/api/globals.md new file mode 100644 index 0000000..869d7c9 --- /dev/null +++ b/src/pages/docs/reference/api/globals.md @@ -0,0 +1,51 @@ +--- +title: "@proto-kit/api" +--- + +[**@proto-kit/api**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/api + +# @proto-kit/api + +## Classes + +- [AdvancedNodeStatusResolver](classes/AdvancedNodeStatusResolver.md) +- [BatchStorageResolver](classes/BatchStorageResolver.md) +- [BlockModel](classes/BlockModel.md) +- [BlockResolver](classes/BlockResolver.md) +- [ComputedBlockModel](classes/ComputedBlockModel.md) +- [GraphqlModule](classes/GraphqlModule.md) +- [GraphqlSequencerModule](classes/GraphqlSequencerModule.md) +- [GraphqlServer](classes/GraphqlServer.md) +- [MempoolResolver](classes/MempoolResolver.md) +- [MerkleWitnessDTO](classes/MerkleWitnessDTO.md) +- [MerkleWitnessResolver](classes/MerkleWitnessResolver.md) +- [NodeInformationObject](classes/NodeInformationObject.md) +- [NodeStatusObject](classes/NodeStatusObject.md) +- [NodeStatusResolver](classes/NodeStatusResolver.md) +- [NodeStatusService](classes/NodeStatusService.md) +- [ProcessInformationObject](classes/ProcessInformationObject.md) +- [QueryGraphqlModule](classes/QueryGraphqlModule.md) +- [ResolverFactoryGraphqlModule](classes/ResolverFactoryGraphqlModule.md) +- [SchemaGeneratingGraphqlModule](classes/SchemaGeneratingGraphqlModule.md) +- [Signature](classes/Signature.md) +- [TransactionObject](classes/TransactionObject.md) +- [VanillaGraphqlModules](classes/VanillaGraphqlModules.md) + +## Interfaces + +- [GraphqlModulesDefintion](interfaces/GraphqlModulesDefintion.md) +- [NodeInformation](interfaces/NodeInformation.md) +- [ProcessInformation](interfaces/ProcessInformation.md) + +## Type Aliases + +- [GraphqlModulesRecord](type-aliases/GraphqlModulesRecord.md) +- [VanillaGraphqlModulesRecord](type-aliases/VanillaGraphqlModulesRecord.md) + +## Functions + +- [graphqlModule](functions/graphqlModule.md) diff --git a/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md b/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md index 26fa600..cb785da 100644 --- a/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md +++ b/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md @@ -10,7 +10,7 @@ title: GraphqlModulesDefintion # Interface: GraphqlModulesDefintion\ -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L25) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L25) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [api/src/graphql/GraphqlSequencerModule.ts:25](https://github.com/pr > `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`GraphQLModules`\> -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L29) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L29) *** @@ -30,4 +30,4 @@ Defined in: [api/src/graphql/GraphqlSequencerModule.ts:29](https://github.com/pr > **modules**: `GraphQLModules` -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L28) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L28) diff --git a/src/pages/docs/reference/api/interfaces/NodeInformation.md b/src/pages/docs/reference/api/interfaces/NodeInformation.md index 9903b60..06792ed 100644 --- a/src/pages/docs/reference/api/interfaces/NodeInformation.md +++ b/src/pages/docs/reference/api/interfaces/NodeInformation.md @@ -10,7 +10,7 @@ title: NodeInformation # Interface: NodeInformation -Defined in: [api/src/graphql/services/NodeStatusService.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L21) +Defined in: [api/src/graphql/services/NodeStatusService.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L21) ## Properties @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:21](https://github.co > **batchHeight**: `number` -Defined in: [api/src/graphql/services/NodeStatusService.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L23) +Defined in: [api/src/graphql/services/NodeStatusService.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L23) *** @@ -26,4 +26,4 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:23](https://github.co > **blockHeight**: `number` -Defined in: [api/src/graphql/services/NodeStatusService.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L22) +Defined in: [api/src/graphql/services/NodeStatusService.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L22) diff --git a/src/pages/docs/reference/api/interfaces/ProcessInformation.md b/src/pages/docs/reference/api/interfaces/ProcessInformation.md index d7d414b..029c87e 100644 --- a/src/pages/docs/reference/api/interfaces/ProcessInformation.md +++ b/src/pages/docs/reference/api/interfaces/ProcessInformation.md @@ -10,7 +10,7 @@ title: ProcessInformation # Interface: ProcessInformation -Defined in: [api/src/graphql/services/NodeStatusService.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L11) +Defined in: [api/src/graphql/services/NodeStatusService.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L11) ## Properties @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:11](https://github.co > **arch**: `string` -Defined in: [api/src/graphql/services/NodeStatusService.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L17) +Defined in: [api/src/graphql/services/NodeStatusService.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L17) *** @@ -26,7 +26,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:17](https://github.co > **headTotal**: `number` -Defined in: [api/src/graphql/services/NodeStatusService.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L15) +Defined in: [api/src/graphql/services/NodeStatusService.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L15) *** @@ -34,7 +34,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:15](https://github.co > **headUsed**: `number` -Defined in: [api/src/graphql/services/NodeStatusService.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L14) +Defined in: [api/src/graphql/services/NodeStatusService.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L14) *** @@ -42,7 +42,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:14](https://github.co > **nodeVersion**: `string` -Defined in: [api/src/graphql/services/NodeStatusService.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L16) +Defined in: [api/src/graphql/services/NodeStatusService.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L16) *** @@ -50,7 +50,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:16](https://github.co > **platform**: `string` -Defined in: [api/src/graphql/services/NodeStatusService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L18) +Defined in: [api/src/graphql/services/NodeStatusService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L18) *** @@ -58,7 +58,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:18](https://github.co > **uptime**: `number` -Defined in: [api/src/graphql/services/NodeStatusService.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L12) +Defined in: [api/src/graphql/services/NodeStatusService.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L12) *** @@ -66,4 +66,4 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:12](https://github.co > **uptimeHumanReadable**: `string` -Defined in: [api/src/graphql/services/NodeStatusService.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/services/NodeStatusService.ts#L13) +Defined in: [api/src/graphql/services/NodeStatusService.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L13) diff --git a/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md b/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md index 10c10c1..d0b16c7 100644 --- a/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md +++ b/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md @@ -12,4 +12,4 @@ title: GraphqlModulesRecord > **GraphqlModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlModule`](../classes/GraphqlModule.md)\<`unknown`\>\>\> -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/GraphqlSequencerModule.ts#L21) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L21) diff --git a/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md b/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md index 0de84b5..c464038 100644 --- a/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md +++ b/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md @@ -12,7 +12,7 @@ title: VanillaGraphqlModulesRecord > **VanillaGraphqlModulesRecord**: `object` -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/api/src/graphql/VanillaGraphqlModules.ts#L11) +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/VanillaGraphqlModules.ts#L11) ## Type declaration diff --git a/src/pages/docs/reference/common/_meta.tsx b/src/pages/docs/reference/common/_meta.tsx index 5602e3c..4d63940 100644 --- a/src/pages/docs/reference/common/_meta.tsx +++ b/src/pages/docs/reference/common/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" + "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" }; \ No newline at end of file diff --git a/src/pages/docs/reference/common/classes/AtomicCompileHelper.md b/src/pages/docs/reference/common/classes/AtomicCompileHelper.md index 5863fad..84b411b 100644 --- a/src/pages/docs/reference/common/classes/AtomicCompileHelper.md +++ b/src/pages/docs/reference/common/classes/AtomicCompileHelper.md @@ -10,7 +10,7 @@ title: AtomicCompileHelper # Class: AtomicCompileHelper -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/AtomicCompileHelper.ts#L17) +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/AtomicCompileHelper.ts#L17) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:17](https://gi > **new AtomicCompileHelper**(`areProofsEnabled`): [`AtomicCompileHelper`](AtomicCompileHelper.md) -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/AtomicCompileHelper.ts#L18) +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/AtomicCompileHelper.ts#L18) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:18](https://gi > **compileContract**(`contract`, `overrideProofsEnabled`?): `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/AtomicCompileHelper.ts#L24) +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/AtomicCompileHelper.ts#L24) #### Parameters diff --git a/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md b/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md index 719f0fe..650c3d9 100644 --- a/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md +++ b/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md @@ -10,7 +10,7 @@ title: ChildVerificationKeyService # Class: ChildVerificationKeyService -Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L7) +Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L7) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService. > **getVerificationKey**(`name`): `object` -Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L14) +Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L14) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService. > **setCompileRegistry**(`registry`): `void` -Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L10) +Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/common/classes/CompileRegistry.md b/src/pages/docs/reference/common/classes/CompileRegistry.md index 1ccb242..fb45e91 100644 --- a/src/pages/docs/reference/common/classes/CompileRegistry.md +++ b/src/pages/docs/reference/common/classes/CompileRegistry.md @@ -10,7 +10,7 @@ title: CompileRegistry # Class: CompileRegistry -Defined in: [packages/common/src/compiling/CompileRegistry.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L21) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L21) The CompileRegistry compiles "compilable modules" (i.e. zkprograms, contracts or contractmodules) @@ -22,7 +22,7 @@ while making sure they don't get compiled twice in the same process in parallel. > **new CompileRegistry**(`areProofsEnabled`): [`CompileRegistry`](CompileRegistry.md) -Defined in: [packages/common/src/compiling/CompileRegistry.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L22) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L22) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/common/src/compiling/CompileRegistry.ts:22](https://github > **addArtifactsRaw**(`artifacts`): `void` -Defined in: [packages/common/src/compiling/CompileRegistry.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L68) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L68) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/common/src/compiling/CompileRegistry.ts:68](https://github > **compile**(`target`): `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> -Defined in: [packages/common/src/compiling/CompileRegistry.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L49) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L49) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/common/src/compiling/CompileRegistry.ts:49](https://github > **forceProverExists**(`f`): `Promise`\<`void`\> -Defined in: [packages/common/src/compiling/CompileRegistry.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L41) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L41) This function forces compilation even if the artifact itself is in the registry. Basically the statement is: The artifact along is not enough, we need to @@ -99,7 +99,7 @@ This is true for non-sideloaded circuit dependencies. > **getAllArtifacts**(): [`ArtifactRecord`](../type-aliases/ArtifactRecord.md) -Defined in: [packages/common/src/compiling/CompileRegistry.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L75) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L75) #### Returns @@ -111,7 +111,7 @@ Defined in: [packages/common/src/compiling/CompileRegistry.ts:75](https://github > **getArtifact**(`name`): `undefined` \| [`CompileArtifact`](../interfaces/CompileArtifact.md) -Defined in: [packages/common/src/compiling/CompileRegistry.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompileRegistry.ts#L58) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L58) #### Parameters diff --git a/src/pages/docs/reference/common/classes/ConfigurableModule.md b/src/pages/docs/reference/common/classes/ConfigurableModule.md index d03d68d..14d4d61 100644 --- a/src/pages/docs/reference/common/classes/ConfigurableModule.md +++ b/src/pages/docs/reference/common/classes/ConfigurableModule.md @@ -10,7 +10,7 @@ title: ConfigurableModule # Class: ConfigurableModule\ -Defined in: [packages/common/src/config/ConfigurableModule.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L27) +Defined in: [packages/common/src/config/ConfigurableModule.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L27) Used by various module sub-types that may need to be configured @@ -52,7 +52,7 @@ Used by various module sub-types that may need to be configured > `protected` **currentConfig**: `undefined` \| `Config` -Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L34) +Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L34) Store the config separately, so that we can apply additional checks when retrieving it via the getter @@ -65,7 +65,7 @@ checks when retrieving it via the getter > **get** **config**(): `Config` -Defined in: [packages/common/src/config/ConfigurableModule.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L37) +Defined in: [packages/common/src/config/ConfigurableModule.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L37) ##### Returns @@ -75,7 +75,7 @@ Defined in: [packages/common/src/config/ConfigurableModule.ts:37](https://github > **set** **config**(`config`): `void` -Defined in: [packages/common/src/config/ConfigurableModule.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L45) +Defined in: [packages/common/src/config/ConfigurableModule.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L45) ##### Parameters @@ -97,7 +97,7 @@ Defined in: [packages/common/src/config/ConfigurableModule.ts:45](https://github > **create**(`childContainerProvider`): `void` -Defined in: [packages/common/src/config/ConfigurableModule.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L49) +Defined in: [packages/common/src/config/ConfigurableModule.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L49) #### Parameters diff --git a/src/pages/docs/reference/common/classes/EventEmitter.md b/src/pages/docs/reference/common/classes/EventEmitter.md index f801472..1328d58 100644 --- a/src/pages/docs/reference/common/classes/EventEmitter.md +++ b/src/pages/docs/reference/common/classes/EventEmitter.md @@ -10,7 +10,7 @@ title: EventEmitter # Class: EventEmitter\ -Defined in: [packages/common/src/events/EventEmitter.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L7) +Defined in: [packages/common/src/events/EventEmitter.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L7) ## Extended by @@ -37,7 +37,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:7](https://github.com/pr > `protected` `readonly` **listeners**: `ListenersHolder`\<`Events`\> = `{}` -Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L8) +Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L8) *** @@ -45,7 +45,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/pr > `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` -Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L10) +Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L10) #### Parameters @@ -67,7 +67,7 @@ keyof `Events` > **emit**\<`Key`\>(`event`, ...`parameters`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L15) +Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L15) #### Type Parameters @@ -93,7 +93,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/p > **off**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L45) +Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L45) Primitive .off() with identity comparison for now. Could be replaced by returning an id in .on() and using that. @@ -122,7 +122,7 @@ Could be replaced by returning an id in .on() and using that. > **on**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L34) +Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L34) #### Type Parameters @@ -148,7 +148,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/p > **onAll**(`listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L30) +Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L30) #### Parameters diff --git a/src/pages/docs/reference/common/classes/EventEmitterProxy.md b/src/pages/docs/reference/common/classes/EventEmitterProxy.md index d5f64de..db834bb 100644 --- a/src/pages/docs/reference/common/classes/EventEmitterProxy.md +++ b/src/pages/docs/reference/common/classes/EventEmitterProxy.md @@ -10,7 +10,7 @@ title: EventEmitterProxy # Class: EventEmitterProxy\ -Defined in: [packages/common/src/events/EventEmitterProxy.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L42) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L42) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/common/src/events/EventEmitterProxy.ts:42](https://github. > **new EventEmitterProxy**\<`Modules`\>(`container`): [`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> -Defined in: [packages/common/src/events/EventEmitterProxy.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L45) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L45) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/common/src/events/EventEmitterProxy.ts:45](https://github. > `protected` `readonly` **listeners**: `ListenersHolder`\<[`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\>\> = `{}` -Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L8) +Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L8) #### Inherited from @@ -60,7 +60,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/pr > `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` -Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L10) +Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L10) #### Parameters @@ -86,7 +86,7 @@ keyof [`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIn > **emit**\<`Key`\>(`event`, ...`parameters`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L15) +Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L15) #### Type Parameters @@ -116,7 +116,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/p > **off**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L45) +Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L45) Primitive .off() with identity comparison for now. Could be replaced by returning an id in .on() and using that. @@ -149,7 +149,7 @@ Could be replaced by returning an id in .on() and using that. > **on**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L34) +Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L34) #### Type Parameters @@ -179,7 +179,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/p > **onAll**(`listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L30) +Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L30) #### Parameters diff --git a/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md b/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md index da72a7c..29193dc 100644 --- a/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md +++ b/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md @@ -10,7 +10,7 @@ title: InMemoryMerkleTreeStorage # Class: InMemoryMerkleTreeStorage -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L3) +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L3) ## Extended by @@ -37,7 +37,7 @@ Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:3](https://g > `protected` **nodes**: `object` = `{}` -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L4) +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L4) #### Index Signature @@ -49,7 +49,7 @@ Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:4](https://g > **getNode**(`key`, `level`): `undefined` \| `bigint` -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L10) +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L10) #### Parameters @@ -75,7 +75,7 @@ Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:10](https:// > **setNode**(`key`, `level`, `value`): `void` -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L14) +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L14) #### Parameters diff --git a/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md b/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md index 599dc96..0e67b5c 100644 --- a/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md +++ b/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md @@ -10,7 +10,7 @@ title: MockAsyncMerkleTreeStore # Class: MockAsyncMerkleTreeStore -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L5) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L5) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:5](https://github > `readonly` **store**: [`InMemoryMerkleTreeStorage`](InMemoryMerkleTreeStorage.md) -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L6) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L6) ## Methods @@ -36,7 +36,7 @@ Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:6](https://github > **commit**(): `void` -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L8) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L8) #### Returns @@ -48,7 +48,7 @@ Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:8](https://github > **getNodeAsync**(`key`, `level`): `Promise`\<`undefined` \| `bigint`\> -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L16) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L16) #### Parameters @@ -70,7 +70,7 @@ Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:16](https://githu > **openTransaction**(): `void` -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L12) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L12) #### Returns @@ -82,7 +82,7 @@ Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:12](https://githu > **setNodeAsync**(`key`, `level`, `value`): `Promise`\<`void`\> -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MockAsyncMerkleStore.ts#L23) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L23) #### Parameters diff --git a/src/pages/docs/reference/common/classes/ModuleContainer.md b/src/pages/docs/reference/common/classes/ModuleContainer.md index 5bf7a36..532284e 100644 --- a/src/pages/docs/reference/common/classes/ModuleContainer.md +++ b/src/pages/docs/reference/common/classes/ModuleContainer.md @@ -10,7 +10,7 @@ title: ModuleContainer # Class: ModuleContainer\ -Defined in: [packages/common/src/config/ModuleContainer.ts:145](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L145) +Defined in: [packages/common/src/config/ModuleContainer.ts:145](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L145) Reusable module container facilitating registration, resolution configuration, decoration and validation of modules @@ -41,7 +41,7 @@ configuration, decoration and validation of modules > **new ModuleContainer**\<`Modules`\>(`definition`): [`ModuleContainer`](ModuleContainer.md)\<`Modules`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L159) +Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L159) #### Parameters @@ -63,7 +63,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.c > `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> -Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L34) +Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L34) Store the config separately, so that we can apply additional checks when retrieving it via the getter @@ -78,7 +78,7 @@ checks when retrieving it via the getter > **definition**: [`ModuleContainerDefinition`](../interfaces/ModuleContainerDefinition.md)\<`Modules`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L159) +Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L159) ## Accessors @@ -88,7 +88,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.c > **get** **config**(): [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:317](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L317) +Defined in: [packages/common/src/config/ModuleContainer.ts:317](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L317) ##### Returns @@ -98,7 +98,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:317](https://github.c > **set** **config**(`config`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:321](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L321) +Defined in: [packages/common/src/config/ModuleContainer.ts:321](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L321) ##### Parameters @@ -122,7 +122,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:321](https://github.c > **get** `protected` **container**(): `DependencyContainer` -Defined in: [packages/common/src/config/ModuleContainer.ts:199](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L199) +Defined in: [packages/common/src/config/ModuleContainer.ts:199](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L199) ##### Returns @@ -136,7 +136,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:199](https://github.c > **get** **events**(): [`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:270](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L270) +Defined in: [packages/common/src/config/ModuleContainer.ts:270](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L270) ##### Returns @@ -150,7 +150,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:270](https://github.c > **get** **moduleNames**(): `string`[] -Defined in: [packages/common/src/config/ModuleContainer.ts:166](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L166) +Defined in: [packages/common/src/config/ModuleContainer.ts:166](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L166) ##### Returns @@ -164,7 +164,7 @@ list of module names > **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` -Defined in: [packages/common/src/config/ModuleContainer.ts:224](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L224) +Defined in: [packages/common/src/config/ModuleContainer.ts:224](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L224) #### Parameters @@ -182,7 +182,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:224](https://github.c > **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` -Defined in: [packages/common/src/config/ModuleContainer.ts:209](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L209) +Defined in: [packages/common/src/config/ModuleContainer.ts:209](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L209) Assert that the iterated `moduleName` is of ModuleName type, otherwise it may be just string e.g. when modules are iterated over @@ -204,7 +204,7 @@ using e.g. a for loop. > **configure**(`config`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:306](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L306) +Defined in: [packages/common/src/config/ModuleContainer.ts:306](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L306) Provide additional configuration after the ModuleContainer was created. @@ -228,7 +228,7 @@ before the first resolution. > **configurePartial**(`config`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:310](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L310) +Defined in: [packages/common/src/config/ModuleContainer.ts:310](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L310) #### Parameters @@ -246,7 +246,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:310](https://github.c > **create**(`childContainerProvider`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:479](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L479) +Defined in: [packages/common/src/config/ModuleContainer.ts:479](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L479) This is a placeholder for individual modules to override. This method will be called whenever the underlying container fully @@ -272,7 +272,7 @@ initialized > `protected` **decorateModule**(`moduleName`, `containedModule`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L364) +Defined in: [packages/common/src/config/ModuleContainer.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L364) Override this in the child class to provide custom features or module checks @@ -297,7 +297,7 @@ features or module checks > `protected` **initializeDependencyFactories**(`factories`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:389](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L389) +Defined in: [packages/common/src/config/ModuleContainer.ts:389](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L389) Inject a set of dependencies using the given list of DependencyFactories This method should be called during startup @@ -318,7 +318,7 @@ This method should be called during startup > **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` -Defined in: [packages/common/src/config/ModuleContainer.ts:217](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L217) +Defined in: [packages/common/src/config/ModuleContainer.ts:217](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L217) #### Parameters @@ -340,7 +340,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:217](https://github.c > `protected` **onAfterModuleResolution**(`moduleName`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:451](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L451) +Defined in: [packages/common/src/config/ModuleContainer.ts:451](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L451) Handle module resolution, e.g. by decorating resolved modules @@ -360,7 +360,7 @@ Handle module resolution, e.g. by decorating resolved modules > `protected` **registerAliases**(`originalToken`, `clas`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:232](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L232) +Defined in: [packages/common/src/config/ModuleContainer.ts:232](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L232) #### Parameters @@ -382,7 +382,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:232](https://github.c > `protected` **registerClasses**(`modules`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:288](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L288) +Defined in: [packages/common/src/config/ModuleContainer.ts:288](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L288) #### Parameters @@ -400,7 +400,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:288](https://github.c > `protected` **registerModules**(`modules`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:249](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L249) +Defined in: [packages/common/src/config/ModuleContainer.ts:249](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L249) Register modules into the current container, and registers a respective resolution hook in order to decorate the module @@ -422,7 +422,7 @@ upon/after resolution. > **registerValue**\<`Value`\>(`modules`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L282) +Defined in: [packages/common/src/config/ModuleContainer.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L282) Register a non-module value into the current container @@ -446,7 +446,7 @@ Register a non-module value into the current container > **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> -Defined in: [packages/common/src/config/ModuleContainer.ts:338](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L338) +Defined in: [packages/common/src/config/ModuleContainer.ts:338](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L338) Resolves a module from the current module container @@ -474,7 +474,7 @@ be any module instance, not the one specifically requested as argument. > **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` -Defined in: [packages/common/src/config/ModuleContainer.ts:346](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L346) +Defined in: [packages/common/src/config/ModuleContainer.ts:346](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L346) #### Type Parameters @@ -500,7 +500,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:346](https://github.c > `protected` **validateModule**(`moduleName`, `containedModule`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:177](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L177) +Defined in: [packages/common/src/config/ModuleContainer.ts:177](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L177) Check if the provided module satisfies the container requirements, such as only injecting other known modules. diff --git a/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md b/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md index 5104b8e..8a210a7 100644 --- a/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md +++ b/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md @@ -10,7 +10,7 @@ title: ProvableMethodExecutionContext # Class: ProvableMethodExecutionContext -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L48) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L48) Execution context used to wrap runtime module methods, allowing them to post relevant information (such as execution status) @@ -36,7 +36,7 @@ into the context without any unnecessary 'prop drilling'. > **id**: `string` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L49) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L49) *** @@ -44,7 +44,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **methods**: `string`[] = `[]` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L51) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L51) *** @@ -52,7 +52,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **result**: [`ProvableMethodExecutionResult`](ProvableMethodExecutionResult.md) -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L53) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L53) ## Accessors @@ -62,7 +62,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **get** **isFinished**(): `boolean` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L102) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L102) ##### Returns @@ -76,7 +76,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **get** **isTopLevel**(): `boolean` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L98) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L98) ##### Returns @@ -88,7 +88,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **afterMethod**(): `void` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L94) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L94) Removes the latest method from the execution context stack, keeping track of the amount of 'unfinished' methods. Allowing @@ -104,7 +104,7 @@ for the context to distinguish between top-level and nested method calls. > **beforeMethod**(`moduleName`, `methodName`, `args`): `void` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L74) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L74) 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. @@ -135,7 +135,7 @@ Name of the method being captured in the context > **clear**(): `void` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:119](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L119) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:119](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L119) Manually clears/resets the execution context @@ -149,7 +149,7 @@ Manually clears/resets the execution context > **current**(): `object` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L109) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L109) #### Returns @@ -171,7 +171,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **setProver**(`prover`): `void` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L64) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L64) Adds a method prover to the current execution context, which can be collected and ran asynchronously at a later point in time. diff --git a/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md b/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md index 7e3f32f..cc77a39 100644 --- a/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md +++ b/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md @@ -10,7 +10,7 @@ title: ProvableMethodExecutionResult # Class: ProvableMethodExecutionResult -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L16) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L16) ## Extended by @@ -32,7 +32,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > `optional` **args**: [`ArgumentTypes`](../type-aliases/ArgumentTypes.md) -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L21) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L21) *** @@ -40,7 +40,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > `optional` **methodName**: `string` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L19) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L19) *** @@ -48,7 +48,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > `optional` **moduleName**: `string` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L17) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L17) *** @@ -56,7 +56,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > `optional` **prover**: () => `Promise`\<`Proof`\<`unknown`, `unknown`\>\> -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L23) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L23) #### Returns @@ -68,7 +68,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **prove**\<`ProofType`\>(): `Promise`\<`ProofType`\> -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L25) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L25) #### Type Parameters diff --git a/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md b/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md index 9379d9a..08bf43b 100644 --- a/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md +++ b/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md @@ -10,7 +10,7 @@ title: ReplayingSingleUseEventEmitter # Class: ReplayingSingleUseEventEmitter\ -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L12) +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L12) Event Emitter variant that emits a certain event only once to a registered listener. Additionally, if a listener registers to a event that has already been emitted, it @@ -47,7 +47,7 @@ so we need to make sure they get notified as well in those cases. > **emitted**: `Partial`\<`Events`\> = `{}` -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L15) +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L15) *** @@ -55,7 +55,7 @@ Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:15](ht > `protected` `readonly` **listeners**: `ListenersHolder`\<`Events`\> = `{}` -Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L8) +Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L8) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/pr > `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` -Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L10) +Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L10) #### Parameters @@ -93,7 +93,7 @@ keyof `Events` > **emit**\<`Key`\>(`event`, ...`parameters`): `void` -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L17) +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L17) #### Type Parameters @@ -123,7 +123,7 @@ Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:17](ht > **off**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L45) +Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L45) Primitive .off() with identity comparison for now. Could be replaced by returning an id in .on() and using that. @@ -156,7 +156,7 @@ Could be replaced by returning an id in .on() and using that. > **on**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L33) +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L33) #### Type Parameters @@ -186,7 +186,7 @@ Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:33](ht > **onAll**(`listener`): `void` -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L26) +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L26) #### Parameters diff --git a/src/pages/docs/reference/common/classes/RollupMerkleTree.md b/src/pages/docs/reference/common/classes/RollupMerkleTree.md index 4a89f13..f870e9e 100644 --- a/src/pages/docs/reference/common/classes/RollupMerkleTree.md +++ b/src/pages/docs/reference/common/classes/RollupMerkleTree.md @@ -10,7 +10,7 @@ title: RollupMerkleTree # Class: RollupMerkleTree -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:344](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L344) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:344](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L344) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:344](https://github.c > **new RollupMerkleTree**(`store`): [`RollupMerkleTree`](RollupMerkleTree.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L85) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L85) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.co > `readonly` **leafCount**: `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L43) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L43) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.co > **store**: [`MerkleTreeStore`](../interfaces/MerkleTreeStore.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L42) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L42) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.co > `static` **EMPTY\_ROOT**: `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L92) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L92) #### Inherited from @@ -80,7 +80,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.co > `static` **HEIGHT**: `number` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L90) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L90) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.co > `static` **WITNESS**: [`TypedClass`](../type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L87) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L87) #### Type declaration @@ -116,7 +116,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.co > **get** `static` **leafCount**(): `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L94) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L94) ##### Returns @@ -132,7 +132,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.co > **assertIndexRange**(`index`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L45) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L45) #### Parameters @@ -154,7 +154,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.co > **fill**(`leaves`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L81) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L81) Fills all leaves of the tree. @@ -180,7 +180,7 @@ Values to fill the leaves with. > **getNode**(`level`, `index`): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L53) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L53) Returns a node which lives at a given index and level. @@ -214,7 +214,7 @@ The data of the node. > **getRoot**(): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L59) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L59) Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). @@ -234,7 +234,7 @@ The root of the Merkle Tree. > **getWitness**(`index`): [`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L75) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L75) Returns the witness (also known as [Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) @@ -264,7 +264,7 @@ The witness that belongs to the leaf. > **setLeaf**(`index`, `leaf`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L66) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L66) Sets the value of a leaf node at a given index to a given value. diff --git a/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md b/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md index 0937a8d..4649934 100644 --- a/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md +++ b/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md @@ -10,7 +10,7 @@ title: RollupMerkleTreeWitness # Class: RollupMerkleTreeWitness -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:345](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L345) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:345](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L345) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **isLeft**: `Bool`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L11) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L11) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.co > **path**: `Field`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L10) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L10) #### Inherited from @@ -121,7 +121,7 @@ the element of type `T` to put assertions on. > `static` **dummy**: () => [`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L88) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L88) #### Returns @@ -422,7 +422,7 @@ Convert provable type to a normal JS type. > **calculateIndex**(): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L28) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L28) Calculates the index of the leaf node that belongs to this Witness. @@ -442,7 +442,7 @@ Index of the leaf. > **calculateRoot**(`hash`): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L22) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L22) Calculates a root depending on the leaf value. @@ -468,7 +468,7 @@ The calculated root. > **checkMembership**(`root`, `key`, `value`): `Bool` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L30) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L30) #### Parameters @@ -498,7 +498,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.co > **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L32) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L32) #### Parameters @@ -528,7 +528,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.co > **height**(): `number` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L15) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L15) #### Returns @@ -544,7 +544,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.co > **toShortenedEntries**(): `string`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L38) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L38) #### Returns diff --git a/src/pages/docs/reference/common/classes/ZkProgrammable.md b/src/pages/docs/reference/common/classes/ZkProgrammable.md index 87e4d0e..2417bb0 100644 --- a/src/pages/docs/reference/common/classes/ZkProgrammable.md +++ b/src/pages/docs/reference/common/classes/ZkProgrammable.md @@ -10,7 +10,7 @@ title: ZkProgrammable # Class: `abstract` ZkProgrammable\ -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:99](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L99) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:99](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L99) ## Extended by @@ -42,7 +42,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:99](https://gi > **get** `abstract` **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:103](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L103) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:103](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L103) ##### Returns @@ -56,7 +56,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:103](https://g > **get** **zkProgram**(): [`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L113) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L113) ##### Returns @@ -68,7 +68,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:113](https://g > **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../interfaces/CompileArtifact.md)\>\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L130) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L130) #### Parameters @@ -86,7 +86,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:130](https://g > `abstract` **zkProgramFactory**(): [`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L105) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L105) #### Returns diff --git a/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md b/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md index 906d7a5..d8fac1d 100644 --- a/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md +++ b/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md @@ -12,7 +12,7 @@ title: assertValidTextLogLevel > **assertValidTextLogLevel**(`level`): `asserts level is LogLevelNames` -Defined in: [packages/common/src/log.ts:134](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/log.ts#L134) +Defined in: [packages/common/src/log.ts:134](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/log.ts#L134) ## Parameters diff --git a/src/pages/docs/reference/common/functions/compileToMockable.md b/src/pages/docs/reference/common/functions/compileToMockable.md index fe24bb1..d9eb256 100644 --- a/src/pages/docs/reference/common/functions/compileToMockable.md +++ b/src/pages/docs/reference/common/functions/compileToMockable.md @@ -12,7 +12,7 @@ title: compileToMockable > **compileToMockable**(`compile`, `__namedParameters`): () => `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L84) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L84) ## Parameters diff --git a/src/pages/docs/reference/common/functions/createMerkleTree.md b/src/pages/docs/reference/common/functions/createMerkleTree.md index f0d98ee..fbaaee4 100644 --- a/src/pages/docs/reference/common/functions/createMerkleTree.md +++ b/src/pages/docs/reference/common/functions/createMerkleTree.md @@ -12,7 +12,7 @@ title: createMerkleTree > **createMerkleTree**(`height`): [`AbstractMerkleTreeClass`](../interfaces/AbstractMerkleTreeClass.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:116](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L116) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:116](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L116) A [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree) is a binary tree in which every leaf is the cryptography hash of a piece of data, diff --git a/src/pages/docs/reference/common/functions/dummyValue.md b/src/pages/docs/reference/common/functions/dummyValue.md index c5976c1..e5a6980 100644 --- a/src/pages/docs/reference/common/functions/dummyValue.md +++ b/src/pages/docs/reference/common/functions/dummyValue.md @@ -12,7 +12,7 @@ title: dummyValue > **dummyValue**\<`Value`\>(`valueType`): `Value` -Defined in: [packages/common/src/utils.ts:93](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L93) +Defined in: [packages/common/src/utils.ts:93](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L93) Computes a dummy value for the given value type. diff --git a/src/pages/docs/reference/common/functions/expectDefined.md b/src/pages/docs/reference/common/functions/expectDefined.md index edc59ef..b62c95c 100644 --- a/src/pages/docs/reference/common/functions/expectDefined.md +++ b/src/pages/docs/reference/common/functions/expectDefined.md @@ -12,7 +12,7 @@ title: expectDefined > **expectDefined**\<`T`\>(`value`): `asserts value is T` -Defined in: [packages/common/src/utils.ts:165](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L165) +Defined in: [packages/common/src/utils.ts:165](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L165) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/filterNonNull.md b/src/pages/docs/reference/common/functions/filterNonNull.md index 67d6498..2eb93e7 100644 --- a/src/pages/docs/reference/common/functions/filterNonNull.md +++ b/src/pages/docs/reference/common/functions/filterNonNull.md @@ -12,7 +12,7 @@ title: filterNonNull > **filterNonNull**\<`Type`\>(`value`): `value is Type` -Defined in: [packages/common/src/utils.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L132) +Defined in: [packages/common/src/utils.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L132) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/filterNonUndefined.md b/src/pages/docs/reference/common/functions/filterNonUndefined.md index a385f61..dd7ff05 100644 --- a/src/pages/docs/reference/common/functions/filterNonUndefined.md +++ b/src/pages/docs/reference/common/functions/filterNonUndefined.md @@ -12,7 +12,7 @@ title: filterNonUndefined > **filterNonUndefined**\<`Type`\>(`value`): `value is Type` -Defined in: [packages/common/src/utils.ts:136](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L136) +Defined in: [packages/common/src/utils.ts:136](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L136) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/getInjectAliases.md b/src/pages/docs/reference/common/functions/getInjectAliases.md index 38ce23d..aff10ca 100644 --- a/src/pages/docs/reference/common/functions/getInjectAliases.md +++ b/src/pages/docs/reference/common/functions/getInjectAliases.md @@ -12,7 +12,7 @@ title: getInjectAliases > **getInjectAliases**(`target`): `string`[] -Defined in: [packages/common/src/config/injectAlias.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/injectAlias.ts#L63) +Defined in: [packages/common/src/config/injectAlias.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/injectAlias.ts#L63) ## Parameters diff --git a/src/pages/docs/reference/common/functions/hashWithPrefix.md b/src/pages/docs/reference/common/functions/hashWithPrefix.md index 1bebf12..fed6daa 100644 --- a/src/pages/docs/reference/common/functions/hashWithPrefix.md +++ b/src/pages/docs/reference/common/functions/hashWithPrefix.md @@ -12,7 +12,7 @@ title: hashWithPrefix > **hashWithPrefix**(`prefix`, `input`): `Field` -Defined in: [packages/common/src/utils.ts:154](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L154) +Defined in: [packages/common/src/utils.ts:154](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L154) ## Parameters diff --git a/src/pages/docs/reference/common/functions/implement.md b/src/pages/docs/reference/common/functions/implement.md index ab7637e..44c19e5 100644 --- a/src/pages/docs/reference/common/functions/implement.md +++ b/src/pages/docs/reference/common/functions/implement.md @@ -12,7 +12,7 @@ title: implement > **implement**\<`T`\>(`name`): (`target`) => `void` -Defined in: [packages/common/src/config/injectAlias.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/injectAlias.ts#L51) +Defined in: [packages/common/src/config/injectAlias.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/injectAlias.ts#L51) Marks the class to implement a certain interface T, while also attaching a DI-injection alias as metadata, that will be picked up by the ModuleContainer diff --git a/src/pages/docs/reference/common/functions/injectAlias.md b/src/pages/docs/reference/common/functions/injectAlias.md index fff7cee..d37b3a6 100644 --- a/src/pages/docs/reference/common/functions/injectAlias.md +++ b/src/pages/docs/reference/common/functions/injectAlias.md @@ -12,7 +12,7 @@ title: injectAlias > **injectAlias**(`aliases`): (`target`) => `void` -Defined in: [packages/common/src/config/injectAlias.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/injectAlias.ts#L11) +Defined in: [packages/common/src/config/injectAlias.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/injectAlias.ts#L11) Attaches metadata to the class that the ModuleContainer can pick up and inject this class in the DI container under the specified aliases. diff --git a/src/pages/docs/reference/common/functions/injectOptional.md b/src/pages/docs/reference/common/functions/injectOptional.md index b471c48..7351f75 100644 --- a/src/pages/docs/reference/common/functions/injectOptional.md +++ b/src/pages/docs/reference/common/functions/injectOptional.md @@ -12,7 +12,7 @@ title: injectOptional > **injectOptional**\<`T`\>(`token`): (`target`, `propertyKey`, `parameterIndex`) => `any` -Defined in: [packages/common/src/dependencyFactory/injectOptional.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/injectOptional.ts#L38) +Defined in: [packages/common/src/dependencyFactory/injectOptional.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/injectOptional.ts#L38) This function injects a dependency only if it has been registered, otherwise injects undefined. This can be useful for having optional dependencies, where diff --git a/src/pages/docs/reference/common/functions/isSubtypeOfName.md b/src/pages/docs/reference/common/functions/isSubtypeOfName.md index 83ae3a3..488dd09 100644 --- a/src/pages/docs/reference/common/functions/isSubtypeOfName.md +++ b/src/pages/docs/reference/common/functions/isSubtypeOfName.md @@ -12,7 +12,7 @@ title: isSubtypeOfName > **isSubtypeOfName**(`clas`, `name`): `boolean` -Defined in: [packages/common/src/utils.ts:181](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L181) +Defined in: [packages/common/src/utils.ts:181](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L181) Returns a boolean indicating whether a given class is a subclass of another class, indicated by the name parameter. diff --git a/src/pages/docs/reference/common/functions/mapSequential.md b/src/pages/docs/reference/common/functions/mapSequential.md index 527bce3..473070a 100644 --- a/src/pages/docs/reference/common/functions/mapSequential.md +++ b/src/pages/docs/reference/common/functions/mapSequential.md @@ -12,7 +12,7 @@ title: mapSequential > **mapSequential**\<`T`, `R`\>(`array`, `f`): `Promise`\<`R`[]\> -Defined in: [packages/common/src/utils.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L75) +Defined in: [packages/common/src/utils.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L75) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/noop.md b/src/pages/docs/reference/common/functions/noop.md index a4df4bf..1103d87 100644 --- a/src/pages/docs/reference/common/functions/noop.md +++ b/src/pages/docs/reference/common/functions/noop.md @@ -12,7 +12,7 @@ title: noop > **noop**(): `void` -Defined in: [packages/common/src/utils.ts:103](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L103) +Defined in: [packages/common/src/utils.ts:103](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L103) ## Returns diff --git a/src/pages/docs/reference/common/functions/prefixToField.md b/src/pages/docs/reference/common/functions/prefixToField.md index cae9ba2..0c2292b 100644 --- a/src/pages/docs/reference/common/functions/prefixToField.md +++ b/src/pages/docs/reference/common/functions/prefixToField.md @@ -12,7 +12,7 @@ title: prefixToField > **prefixToField**(`prefix`): `Field` -Defined in: [packages/common/src/utils.ts:145](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L145) +Defined in: [packages/common/src/utils.ts:145](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L145) ## Parameters diff --git a/src/pages/docs/reference/common/functions/provableMethod.md b/src/pages/docs/reference/common/functions/provableMethod.md index a9d4a5d..db76aac 100644 --- a/src/pages/docs/reference/common/functions/provableMethod.md +++ b/src/pages/docs/reference/common/functions/provableMethod.md @@ -12,7 +12,7 @@ title: provableMethod > **provableMethod**(`isFirstParameterPublicInput`, `executionContext`): \<`Target`\>(`target`, `methodName`, `descriptor`) => `TypedPropertyDescriptor`\<(...`args`) => `any`\> -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L70) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L70) Decorates a provable method on a 'prover class', depending on if proofs are enabled or not, either runs the respective zkProgram prover, diff --git a/src/pages/docs/reference/common/functions/range.md b/src/pages/docs/reference/common/functions/range.md index 6602c1c..f6a6409 100644 --- a/src/pages/docs/reference/common/functions/range.md +++ b/src/pages/docs/reference/common/functions/range.md @@ -12,7 +12,7 @@ title: range > **range**(`startOrEnd`, `endOrNothing`?): `number`[] -Defined in: [packages/common/src/utils.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L43) +Defined in: [packages/common/src/utils.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L43) ## Parameters diff --git a/src/pages/docs/reference/common/functions/reduceSequential.md b/src/pages/docs/reference/common/functions/reduceSequential.md index 77d4f0a..8400211 100644 --- a/src/pages/docs/reference/common/functions/reduceSequential.md +++ b/src/pages/docs/reference/common/functions/reduceSequential.md @@ -12,7 +12,7 @@ title: reduceSequential > **reduceSequential**\<`T`, `U`\>(`array`, `callbackfn`, `initialValue`): `Promise`\<`U`\> -Defined in: [packages/common/src/utils.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L56) +Defined in: [packages/common/src/utils.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L56) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/requireTrue.md b/src/pages/docs/reference/common/functions/requireTrue.md index 80596cf..90670e1 100644 --- a/src/pages/docs/reference/common/functions/requireTrue.md +++ b/src/pages/docs/reference/common/functions/requireTrue.md @@ -12,7 +12,7 @@ title: requireTrue > **requireTrue**(`condition`, `errorOrFunction`): `void` -Defined in: [packages/common/src/utils.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L11) +Defined in: [packages/common/src/utils.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L11) ## Parameters diff --git a/src/pages/docs/reference/common/functions/safeParseJson.md b/src/pages/docs/reference/common/functions/safeParseJson.md index 1dc5d0a..52f7b61 100644 --- a/src/pages/docs/reference/common/functions/safeParseJson.md +++ b/src/pages/docs/reference/common/functions/safeParseJson.md @@ -12,7 +12,7 @@ title: safeParseJson > **safeParseJson**\<`T`\>(`json`): `T` -Defined in: [packages/common/src/utils.ts:197](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L197) +Defined in: [packages/common/src/utils.ts:197](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L197) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/sleep.md b/src/pages/docs/reference/common/functions/sleep.md index 2a582cd..6409a8a 100644 --- a/src/pages/docs/reference/common/functions/sleep.md +++ b/src/pages/docs/reference/common/functions/sleep.md @@ -12,7 +12,7 @@ title: sleep > **sleep**(`ms`): `Promise`\<`void`\> -Defined in: [packages/common/src/utils.ts:126](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L126) +Defined in: [packages/common/src/utils.ts:126](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L126) ## Parameters diff --git a/src/pages/docs/reference/common/functions/splitArray.md b/src/pages/docs/reference/common/functions/splitArray.md index 15d91d5..fd44893 100644 --- a/src/pages/docs/reference/common/functions/splitArray.md +++ b/src/pages/docs/reference/common/functions/splitArray.md @@ -12,7 +12,7 @@ title: splitArray > **splitArray**\<`T`, `K`\>(`arr`, `split`): `Record`\<`K`, `T`[] \| `undefined`\> -Defined in: [packages/common/src/utils.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L26) +Defined in: [packages/common/src/utils.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L26) Utility function to split an array of type T into a record based on a function T => K that determines the key of each record diff --git a/src/pages/docs/reference/common/functions/toProver.md b/src/pages/docs/reference/common/functions/toProver.md index 5040f5f..13504a2 100644 --- a/src/pages/docs/reference/common/functions/toProver.md +++ b/src/pages/docs/reference/common/functions/toProver.md @@ -12,7 +12,7 @@ title: toProver > **toProver**(`methodName`, `simulatedMethod`, `isFirstParameterPublicInput`, ...`args`): (`this`) => `Promise`\<`Proof`\<`any`, `any`\>\> -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L20) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L20) ## Parameters diff --git a/src/pages/docs/reference/common/functions/verifyToMockable.md b/src/pages/docs/reference/common/functions/verifyToMockable.md index 9e04f3f..485ac24 100644 --- a/src/pages/docs/reference/common/functions/verifyToMockable.md +++ b/src/pages/docs/reference/common/functions/verifyToMockable.md @@ -12,7 +12,7 @@ title: verifyToMockable > **verifyToMockable**\<`PublicInput`, `PublicOutput`\>(`verify`, `__namedParameters`): (`proof`) => `Promise`\<`boolean`\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L59) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L59) ## Type Parameters diff --git a/src/pages/docs/reference/common/globals.md b/src/pages/docs/reference/common/globals.md new file mode 100644 index 0000000..3775e10 --- /dev/null +++ b/src/pages/docs/reference/common/globals.md @@ -0,0 +1,136 @@ +--- +title: "@proto-kit/common" +--- + +[**@proto-kit/common**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/common + +# @proto-kit/common + +## Classes + +- [AtomicCompileHelper](classes/AtomicCompileHelper.md) +- [ChildVerificationKeyService](classes/ChildVerificationKeyService.md) +- [CompileRegistry](classes/CompileRegistry.md) +- [ConfigurableModule](classes/ConfigurableModule.md) +- [EventEmitter](classes/EventEmitter.md) +- [EventEmitterProxy](classes/EventEmitterProxy.md) +- [InMemoryMerkleTreeStorage](classes/InMemoryMerkleTreeStorage.md) +- [MockAsyncMerkleTreeStore](classes/MockAsyncMerkleTreeStore.md) +- [ModuleContainer](classes/ModuleContainer.md) +- [ProvableMethodExecutionContext](classes/ProvableMethodExecutionContext.md) +- [ProvableMethodExecutionResult](classes/ProvableMethodExecutionResult.md) +- [ReplayingSingleUseEventEmitter](classes/ReplayingSingleUseEventEmitter.md) +- [RollupMerkleTree](classes/RollupMerkleTree.md) +- [RollupMerkleTreeWitness](classes/RollupMerkleTreeWitness.md) +- [ZkProgrammable](classes/ZkProgrammable.md) + +## Interfaces + +- [AbstractMerkleTree](interfaces/AbstractMerkleTree.md) +- [AbstractMerkleTreeClass](interfaces/AbstractMerkleTreeClass.md) +- [AbstractMerkleWitness](interfaces/AbstractMerkleWitness.md) +- [AreProofsEnabled](interfaces/AreProofsEnabled.md) +- [BaseModuleInstanceType](interfaces/BaseModuleInstanceType.md) +- [ChildContainerCreatable](interfaces/ChildContainerCreatable.md) +- [ChildContainerProvider](interfaces/ChildContainerProvider.md) +- [CompilableModule](interfaces/CompilableModule.md) +- [Compile](interfaces/Compile.md) +- [CompileArtifact](interfaces/CompileArtifact.md) +- [Configurable](interfaces/Configurable.md) +- [DependencyFactory](interfaces/DependencyFactory.md) +- [EventEmittingComponent](interfaces/EventEmittingComponent.md) +- [EventEmittingContainer](interfaces/EventEmittingContainer.md) +- [MerkleTreeStore](interfaces/MerkleTreeStore.md) +- [ModuleContainerDefinition](interfaces/ModuleContainerDefinition.md) +- [ModulesRecord](interfaces/ModulesRecord.md) +- [PlainZkProgram](interfaces/PlainZkProgram.md) +- [StaticConfigurableModule](interfaces/StaticConfigurableModule.md) +- [ToFieldable](interfaces/ToFieldable.md) +- [ToFieldableStatic](interfaces/ToFieldableStatic.md) +- [ToJSONableStatic](interfaces/ToJSONableStatic.md) +- [Verify](interfaces/Verify.md) +- [WithZkProgrammable](interfaces/WithZkProgrammable.md) + +## Type Aliases + +- [ArgumentTypes](type-aliases/ArgumentTypes.md) +- [ArrayElement](type-aliases/ArrayElement.md) +- [ArtifactRecord](type-aliases/ArtifactRecord.md) +- [BaseModuleType](type-aliases/BaseModuleType.md) +- [CapitalizeAny](type-aliases/CapitalizeAny.md) +- [CastToEventsRecord](type-aliases/CastToEventsRecord.md) +- [CompileTarget](type-aliases/CompileTarget.md) +- [ContainerEvents](type-aliases/ContainerEvents.md) +- [DecoratedMethod](type-aliases/DecoratedMethod.md) +- [DependenciesFromModules](type-aliases/DependenciesFromModules.md) +- [DependencyDeclaration](type-aliases/DependencyDeclaration.md) +- [DependencyRecord](type-aliases/DependencyRecord.md) +- [EventListenable](type-aliases/EventListenable.md) +- [EventsRecord](type-aliases/EventsRecord.md) +- [FilterNeverValues](type-aliases/FilterNeverValues.md) +- [FlattenedContainerEvents](type-aliases/FlattenedContainerEvents.md) +- [FlattenObject](type-aliases/FlattenObject.md) +- [InferDependencies](type-aliases/InferDependencies.md) +- [InferProofBase](type-aliases/InferProofBase.md) +- [MapDependencyRecordToTypes](type-aliases/MapDependencyRecordToTypes.md) +- [MergeObjects](type-aliases/MergeObjects.md) +- [ModuleEvents](type-aliases/ModuleEvents.md) +- [ModulesConfig](type-aliases/ModulesConfig.md) +- [NoConfig](type-aliases/NoConfig.md) +- [NonMethods](type-aliases/NonMethods.md) +- [O1JSPrimitive](type-aliases/O1JSPrimitive.md) +- [OmitKeys](type-aliases/OmitKeys.md) +- [OverwriteObjectType](type-aliases/OverwriteObjectType.md) +- [Preset](type-aliases/Preset.md) +- [Presets](type-aliases/Presets.md) +- [ProofTypes](type-aliases/ProofTypes.md) +- [RecursivePartial](type-aliases/RecursivePartial.md) +- [ResolvableModules](type-aliases/ResolvableModules.md) +- [StringKeyOf](type-aliases/StringKeyOf.md) +- [TypedClass](type-aliases/TypedClass.md) +- [TypeFromDependencyDeclaration](type-aliases/TypeFromDependencyDeclaration.md) +- [UnionToIntersection](type-aliases/UnionToIntersection.md) +- [UnTypedClass](type-aliases/UnTypedClass.md) + +## Variables + +- [EMPTY\_PUBLICKEY](variables/EMPTY_PUBLICKEY.md) +- [EMPTY\_PUBLICKEY\_X](variables/EMPTY_PUBLICKEY_X.md) +- [injectAliasMetadataKey](variables/injectAliasMetadataKey.md) +- [log](variables/log.md) +- [MAX\_FIELD](variables/MAX_FIELD.md) +- [MOCK\_PROOF](variables/MOCK_PROOF.md) +- [MOCK\_VERIFICATION\_KEY](variables/MOCK_VERIFICATION_KEY.md) +- [ModuleContainerErrors](variables/ModuleContainerErrors.md) + +## Functions + +- [assertValidTextLogLevel](functions/assertValidTextLogLevel.md) +- [compileToMockable](functions/compileToMockable.md) +- [createMerkleTree](functions/createMerkleTree.md) +- [dummyValue](functions/dummyValue.md) +- [expectDefined](functions/expectDefined.md) +- [filterNonNull](functions/filterNonNull.md) +- [filterNonUndefined](functions/filterNonUndefined.md) +- [getInjectAliases](functions/getInjectAliases.md) +- [hashWithPrefix](functions/hashWithPrefix.md) +- [implement](functions/implement.md) +- [injectAlias](functions/injectAlias.md) +- [injectOptional](functions/injectOptional.md) +- [isSubtypeOfName](functions/isSubtypeOfName.md) +- [mapSequential](functions/mapSequential.md) +- [noop](functions/noop.md) +- [prefixToField](functions/prefixToField.md) +- [provableMethod](functions/provableMethod.md) +- [range](functions/range.md) +- [reduceSequential](functions/reduceSequential.md) +- [requireTrue](functions/requireTrue.md) +- [safeParseJson](functions/safeParseJson.md) +- [sleep](functions/sleep.md) +- [splitArray](functions/splitArray.md) +- [toProver](functions/toProver.md) +- [verifyToMockable](functions/verifyToMockable.md) diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md index f6aca64..91495b2 100644 --- a/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md +++ b/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md @@ -10,7 +10,7 @@ title: AbstractMerkleTree # Interface: AbstractMerkleTree -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L41) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L41) ## Extended by @@ -26,7 +26,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:41](https://github.co > `readonly` **leafCount**: `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L43) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L43) *** @@ -34,7 +34,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.co > **store**: [`MerkleTreeStore`](MerkleTreeStore.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L42) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L42) ## Methods @@ -42,7 +42,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.co > **assertIndexRange**(`index`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L45) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L45) #### Parameters @@ -60,7 +60,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.co > **fill**(`leaves`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L81) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L81) Fills all leaves of the tree. @@ -82,7 +82,7 @@ Values to fill the leaves with. > **getNode**(`level`, `index`): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L53) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L53) Returns a node which lives at a given index and level. @@ -112,7 +112,7 @@ The data of the node. > **getRoot**(): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L59) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L59) Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). @@ -128,7 +128,7 @@ The root of the Merkle Tree. > **getWitness**(`index`): [`AbstractMerkleWitness`](AbstractMerkleWitness.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L75) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L75) Returns the witness (also known as [Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) @@ -154,7 +154,7 @@ The witness that belongs to the leaf. > **setLeaf**(`index`, `leaf`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L66) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L66) Sets the value of a leaf node at a given index to a given value. diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md index 1cad3c5..e654a08 100644 --- a/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md +++ b/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md @@ -10,7 +10,7 @@ title: AbstractMerkleTreeClass # Interface: AbstractMerkleTreeClass -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L84) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L84) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:84](https://github.co > **new AbstractMerkleTreeClass**(`store`): [`AbstractMerkleTree`](AbstractMerkleTree.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L85) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L85) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.co > **EMPTY\_ROOT**: `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L92) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L92) *** @@ -44,7 +44,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.co > **HEIGHT**: `number` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L90) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L90) *** @@ -52,7 +52,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.co > **WITNESS**: [`TypedClass`](../type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L87) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L87) #### Type declaration @@ -72,7 +72,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.co > **get** **leafCount**(): `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L94) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L94) ##### Returns diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md index 563f681..fe2c72b 100644 --- a/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md +++ b/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md @@ -10,7 +10,7 @@ title: AbstractMerkleWitness # Interface: AbstractMerkleWitness -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L14) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L14) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:14](https://github.co > **isLeft**: `Bool`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L11) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L11) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.co > **path**: `Field`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L10) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L10) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.co > **calculateIndex**(): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L28) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L28) Calculates the index of the leaf node that belongs to this Witness. @@ -62,7 +62,7 @@ Index of the leaf. > **calculateRoot**(`hash`): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L22) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L22) Calculates a root depending on the leaf value. @@ -84,7 +84,7 @@ The calculated root. > **checkMembership**(`root`, `key`, `value`): `Bool` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L30) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L30) #### Parameters @@ -110,7 +110,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.co > **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L32) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L32) #### Parameters @@ -136,7 +136,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.co > **height**(): `number` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L15) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L15) #### Returns @@ -148,7 +148,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.co > **toShortenedEntries**(): `string`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/RollupMerkleTree.ts#L38) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L38) #### Returns diff --git a/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md b/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md index 7940daf..513503c 100644 --- a/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md +++ b/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md @@ -10,7 +10,7 @@ title: AreProofsEnabled # Interface: AreProofsEnabled -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L23) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L23) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:23](https://gi > **areProofsEnabled**: `boolean` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L24) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L24) *** @@ -26,7 +26,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:24](https://gi > **setProofsEnabled**: (`areProofsEnabled`) => `void` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L25) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L25) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md b/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md index fe5a0d9..c74466d 100644 --- a/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md +++ b/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md @@ -10,7 +10,7 @@ title: BaseModuleInstanceType # Interface: BaseModuleInstanceType -Defined in: [packages/common/src/config/ModuleContainer.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L73) +Defined in: [packages/common/src/config/ModuleContainer.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L73) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:73](https://github.co > **config**: `unknown` -Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L19) +Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L19) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github > **create**: (`childContainerProvider`) => `void` -Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ChildContainerCreatable.ts#L4) +Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ChildContainerCreatable.ts#L4) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md b/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md index e5b249d..94a75b3 100644 --- a/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md +++ b/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md @@ -10,7 +10,7 @@ title: ChildContainerCreatable # Interface: ChildContainerCreatable -Defined in: [packages/common/src/config/ChildContainerCreatable.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ChildContainerCreatable.ts#L3) +Defined in: [packages/common/src/config/ChildContainerCreatable.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ChildContainerCreatable.ts#L3) ## Extended by @@ -22,7 +22,7 @@ Defined in: [packages/common/src/config/ChildContainerCreatable.ts:3](https://gi > **create**: (`childContainerProvider`) => `void` -Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ChildContainerCreatable.ts#L4) +Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ChildContainerCreatable.ts#L4) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md b/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md index d551400..5468650 100644 --- a/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md +++ b/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md @@ -10,11 +10,11 @@ title: ChildContainerProvider # Interface: ChildContainerProvider() -Defined in: [packages/common/src/config/ChildContainerProvider.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ChildContainerProvider.ts#L3) +Defined in: [packages/common/src/config/ChildContainerProvider.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ChildContainerProvider.ts#L3) > **ChildContainerProvider**(): `DependencyContainer` -Defined in: [packages/common/src/config/ChildContainerProvider.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ChildContainerProvider.ts#L4) +Defined in: [packages/common/src/config/ChildContainerProvider.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ChildContainerProvider.ts#L4) ## Returns diff --git a/src/pages/docs/reference/common/interfaces/CompilableModule.md b/src/pages/docs/reference/common/interfaces/CompilableModule.md index 65f1749..0eb61fe 100644 --- a/src/pages/docs/reference/common/interfaces/CompilableModule.md +++ b/src/pages/docs/reference/common/interfaces/CompilableModule.md @@ -10,7 +10,7 @@ title: CompilableModule # Interface: CompilableModule -Defined in: [packages/common/src/compiling/CompilableModule.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompilableModule.ts#L4) +Defined in: [packages/common/src/compiling/CompilableModule.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompilableModule.ts#L4) ## Extended by @@ -23,7 +23,7 @@ Defined in: [packages/common/src/compiling/CompilableModule.ts:4](https://github > **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../type-aliases/ArtifactRecord.md)\> -Defined in: [packages/common/src/compiling/CompilableModule.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/CompilableModule.ts#L5) +Defined in: [packages/common/src/compiling/CompilableModule.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompilableModule.ts#L5) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/Compile.md b/src/pages/docs/reference/common/interfaces/Compile.md index cecf1f1..58c2008 100644 --- a/src/pages/docs/reference/common/interfaces/Compile.md +++ b/src/pages/docs/reference/common/interfaces/Compile.md @@ -10,11 +10,11 @@ title: Compile # Interface: Compile() -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L32) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L32) > **Compile**(): `Promise`\<[`CompileArtifact`](CompileArtifact.md)\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L33) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L33) ## Returns diff --git a/src/pages/docs/reference/common/interfaces/CompileArtifact.md b/src/pages/docs/reference/common/interfaces/CompileArtifact.md index c846d2d..255c3fa 100644 --- a/src/pages/docs/reference/common/interfaces/CompileArtifact.md +++ b/src/pages/docs/reference/common/interfaces/CompileArtifact.md @@ -10,7 +10,7 @@ title: CompileArtifact # Interface: CompileArtifact -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L16) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L16) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:16](https://gi > **verificationKey**: `object` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L17) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L17) #### data diff --git a/src/pages/docs/reference/common/interfaces/Configurable.md b/src/pages/docs/reference/common/interfaces/Configurable.md index ec9a656..4a56958 100644 --- a/src/pages/docs/reference/common/interfaces/Configurable.md +++ b/src/pages/docs/reference/common/interfaces/Configurable.md @@ -10,7 +10,7 @@ title: Configurable # Interface: Configurable\ -Defined in: [packages/common/src/config/ConfigurableModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L18) +Defined in: [packages/common/src/config/ConfigurableModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L18) ## Extended by @@ -26,4 +26,4 @@ Defined in: [packages/common/src/config/ConfigurableModule.ts:18](https://github > **config**: `Config` -Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L19) +Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L19) diff --git a/src/pages/docs/reference/common/interfaces/DependencyFactory.md b/src/pages/docs/reference/common/interfaces/DependencyFactory.md index 595a7fc..14b17d1 100644 --- a/src/pages/docs/reference/common/interfaces/DependencyFactory.md +++ b/src/pages/docs/reference/common/interfaces/DependencyFactory.md @@ -10,7 +10,7 @@ title: DependencyFactory # Interface: DependencyFactory -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L34) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L34) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -34,7 +34,7 @@ deps that are necessary for the sequencer to work. > **dependencies**: () => [`DependencyRecord`](../type-aliases/DependencyRecord.md) -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L35) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L35) #### Returns diff --git a/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md b/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md index 34af92b..ff34064 100644 --- a/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md +++ b/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md @@ -10,7 +10,7 @@ title: EventEmittingComponent # Interface: EventEmittingComponent\ -Defined in: [packages/common/src/events/EventEmittingComponent.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmittingComponent.ts#L5) +Defined in: [packages/common/src/events/EventEmittingComponent.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmittingComponent.ts#L5) ## Extended by @@ -26,4 +26,4 @@ Defined in: [packages/common/src/events/EventEmittingComponent.ts:5](https://git > **events**: [`EventEmitter`](../classes/EventEmitter.md)\<`Events`\> -Defined in: [packages/common/src/events/EventEmittingComponent.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmittingComponent.ts#L6) +Defined in: [packages/common/src/events/EventEmittingComponent.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmittingComponent.ts#L6) diff --git a/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md b/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md index 79e8610..eccdfac 100644 --- a/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md +++ b/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md @@ -10,7 +10,7 @@ title: EventEmittingContainer # Interface: EventEmittingContainer\ -Defined in: [packages/common/src/events/EventEmittingComponent.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmittingComponent.ts#L9) +Defined in: [packages/common/src/events/EventEmittingComponent.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmittingComponent.ts#L9) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [packages/common/src/events/EventEmittingComponent.ts:9](https://git > **containerEvents**: [`EventEmitter`](../classes/EventEmitter.md)\<`Events`\> -Defined in: [packages/common/src/events/EventEmittingComponent.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmittingComponent.ts#L10) +Defined in: [packages/common/src/events/EventEmittingComponent.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmittingComponent.ts#L10) diff --git a/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md b/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md index fafc74f..2272515 100644 --- a/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md +++ b/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md @@ -10,7 +10,7 @@ title: MerkleTreeStore # Interface: MerkleTreeStore -Defined in: [packages/common/src/trees/MerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MerkleTreeStore.ts#L1) +Defined in: [packages/common/src/trees/MerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MerkleTreeStore.ts#L1) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/trees/MerkleTreeStore.ts:1](https://github.com/ > **getNode**: (`key`, `level`) => `undefined` \| `bigint` -Defined in: [packages/common/src/trees/MerkleTreeStore.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MerkleTreeStore.ts#L4) +Defined in: [packages/common/src/trees/MerkleTreeStore.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MerkleTreeStore.ts#L4) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/common/src/trees/MerkleTreeStore.ts:4](https://github.com/ > **setNode**: (`key`, `level`, `value`) => `void` -Defined in: [packages/common/src/trees/MerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/trees/MerkleTreeStore.ts#L2) +Defined in: [packages/common/src/trees/MerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MerkleTreeStore.ts#L2) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md b/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md index 7c5225a..9072730 100644 --- a/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md +++ b/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md @@ -10,7 +10,7 @@ title: ModuleContainerDefinition # Interface: ModuleContainerDefinition\ -Defined in: [packages/common/src/config/ModuleContainer.ts:115](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L115) +Defined in: [packages/common/src/config/ModuleContainer.ts:115](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L115) Parameters required when creating a module container instance @@ -24,7 +24,7 @@ Parameters required when creating a module container instance > `optional` **config**: [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:121](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L121) +Defined in: [packages/common/src/config/ModuleContainer.ts:121](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L121) #### Deprecated @@ -34,4 +34,4 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:121](https://github.c > **modules**: `Modules` -Defined in: [packages/common/src/config/ModuleContainer.ts:116](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L116) +Defined in: [packages/common/src/config/ModuleContainer.ts:116](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L116) diff --git a/src/pages/docs/reference/common/interfaces/ModulesRecord.md b/src/pages/docs/reference/common/interfaces/ModulesRecord.md index 241e6e2..6f4a136 100644 --- a/src/pages/docs/reference/common/interfaces/ModulesRecord.md +++ b/src/pages/docs/reference/common/interfaces/ModulesRecord.md @@ -10,7 +10,7 @@ title: ModulesRecord # Interface: ModulesRecord\ -Defined in: [packages/common/src/config/ModuleContainer.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L81) +Defined in: [packages/common/src/config/ModuleContainer.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L81) ## Type Parameters diff --git a/src/pages/docs/reference/common/interfaces/PlainZkProgram.md b/src/pages/docs/reference/common/interfaces/PlainZkProgram.md index eb3e93e..5c77368 100644 --- a/src/pages/docs/reference/common/interfaces/PlainZkProgram.md +++ b/src/pages/docs/reference/common/interfaces/PlainZkProgram.md @@ -10,7 +10,7 @@ title: PlainZkProgram # Interface: PlainZkProgram\ -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L36) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L36) ## Type Parameters @@ -24,7 +24,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:36](https://gi > **analyzeMethods**: () => `Promise`\<`Record`\<`string`, \{ `digest`: `string`; `gates`: `Gate`[]; `publicInputSize`: `number`; `rows`: `number`; `print`: `void`; `summary`: `Partial`\<`Record`\<`GateType` \| `"Total rows"`, `number`\>\>; \}\>\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L54) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L54) #### Returns @@ -36,7 +36,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:54](https://gi > **compile**: [`Compile`](Compile.md) -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L38) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L38) *** @@ -44,7 +44,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:38](https://gi > **methods**: `Record`\<`string`, (...`args`) => `Promise`\<`Proof`\<`PublicInput`, `PublicOutput`\>\> \| (`publicInput`, ...`args`) => `Promise`\<`Proof`\<`PublicInput`, `PublicOutput`\>\>\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L46) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L46) *** @@ -52,7 +52,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:46](https://gi > **name**: `string` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L37) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L37) *** @@ -60,7 +60,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:37](https://gi > **Proof**: (`__namedParameters`) => `object` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L40) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L40) #### Parameters @@ -234,4 +234,4 @@ must match your ZkProgram. `maxProofsVerified` is the maximum number of proofs t > **verify**: [`Verify`](Verify.md)\<`PublicInput`, `PublicOutput`\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L39) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L39) diff --git a/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md b/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md index 1c64742..718692b 100644 --- a/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md +++ b/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md @@ -10,7 +10,7 @@ title: StaticConfigurableModule # Interface: StaticConfigurableModule\ -Defined in: [packages/common/src/config/ConfigurableModule.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L55) +Defined in: [packages/common/src/config/ConfigurableModule.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L55) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [packages/common/src/config/ConfigurableModule.ts:55](https://github > **presets**: [`Presets`](../type-aliases/Presets.md)\<`Config`\> -Defined in: [packages/common/src/config/ConfigurableModule.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L56) +Defined in: [packages/common/src/config/ConfigurableModule.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L56) diff --git a/src/pages/docs/reference/common/interfaces/ToFieldable.md b/src/pages/docs/reference/common/interfaces/ToFieldable.md index 8f100df..9f442be 100644 --- a/src/pages/docs/reference/common/interfaces/ToFieldable.md +++ b/src/pages/docs/reference/common/interfaces/ToFieldable.md @@ -10,7 +10,7 @@ title: ToFieldable # Interface: ToFieldable -Defined in: [packages/common/src/utils.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L105) +Defined in: [packages/common/src/utils.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L105) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/utils.ts:105](https://github.com/proto-kit/fram > **toFields**: () => `Field`[] -Defined in: [packages/common/src/utils.ts:106](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L106) +Defined in: [packages/common/src/utils.ts:106](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L106) #### Returns diff --git a/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md b/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md index d648aa4..81c4b8e 100644 --- a/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md +++ b/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md @@ -10,7 +10,7 @@ title: ToFieldableStatic # Interface: ToFieldableStatic -Defined in: [packages/common/src/utils.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L109) +Defined in: [packages/common/src/utils.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L109) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/utils.ts:109](https://github.com/proto-kit/fram > **toFields**: (`value`) => `Field`[] -Defined in: [packages/common/src/utils.ts:110](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L110) +Defined in: [packages/common/src/utils.ts:110](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L110) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md b/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md index 72af933..f47addd 100644 --- a/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md +++ b/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md @@ -10,7 +10,7 @@ title: ToJSONableStatic # Interface: ToJSONableStatic -Defined in: [packages/common/src/utils.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L113) +Defined in: [packages/common/src/utils.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L113) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/utils.ts:113](https://github.com/proto-kit/fram > **toJSON**: (`value`) => `any` -Defined in: [packages/common/src/utils.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L114) +Defined in: [packages/common/src/utils.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L114) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/Verify.md b/src/pages/docs/reference/common/interfaces/Verify.md index 4181ea9..f312f88 100644 --- a/src/pages/docs/reference/common/interfaces/Verify.md +++ b/src/pages/docs/reference/common/interfaces/Verify.md @@ -10,7 +10,7 @@ title: Verify # Interface: Verify()\ -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L28) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L28) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:28](https://gi > **Verify**(`proof`): `Promise`\<`boolean`\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L29) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L29) ## Parameters diff --git a/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md b/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md index 1bcb362..4bcafe7 100644 --- a/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md +++ b/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md @@ -10,7 +10,7 @@ title: WithZkProgrammable # Interface: WithZkProgrammable\ -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:146](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L146) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:146](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L146) ## Extended by @@ -30,4 +30,4 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:146](https://g > **zkProgrammable**: [`ZkProgrammable`](../classes/ZkProgrammable.md)\<`PublicInput`, `PublicOutput`\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:150](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L150) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:150](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L150) diff --git a/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md b/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md index 3b61341..4473998 100644 --- a/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md +++ b/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md @@ -12,4 +12,4 @@ title: ArgumentTypes > **ArgumentTypes**: ([`O1JSPrimitive`](O1JSPrimitive.md) \| `Proof`\<`unknown`, `unknown`\> \| `DynamicProof`\<`unknown`, `unknown`\>)[] -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L9) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L9) diff --git a/src/pages/docs/reference/common/type-aliases/ArrayElement.md b/src/pages/docs/reference/common/type-aliases/ArrayElement.md index 9d1f063..22b7726 100644 --- a/src/pages/docs/reference/common/type-aliases/ArrayElement.md +++ b/src/pages/docs/reference/common/type-aliases/ArrayElement.md @@ -12,7 +12,7 @@ title: ArrayElement > **ArrayElement**\<`ArrayType`\>: `ArrayType` *extends* readonly infer ElementType[] ? `ElementType` : `never` -Defined in: [packages/common/src/types.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L18) +Defined in: [packages/common/src/types.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L18) Utility type to infer element type from an array type diff --git a/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md b/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md index a85410d..363b552 100644 --- a/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md +++ b/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md @@ -12,4 +12,4 @@ title: ArtifactRecord > **ArtifactRecord**: `Record`\<`string`, [`CompileArtifact`](../interfaces/CompileArtifact.md)\> -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/AtomicCompileHelper.ts#L10) +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/AtomicCompileHelper.ts#L10) diff --git a/src/pages/docs/reference/common/type-aliases/BaseModuleType.md b/src/pages/docs/reference/common/type-aliases/BaseModuleType.md index f4e7bdd..4389249 100644 --- a/src/pages/docs/reference/common/type-aliases/BaseModuleType.md +++ b/src/pages/docs/reference/common/type-aliases/BaseModuleType.md @@ -12,4 +12,4 @@ title: BaseModuleType > **BaseModuleType**: [`TypedClass`](TypedClass.md)\<[`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md)\> -Defined in: [packages/common/src/config/ModuleContainer.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L78) +Defined in: [packages/common/src/config/ModuleContainer.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L78) diff --git a/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md b/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md index 909eb29..d24d635 100644 --- a/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md +++ b/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md @@ -12,7 +12,7 @@ title: CapitalizeAny > **CapitalizeAny**\<`Key`\>: `Key` *extends* `string` ? `Capitalize`\<`Key`\> : `Key` -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L45) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L45) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md b/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md index 9ced49a..602814f 100644 --- a/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md +++ b/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md @@ -12,7 +12,7 @@ title: CastToEventsRecord > **CastToEventsRecord**\<`Record`\>: `Record` *extends* [`EventsRecord`](EventsRecord.md) ? `Record` : `object` -Defined in: [packages/common/src/events/EventEmitterProxy.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L15) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L15) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/CompileTarget.md b/src/pages/docs/reference/common/type-aliases/CompileTarget.md index 0869f4d..3da3a67 100644 --- a/src/pages/docs/reference/common/type-aliases/CompileTarget.md +++ b/src/pages/docs/reference/common/type-aliases/CompileTarget.md @@ -12,7 +12,7 @@ title: CompileTarget > **CompileTarget**: `object` -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/compiling/AtomicCompileHelper.ts#L12) +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/AtomicCompileHelper.ts#L12) ## Type declaration diff --git a/src/pages/docs/reference/common/type-aliases/ContainerEvents.md b/src/pages/docs/reference/common/type-aliases/ContainerEvents.md index 31230a4..60d6843 100644 --- a/src/pages/docs/reference/common/type-aliases/ContainerEvents.md +++ b/src/pages/docs/reference/common/type-aliases/ContainerEvents.md @@ -12,7 +12,7 @@ title: ContainerEvents > **ContainerEvents**\<`Modules`\>: `{ [Key in StringKeyOf]: ModuleEvents }` -Defined in: [packages/common/src/events/EventEmitterProxy.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L32) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L32) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md b/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md index beb95cb..e7d3374 100644 --- a/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md +++ b/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md @@ -12,7 +12,7 @@ title: DecoratedMethod > **DecoratedMethod**: (...`args`) => `Promise`\<`unknown`\> -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L15) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L15) ## Parameters diff --git a/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md b/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md index ca269e8..6556377 100644 --- a/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md +++ b/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md @@ -12,7 +12,7 @@ title: DependenciesFromModules > **DependenciesFromModules**\<`Modules`\>: [`FilterNeverValues`](FilterNeverValues.md)\<`{ [Key in keyof Modules]: Modules[Key] extends TypedClass ? InferDependencies> : never }`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L129) +Defined in: [packages/common/src/config/ModuleContainer.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L129) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md b/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md index c5faa9f..0e50601 100644 --- a/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md +++ b/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md @@ -12,7 +12,7 @@ title: DependencyDeclaration > **DependencyDeclaration**\<`Dependency`\>: `ClassProvider`\<`Dependency`\> \| `FactoryProvider`\<`Dependency`\> \| `TokenProvider`\<`Dependency`\> \| `ValueProvider`\<`Dependency`\> -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L11) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L11) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/DependencyRecord.md b/src/pages/docs/reference/common/type-aliases/DependencyRecord.md index 4416504..fa84fea 100644 --- a/src/pages/docs/reference/common/type-aliases/DependencyRecord.md +++ b/src/pages/docs/reference/common/type-aliases/DependencyRecord.md @@ -12,4 +12,4 @@ title: DependencyRecord > **DependencyRecord**: `Record`\<`string`, [`DependencyDeclaration`](DependencyDeclaration.md)\<`unknown`\> & `object`\> -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L17) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L17) diff --git a/src/pages/docs/reference/common/type-aliases/EventListenable.md b/src/pages/docs/reference/common/type-aliases/EventListenable.md index be416a5..0eb7889 100644 --- a/src/pages/docs/reference/common/type-aliases/EventListenable.md +++ b/src/pages/docs/reference/common/type-aliases/EventListenable.md @@ -12,7 +12,7 @@ title: EventListenable > **EventListenable**\<`Events`\>: `Pick`\<[`EventEmitter`](../classes/EventEmitter.md)\<`Events`\>, `"on"` \| `"onAll"` \| `"off"`\> -Defined in: [packages/common/src/events/EventEmitter.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitter.ts#L58) +Defined in: [packages/common/src/events/EventEmitter.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L58) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/EventsRecord.md b/src/pages/docs/reference/common/type-aliases/EventsRecord.md index 2559ad2..46bd682 100644 --- a/src/pages/docs/reference/common/type-aliases/EventsRecord.md +++ b/src/pages/docs/reference/common/type-aliases/EventsRecord.md @@ -12,4 +12,4 @@ title: EventsRecord > **EventsRecord**: `Record`\<`string`, `unknown`[]\> -Defined in: [packages/common/src/events/EventEmittingComponent.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmittingComponent.ts#L3) +Defined in: [packages/common/src/events/EventEmittingComponent.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmittingComponent.ts#L3) diff --git a/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md b/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md index 5005f54..c60e388 100644 --- a/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md +++ b/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md @@ -12,7 +12,7 @@ title: FilterNeverValues > **FilterNeverValues**\<`Type`\>: `{ [Key in keyof Type as Type[Key] extends never ? never : Key]: Type[Key] }` -Defined in: [packages/common/src/config/ModuleContainer.ts:125](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L125) +Defined in: [packages/common/src/config/ModuleContainer.ts:125](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L125) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/FlattenObject.md b/src/pages/docs/reference/common/type-aliases/FlattenObject.md index 9991c5c..3e69548 100644 --- a/src/pages/docs/reference/common/type-aliases/FlattenObject.md +++ b/src/pages/docs/reference/common/type-aliases/FlattenObject.md @@ -12,7 +12,7 @@ title: FlattenObject > **FlattenObject**\<`Target`\>: [`UnionToIntersection`](UnionToIntersection.md)\<`Target`\[keyof `Target`\]\> -Defined in: [packages/common/src/events/EventEmitterProxy.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L36) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L36) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md b/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md index a0f4e31..dcf3a98 100644 --- a/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md +++ b/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md @@ -12,7 +12,7 @@ title: FlattenedContainerEvents > **FlattenedContainerEvents**\<`Modules`\>: [`FlattenObject`](FlattenObject.md)\<[`ContainerEvents`](ContainerEvents.md)\<`Modules`\>\> -Defined in: [packages/common/src/events/EventEmitterProxy.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L39) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L39) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/InferDependencies.md b/src/pages/docs/reference/common/type-aliases/InferDependencies.md index c7e851c..22b3b26 100644 --- a/src/pages/docs/reference/common/type-aliases/InferDependencies.md +++ b/src/pages/docs/reference/common/type-aliases/InferDependencies.md @@ -12,7 +12,7 @@ title: InferDependencies > **InferDependencies**\<`Class`\>: `Class` *extends* [`DependencyFactory`](../interfaces/DependencyFactory.md) ? [`MapDependencyRecordToTypes`](MapDependencyRecordToTypes.md)\<`ReturnType`\<`Class`\[`"dependencies"`\]\>\> : `never` -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L54) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L54) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/InferProofBase.md b/src/pages/docs/reference/common/type-aliases/InferProofBase.md index 4e9926d..178ea69 100644 --- a/src/pages/docs/reference/common/type-aliases/InferProofBase.md +++ b/src/pages/docs/reference/common/type-aliases/InferProofBase.md @@ -12,7 +12,7 @@ title: InferProofBase > **InferProofBase**\<`ProofType`\>: `ProofType` *extends* `Proof`\ ? `ProofBase`\<`PI`, `PO`\> : `ProofType` *extends* `DynamicProof`\ ? `ProofBase`\<`PI`, `PO`\> : `undefined` -Defined in: [packages/common/src/types.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L51) +Defined in: [packages/common/src/types.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L51) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md b/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md index ac0a8fa..757f4d7 100644 --- a/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md +++ b/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md @@ -12,7 +12,7 @@ title: MapDependencyRecordToTypes > **MapDependencyRecordToTypes**\<`Record`\>: `{ [Key in keyof Record as CapitalizeAny]: TypedClass> }` -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L48) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L48) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/MergeObjects.md b/src/pages/docs/reference/common/type-aliases/MergeObjects.md index 4656568..e04ece1 100644 --- a/src/pages/docs/reference/common/type-aliases/MergeObjects.md +++ b/src/pages/docs/reference/common/type-aliases/MergeObjects.md @@ -12,7 +12,7 @@ title: MergeObjects > **MergeObjects**\<`Input`\>: [`UnionToIntersection`](UnionToIntersection.md)\<`Input`\[keyof `Input`\]\> -Defined in: [packages/common/src/types.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L30) +Defined in: [packages/common/src/types.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L30) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/ModuleEvents.md b/src/pages/docs/reference/common/type-aliases/ModuleEvents.md index 509b063..ea63f4d 100644 --- a/src/pages/docs/reference/common/type-aliases/ModuleEvents.md +++ b/src/pages/docs/reference/common/type-aliases/ModuleEvents.md @@ -12,7 +12,7 @@ title: ModuleEvents > **ModuleEvents**\<`ModuleType`\>: `InstanceType`\<`ModuleType`\> *extends* [`EventEmittingComponent`](../interfaces/EventEmittingComponent.md)\ ? `Events` : `InstanceType`\<`ModuleType`\> *extends* [`ModuleContainer`](../classes/ModuleContainer.md)\ ? [`CastToEventsRecord`](CastToEventsRecord.md)\<[`ContainerEvents`](ContainerEvents.md)\<`NestedModules`\>\> : [`EventsRecord`](EventsRecord.md) -Defined in: [packages/common/src/events/EventEmitterProxy.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/events/EventEmitterProxy.ts#L19) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L19) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/ModulesConfig.md b/src/pages/docs/reference/common/type-aliases/ModulesConfig.md index d91582b..9e50e44 100644 --- a/src/pages/docs/reference/common/type-aliases/ModulesConfig.md +++ b/src/pages/docs/reference/common/type-aliases/ModulesConfig.md @@ -12,7 +12,7 @@ title: ModulesConfig > **ModulesConfig**\<`Modules`\>: \{ \[ConfigKey in StringKeyOf\\]: InstanceType\ extends Configurable\ ? Config extends NoConfig ? Config \| undefined : Config : never \} -Defined in: [packages/common/src/config/ModuleContainer.ts:89](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L89) +Defined in: [packages/common/src/config/ModuleContainer.ts:89](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L89) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/NoConfig.md b/src/pages/docs/reference/common/type-aliases/NoConfig.md index db54b32..ca91c5a 100644 --- a/src/pages/docs/reference/common/type-aliases/NoConfig.md +++ b/src/pages/docs/reference/common/type-aliases/NoConfig.md @@ -12,4 +12,4 @@ title: NoConfig > **NoConfig**: `Record`\<`never`, `never`\> -Defined in: [packages/common/src/config/ConfigurableModule.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L22) +Defined in: [packages/common/src/config/ConfigurableModule.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L22) diff --git a/src/pages/docs/reference/common/type-aliases/NonMethods.md b/src/pages/docs/reference/common/type-aliases/NonMethods.md index e77a3f0..cc3e15f 100644 --- a/src/pages/docs/reference/common/type-aliases/NonMethods.md +++ b/src/pages/docs/reference/common/type-aliases/NonMethods.md @@ -12,7 +12,7 @@ title: NonMethods > **NonMethods**\<`Type`\>: `Pick`\<`Type`, `NonMethodKeys`\<`Type`\>\> -Defined in: [packages/common/src/utils.ts:172](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L172) +Defined in: [packages/common/src/utils.ts:172](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L172) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md b/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md index 9aae968..68b716b 100644 --- a/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md +++ b/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md @@ -12,4 +12,4 @@ title: O1JSPrimitive > **O1JSPrimitive**: `object` \| `string` \| `boolean` \| `number` -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L8) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L8) diff --git a/src/pages/docs/reference/common/type-aliases/OmitKeys.md b/src/pages/docs/reference/common/type-aliases/OmitKeys.md index c838b9d..3769dfe 100644 --- a/src/pages/docs/reference/common/type-aliases/OmitKeys.md +++ b/src/pages/docs/reference/common/type-aliases/OmitKeys.md @@ -12,7 +12,7 @@ title: OmitKeys > **OmitKeys**\<`Record`, `Keys`\>: `{ [Key in keyof Record as Key extends Keys ? never : Key]: Record[Key] }` -Defined in: [packages/common/src/types.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L33) +Defined in: [packages/common/src/types.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L33) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md b/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md index 0b5b6d9..7efb4f6 100644 --- a/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md +++ b/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md @@ -12,7 +12,7 @@ title: OverwriteObjectType > **OverwriteObjectType**\<`Base`, `New`\>: `{ [Key in keyof Base]: Key extends keyof New ? New[Key] : Base[Key] }` & `New` -Defined in: [packages/common/src/types.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L47) +Defined in: [packages/common/src/types.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L47) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/Preset.md b/src/pages/docs/reference/common/type-aliases/Preset.md index 1f87a1e..d63cddb 100644 --- a/src/pages/docs/reference/common/type-aliases/Preset.md +++ b/src/pages/docs/reference/common/type-aliases/Preset.md @@ -12,7 +12,7 @@ title: Preset > **Preset**\<`Config`\>: `Config` \| (...`args`) => `Config` -Defined in: [packages/common/src/config/ConfigurableModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L14) +Defined in: [packages/common/src/config/ConfigurableModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L14) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/Presets.md b/src/pages/docs/reference/common/type-aliases/Presets.md index 360af15..5c97b3a 100644 --- a/src/pages/docs/reference/common/type-aliases/Presets.md +++ b/src/pages/docs/reference/common/type-aliases/Presets.md @@ -12,7 +12,7 @@ title: Presets > **Presets**\<`Config`\>: `Record`\<`string`, [`Preset`](Preset.md)\<`Config`\>\> -Defined in: [packages/common/src/config/ConfigurableModule.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ConfigurableModule.ts#L15) +Defined in: [packages/common/src/config/ConfigurableModule.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L15) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/ProofTypes.md b/src/pages/docs/reference/common/type-aliases/ProofTypes.md index 465214f..b4fc4d9 100644 --- a/src/pages/docs/reference/common/type-aliases/ProofTypes.md +++ b/src/pages/docs/reference/common/type-aliases/ProofTypes.md @@ -12,4 +12,4 @@ title: ProofTypes > **ProofTypes**: *typeof* `Proof` \| *typeof* `DynamicProof` -Defined in: [packages/common/src/utils.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L122) +Defined in: [packages/common/src/utils.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L122) diff --git a/src/pages/docs/reference/common/type-aliases/RecursivePartial.md b/src/pages/docs/reference/common/type-aliases/RecursivePartial.md index 2cc6551..1ec4988 100644 --- a/src/pages/docs/reference/common/type-aliases/RecursivePartial.md +++ b/src/pages/docs/reference/common/type-aliases/RecursivePartial.md @@ -12,7 +12,7 @@ title: RecursivePartial > **RecursivePartial**\<`T`\>: `{ [Key in keyof T]?: Partial }` -Defined in: [packages/common/src/config/ModuleContainer.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L108) +Defined in: [packages/common/src/config/ModuleContainer.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L108) This type make any config partial (i.e. optional) up to the first level So { Module: { a: { b: string } } } diff --git a/src/pages/docs/reference/common/type-aliases/ResolvableModules.md b/src/pages/docs/reference/common/type-aliases/ResolvableModules.md index b2c643f..640ffb9 100644 --- a/src/pages/docs/reference/common/type-aliases/ResolvableModules.md +++ b/src/pages/docs/reference/common/type-aliases/ResolvableModules.md @@ -12,7 +12,7 @@ title: ResolvableModules > **ResolvableModules**\<`Modules`\>: [`MergeObjects`](MergeObjects.md)\<[`DependenciesFromModules`](DependenciesFromModules.md)\<`Modules`\>\> & `Modules` -Defined in: [packages/common/src/config/ModuleContainer.ts:136](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L136) +Defined in: [packages/common/src/config/ModuleContainer.ts:136](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L136) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/StringKeyOf.md b/src/pages/docs/reference/common/type-aliases/StringKeyOf.md index ea59082..3b6b6cf 100644 --- a/src/pages/docs/reference/common/type-aliases/StringKeyOf.md +++ b/src/pages/docs/reference/common/type-aliases/StringKeyOf.md @@ -12,7 +12,7 @@ title: StringKeyOf > **StringKeyOf**\<`Target`\>: `Extract`\ & `string` -Defined in: [packages/common/src/types.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L12) +Defined in: [packages/common/src/types.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L12) Using simple `keyof Target` would result into the key being `string | number | symbol`, but we want just a `string` diff --git a/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md b/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md index ae866f6..0f88c4c 100644 --- a/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md +++ b/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md @@ -12,7 +12,7 @@ title: TypeFromDependencyDeclaration > **TypeFromDependencyDeclaration**\<`Declaration`\>: `Declaration` *extends* [`DependencyDeclaration`](DependencyDeclaration.md)\ ? `Dependency` : `never` -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/dependencyFactory/DependencyFactory.ts#L38) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L38) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/TypedClass.md b/src/pages/docs/reference/common/type-aliases/TypedClass.md index afcf49d..5e746f9 100644 --- a/src/pages/docs/reference/common/type-aliases/TypedClass.md +++ b/src/pages/docs/reference/common/type-aliases/TypedClass.md @@ -12,7 +12,7 @@ title: TypedClass > **TypedClass**\<`Class`\>: (...`args`) => `Class` -Defined in: [packages/common/src/types.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L4) +Defined in: [packages/common/src/types.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L4) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/UnTypedClass.md b/src/pages/docs/reference/common/type-aliases/UnTypedClass.md index 833d3f2..ee7e664 100644 --- a/src/pages/docs/reference/common/type-aliases/UnTypedClass.md +++ b/src/pages/docs/reference/common/type-aliases/UnTypedClass.md @@ -12,7 +12,7 @@ title: UnTypedClass > **UnTypedClass**: (...`args`) => `unknown` -Defined in: [packages/common/src/types.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L6) +Defined in: [packages/common/src/types.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L6) ## Parameters diff --git a/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md b/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md index 824e107..f00ab64 100644 --- a/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md +++ b/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md @@ -12,7 +12,7 @@ title: UnionToIntersection > **UnionToIntersection**\<`Union`\>: `Union` *extends* `any` ? (`x`) => `void` : `never` *extends* (`x`) => `void` ? `Intersection` : `never` -Defined in: [packages/common/src/types.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L24) +Defined in: [packages/common/src/types.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L24) Transforms X | Y => X & Y diff --git a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md index f7036d4..f918c17 100644 --- a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md +++ b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md @@ -12,4 +12,4 @@ title: EMPTY_PUBLICKEY > `const` **EMPTY\_PUBLICKEY**: `PublicKey` -Defined in: [packages/common/src/types.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L42) +Defined in: [packages/common/src/types.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L42) diff --git a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md index d5991a6..465563f 100644 --- a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md +++ b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md @@ -12,4 +12,4 @@ title: EMPTY_PUBLICKEY_X > `const` **EMPTY\_PUBLICKEY\_X**: `Field` -Defined in: [packages/common/src/types.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/types.ts#L41) +Defined in: [packages/common/src/types.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L41) diff --git a/src/pages/docs/reference/common/variables/MAX_FIELD.md b/src/pages/docs/reference/common/variables/MAX_FIELD.md index 65571ae..bf52ad0 100644 --- a/src/pages/docs/reference/common/variables/MAX_FIELD.md +++ b/src/pages/docs/reference/common/variables/MAX_FIELD.md @@ -12,4 +12,4 @@ title: MAX_FIELD > `const` **MAX\_FIELD**: `Field` -Defined in: [packages/common/src/utils.ts:174](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/utils.ts#L174) +Defined in: [packages/common/src/utils.ts:174](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L174) diff --git a/src/pages/docs/reference/common/variables/MOCK_PROOF.md b/src/pages/docs/reference/common/variables/MOCK_PROOF.md index acc0c92..f156cf5 100644 --- a/src/pages/docs/reference/common/variables/MOCK_PROOF.md +++ b/src/pages/docs/reference/common/variables/MOCK_PROOF.md @@ -12,4 +12,4 @@ title: MOCK_PROOF > `const` **MOCK\_PROOF**: `"mock-proof"` = `"mock-proof"` -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/provableMethod.ts#L17) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L17) diff --git a/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md b/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md index 66ec3cb..2e16fcf 100644 --- a/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md +++ b/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md @@ -12,4 +12,4 @@ title: MOCK_VERIFICATION_KEY > `const` **MOCK\_VERIFICATION\_KEY**: `VerificationKey` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/zkProgrammable/ZkProgrammable.ts#L82) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L82) diff --git a/src/pages/docs/reference/common/variables/ModuleContainerErrors.md b/src/pages/docs/reference/common/variables/ModuleContainerErrors.md index 267a3ff..42f465b 100644 --- a/src/pages/docs/reference/common/variables/ModuleContainerErrors.md +++ b/src/pages/docs/reference/common/variables/ModuleContainerErrors.md @@ -12,7 +12,7 @@ title: ModuleContainerErrors > `const` **ModuleContainerErrors**: `object` = `errors` -Defined in: [packages/common/src/config/ModuleContainer.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/ModuleContainer.ts#L71) +Defined in: [packages/common/src/config/ModuleContainer.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L71) ## Type declaration diff --git a/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md b/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md index b0e5e05..891c4c7 100644 --- a/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md +++ b/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md @@ -12,4 +12,4 @@ title: injectAliasMetadataKey > `const` **injectAliasMetadataKey**: `"protokit-inject-alias"` = `"protokit-inject-alias"` -Defined in: [packages/common/src/config/injectAlias.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/config/injectAlias.ts#L3) +Defined in: [packages/common/src/config/injectAlias.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/injectAlias.ts#L3) diff --git a/src/pages/docs/reference/common/variables/log.md b/src/pages/docs/reference/common/variables/log.md index 4f85542..b65ae40 100644 --- a/src/pages/docs/reference/common/variables/log.md +++ b/src/pages/docs/reference/common/variables/log.md @@ -12,7 +12,7 @@ title: log > `const` **log**: `object` -Defined in: [packages/common/src/log.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/common/src/log.ts#L53) +Defined in: [packages/common/src/log.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/log.ts#L53) ## Type declaration diff --git a/src/pages/docs/reference/deployment/classes/BullQueue.md b/src/pages/docs/reference/deployment/classes/BullQueue.md index 9444b36..6bd6b83 100644 --- a/src/pages/docs/reference/deployment/classes/BullQueue.md +++ b/src/pages/docs/reference/deployment/classes/BullQueue.md @@ -10,7 +10,7 @@ title: BullQueue # Class: BullQueue -Defined in: [deployment/src/queue/BullQueue.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L29) +Defined in: [deployment/src/queue/BullQueue.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L29) TaskQueue implementation for BullMQ @@ -116,7 +116,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **close**(): `Promise`\<`void`\> -Defined in: [deployment/src/queue/BullQueue.ts:107](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L107) +Defined in: [deployment/src/queue/BullQueue.ts:107](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L107) #### Returns @@ -196,7 +196,7 @@ Defined in: sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:5 > **createWorker**(`name`, `executor`, `options`?): [`Closeable`](../../sequencer/interfaces/Closeable.md) -Defined in: [deployment/src/queue/BullQueue.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L35) +Defined in: [deployment/src/queue/BullQueue.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L35) #### Parameters @@ -228,7 +228,7 @@ Defined in: [deployment/src/queue/BullQueue.ts:35](https://github.com/proto-kit/ > **getQueue**(`queueName`): `Promise`\<[`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md)\> -Defined in: [deployment/src/queue/BullQueue.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L88) +Defined in: [deployment/src/queue/BullQueue.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L88) #### Parameters @@ -250,7 +250,7 @@ Defined in: [deployment/src/queue/BullQueue.ts:88](https://github.com/proto-kit/ > **start**(): `Promise`\<`void`\> -Defined in: [deployment/src/queue/BullQueue.ts:103](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L103) +Defined in: [deployment/src/queue/BullQueue.ts:103](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L103) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/deployment/classes/Environment.md b/src/pages/docs/reference/deployment/classes/Environment.md index 97fff3b..ca322a0 100644 --- a/src/pages/docs/reference/deployment/classes/Environment.md +++ b/src/pages/docs/reference/deployment/classes/Environment.md @@ -10,7 +10,7 @@ title: Environment # Class: Environment\ -Defined in: [deployment/src/environment/Environment.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L12) +Defined in: [deployment/src/environment/Environment.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L12) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [deployment/src/environment/Environment.ts:12](https://github.com/pr > **new Environment**\<`T`\>(`configurations`): [`Environment`](Environment.md)\<`T`\> -Defined in: [deployment/src/environment/Environment.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L13) +Defined in: [deployment/src/environment/Environment.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L13) #### Parameters @@ -40,7 +40,7 @@ Defined in: [deployment/src/environment/Environment.ts:13](https://github.com/pr > **getConfiguration**(`configurationName`): `T` -Defined in: [deployment/src/environment/Environment.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L31) +Defined in: [deployment/src/environment/Environment.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L31) #### Parameters @@ -58,7 +58,7 @@ Defined in: [deployment/src/environment/Environment.ts:31](https://github.com/pr > **hasConfiguration**(`configurationName`): `configurationName is string` -Defined in: [deployment/src/environment/Environment.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L17) +Defined in: [deployment/src/environment/Environment.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L17) #### Parameters @@ -76,7 +76,7 @@ Defined in: [deployment/src/environment/Environment.ts:17](https://github.com/pr > **start**(): `Promise`\<`void`\> -Defined in: [deployment/src/environment/Environment.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L42) +Defined in: [deployment/src/environment/Environment.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L42) #### Returns @@ -88,7 +88,7 @@ Defined in: [deployment/src/environment/Environment.ts:42](https://github.com/pr > `static` **from**\<`T`\>(`configurations`): [`Environment`](Environment.md)\<`T`\> -Defined in: [deployment/src/environment/Environment.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L36) +Defined in: [deployment/src/environment/Environment.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L36) #### Type Parameters diff --git a/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md b/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md index 7d52f0a..dd5e7d6 100644 --- a/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md +++ b/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md @@ -10,7 +10,7 @@ title: BullQueueConfig # Interface: BullQueueConfig -Defined in: [deployment/src/queue/BullQueue.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L14) +Defined in: [deployment/src/queue/BullQueue.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L14) ## Properties @@ -18,7 +18,7 @@ Defined in: [deployment/src/queue/BullQueue.ts:14](https://github.com/proto-kit/ > **redis**: `object` -Defined in: [deployment/src/queue/BullQueue.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L15) +Defined in: [deployment/src/queue/BullQueue.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L15) #### db? @@ -46,4 +46,4 @@ Defined in: [deployment/src/queue/BullQueue.ts:15](https://github.com/proto-kit/ > `optional` **retryAttempts**: `number` -Defined in: [deployment/src/queue/BullQueue.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/queue/BullQueue.ts#L22) +Defined in: [deployment/src/queue/BullQueue.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L22) diff --git a/src/pages/docs/reference/deployment/interfaces/Startable.md b/src/pages/docs/reference/deployment/interfaces/Startable.md index 8630d81..167638e 100644 --- a/src/pages/docs/reference/deployment/interfaces/Startable.md +++ b/src/pages/docs/reference/deployment/interfaces/Startable.md @@ -10,7 +10,7 @@ title: Startable # Interface: Startable -Defined in: [deployment/src/environment/Environment.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L6) +Defined in: [deployment/src/environment/Environment.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L6) ## Methods @@ -18,7 +18,7 @@ Defined in: [deployment/src/environment/Environment.ts:6](https://github.com/pro > **start**(): `Promise`\<`void`\> -Defined in: [deployment/src/environment/Environment.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L7) +Defined in: [deployment/src/environment/Environment.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L7) #### Returns diff --git a/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md b/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md index 89d33de..7246ae9 100644 --- a/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md +++ b/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md @@ -12,7 +12,7 @@ title: StartableEnvironment > **StartableEnvironment**\<`T`\>: `Record`\<`string`, `T`\> -Defined in: [deployment/src/environment/Environment.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/deployment/src/environment/Environment.ts#L10) +Defined in: [deployment/src/environment/Environment.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L10) ## Type Parameters diff --git a/src/pages/docs/reference/indexer/_meta.tsx b/src/pages/docs/reference/indexer/_meta.tsx index a31554d..b6944c5 100644 --- a/src/pages/docs/reference/indexer/_meta.tsx +++ b/src/pages/docs/reference/indexer/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" + "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases" }; \ No newline at end of file diff --git a/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md b/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md index 030fb9f..bd1add4 100644 --- a/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md +++ b/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md @@ -10,7 +10,7 @@ title: GeneratedResolverFactoryGraphqlModule # Class: GeneratedResolverFactoryGraphqlModule -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L83) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L83) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new GeneratedResolverFactoryGraphqlModule**(`graphqlServer`): [`GeneratedResolverFactoryGraphqlModule`](GeneratedResolverFactoryGraphqlModule.md) -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L84) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L84) #### Parameters @@ -61,7 +61,7 @@ checks when retrieving it via the getter > **graphqlServer**: [`GraphqlServer`](../../api/classes/GraphqlServer.md) -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L85) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L85) ## Accessors @@ -125,7 +125,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **initializePrismaClient**(): `Promise`\<`PrismaClient`\<`never`\>\> -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:90](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L90) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:90](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L90) #### Returns @@ -137,7 +137,7 @@ Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:90](https: > **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:101](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L101) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:101](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L101) #### Returns diff --git a/src/pages/docs/reference/indexer/classes/IndexBlockTask.md b/src/pages/docs/reference/indexer/classes/IndexBlockTask.md index 2131636..b40517f 100644 --- a/src/pages/docs/reference/indexer/classes/IndexBlockTask.md +++ b/src/pages/docs/reference/indexer/classes/IndexBlockTask.md @@ -10,7 +10,7 @@ title: IndexBlockTask # Class: IndexBlockTask -Defined in: [indexer/src/tasks/IndexBlockTask.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L16) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L16) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new IndexBlockTask**(`taskSerializer`, `blockStorage`): [`IndexBlockTask`](IndexBlockTask.md) -Defined in: [indexer/src/tasks/IndexBlockTask.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L22) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L22) #### Parameters @@ -54,7 +54,7 @@ Defined in: [indexer/src/tasks/IndexBlockTask.ts:22](https://github.com/proto-ki > **blockStorage**: [`BlockQueue`](../../sequencer/interfaces/BlockQueue.md) -Defined in: [indexer/src/tasks/IndexBlockTask.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L25) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L25) *** @@ -77,7 +77,7 @@ checks when retrieving it via the getter > **name**: `string` = `"index-block"` -Defined in: [indexer/src/tasks/IndexBlockTask.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L20) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L20) #### Implementation of @@ -89,7 +89,7 @@ Defined in: [indexer/src/tasks/IndexBlockTask.ts:20](https://github.com/proto-ki > **taskSerializer**: [`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) -Defined in: [indexer/src/tasks/IndexBlockTask.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L23) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L23) ## Accessors @@ -131,7 +131,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<`void`\> -Defined in: [indexer/src/tasks/IndexBlockTask.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L33) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L33) #### Parameters @@ -175,7 +175,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md)\> -Defined in: [indexer/src/tasks/IndexBlockTask.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L45) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L45) #### Returns @@ -191,7 +191,7 @@ Defined in: [indexer/src/tasks/IndexBlockTask.ts:45](https://github.com/proto-ki > **prepare**(): `Promise`\<`void`\> -Defined in: [indexer/src/tasks/IndexBlockTask.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L31) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L31) #### Returns @@ -207,7 +207,7 @@ Defined in: [indexer/src/tasks/IndexBlockTask.ts:31](https://github.com/proto-ki > **resultSerializer**(): [`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<`void`\> -Defined in: [indexer/src/tasks/IndexBlockTask.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTask.ts#L49) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L49) #### Returns diff --git a/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md b/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md index 6abbe04..e4aea8b 100644 --- a/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md +++ b/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md @@ -10,7 +10,7 @@ title: IndexBlockTaskParametersSerializer # Class: IndexBlockTaskParametersSerializer -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L12) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L12) ## Constructors @@ -18,7 +18,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:12](https://github.co > **new IndexBlockTaskParametersSerializer**(`blockMapper`, `blockResultMapper`, `transactionResultMapper`): [`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L13) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L13) #### Parameters @@ -44,7 +44,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:13](https://github.co > **blockMapper**: [`BlockMapper`](../../persistance/classes/BlockMapper.md) -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L14) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L14) *** @@ -52,7 +52,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:14](https://github.co > **blockResultMapper**: [`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L15) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L15) *** @@ -60,7 +60,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:15](https://github.co > **transactionResultMapper**: [`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L16) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L16) ## Methods @@ -68,7 +68,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:16](https://github.co > **fromJSON**(`json`): [`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md) -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L29) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L29) #### Parameters @@ -86,7 +86,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:29](https://github.co > **toJSON**(`parameters`): `string` -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L19) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L19) #### Parameters diff --git a/src/pages/docs/reference/indexer/classes/Indexer.md b/src/pages/docs/reference/indexer/classes/Indexer.md index c975983..966217a 100644 --- a/src/pages/docs/reference/indexer/classes/Indexer.md +++ b/src/pages/docs/reference/indexer/classes/Indexer.md @@ -10,7 +10,7 @@ title: Indexer # Class: Indexer\ -Defined in: [indexer/src/Indexer.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/Indexer.ts#L15) +Defined in: [indexer/src/Indexer.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/Indexer.ts#L15) Reusable module container facilitating registration, resolution configuration, decoration and validation of modules @@ -170,7 +170,7 @@ list of module names > **get** **taskQueue**(): `InstanceType`\<`Modules`\[`"TaskQueue"`\]\> -Defined in: [indexer/src/Indexer.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/Indexer.ts#L24) +Defined in: [indexer/src/Indexer.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/Indexer.ts#L24) ##### Returns @@ -574,7 +574,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [indexer/src/Indexer.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/Indexer.ts#L28) +Defined in: [indexer/src/Indexer.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/Indexer.ts#L28) #### Returns @@ -615,7 +615,7 @@ such as only injecting other known modules. > `static` **from**\<`Modules`\>(`definition`): [`Indexer`](Indexer.md)\<`Modules`\> -Defined in: [indexer/src/Indexer.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/Indexer.ts#L18) +Defined in: [indexer/src/Indexer.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/Indexer.ts#L18) #### Type Parameters diff --git a/src/pages/docs/reference/indexer/classes/IndexerModule.md b/src/pages/docs/reference/indexer/classes/IndexerModule.md index 207c352..34e802c 100644 --- a/src/pages/docs/reference/indexer/classes/IndexerModule.md +++ b/src/pages/docs/reference/indexer/classes/IndexerModule.md @@ -10,7 +10,7 @@ title: IndexerModule # Class: `abstract` IndexerModule\ -Defined in: [indexer/src/IndexerModule.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerModule.ts#L3) +Defined in: [indexer/src/IndexerModule.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerModule.ts#L3) Used by various module sub-types that may need to be configured @@ -113,7 +113,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > `abstract` **start**(): `Promise`\<`void`\> -Defined in: [indexer/src/IndexerModule.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerModule.ts#L4) +Defined in: [indexer/src/IndexerModule.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerModule.ts#L4) #### Returns diff --git a/src/pages/docs/reference/indexer/classes/IndexerNotifier.md b/src/pages/docs/reference/indexer/classes/IndexerNotifier.md index eb57d2d..9e04122 100644 --- a/src/pages/docs/reference/indexer/classes/IndexerNotifier.md +++ b/src/pages/docs/reference/indexer/classes/IndexerNotifier.md @@ -10,7 +10,7 @@ title: IndexerNotifier # Class: IndexerNotifier -Defined in: [indexer/src/IndexerNotifier.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L19) +Defined in: [indexer/src/IndexerNotifier.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L19) Lifecycle of a SequencerModule @@ -26,7 +26,7 @@ start(): Executed to execute any logic required to start the module > **new IndexerNotifier**(`sequencer`, `taskQueue`, `indexBlockTask`): [`IndexerNotifier`](IndexerNotifier.md) -Defined in: [indexer/src/IndexerNotifier.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L20) +Defined in: [indexer/src/IndexerNotifier.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L20) #### Parameters @@ -71,7 +71,7 @@ checks when retrieving it via the getter > **indexBlockTask**: [`IndexBlockTask`](IndexBlockTask.md) -Defined in: [indexer/src/IndexerNotifier.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L25) +Defined in: [indexer/src/IndexerNotifier.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L25) *** @@ -79,7 +79,7 @@ Defined in: [indexer/src/IndexerNotifier.ts:25](https://github.com/proto-kit/fra > **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`NotifierMandatorySequencerModules`](../type-aliases/NotifierMandatorySequencerModules.md)\> -Defined in: [indexer/src/IndexerNotifier.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L22) +Defined in: [indexer/src/IndexerNotifier.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L22) *** @@ -87,7 +87,7 @@ Defined in: [indexer/src/IndexerNotifier.ts:22](https://github.com/proto-kit/fra > **taskQueue**: [`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) -Defined in: [indexer/src/IndexerNotifier.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L24) +Defined in: [indexer/src/IndexerNotifier.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L24) *** @@ -163,7 +163,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **propagateEventsAsTasks**(): `Promise`\<`void`\> -Defined in: [indexer/src/IndexerNotifier.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L30) +Defined in: [indexer/src/IndexerNotifier.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L30) #### Returns @@ -175,7 +175,7 @@ Defined in: [indexer/src/IndexerNotifier.ts:30](https://github.com/proto-kit/fra > **start**(): `Promise`\<`void`\> -Defined in: [indexer/src/IndexerNotifier.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L51) +Defined in: [indexer/src/IndexerNotifier.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L51) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md b/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md index 733c356..a1cac1a 100644 --- a/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md +++ b/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md @@ -12,7 +12,7 @@ title: ValidateTakeArg > **ValidateTakeArg**(): `MethodDecorator` -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L68) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L68) ## Returns diff --git a/src/pages/docs/reference/indexer/functions/cleanResolvers.md b/src/pages/docs/reference/indexer/functions/cleanResolvers.md index a0b83f7..8ae5814 100644 --- a/src/pages/docs/reference/indexer/functions/cleanResolvers.md +++ b/src/pages/docs/reference/indexer/functions/cleanResolvers.md @@ -12,7 +12,7 @@ title: cleanResolvers > **cleanResolvers**(`resolvers`): `Function`[] -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L47) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L47) ## Parameters diff --git a/src/pages/docs/reference/indexer/globals.md b/src/pages/docs/reference/indexer/globals.md new file mode 100644 index 0000000..2aac8b5 --- /dev/null +++ b/src/pages/docs/reference/indexer/globals.md @@ -0,0 +1,34 @@ +--- +title: "@proto-kit/indexer" +--- + +[**@proto-kit/indexer**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/indexer + +# @proto-kit/indexer + +## Classes + +- [GeneratedResolverFactoryGraphqlModule](classes/GeneratedResolverFactoryGraphqlModule.md) +- [IndexBlockTask](classes/IndexBlockTask.md) +- [IndexBlockTaskParametersSerializer](classes/IndexBlockTaskParametersSerializer.md) +- [Indexer](classes/Indexer.md) +- [IndexerModule](classes/IndexerModule.md) +- [IndexerNotifier](classes/IndexerNotifier.md) + +## Interfaces + +- [IndexBlockTaskParameters](interfaces/IndexBlockTaskParameters.md) + +## Type Aliases + +- [IndexerModulesRecord](type-aliases/IndexerModulesRecord.md) +- [NotifierMandatorySequencerModules](type-aliases/NotifierMandatorySequencerModules.md) + +## Functions + +- [cleanResolvers](functions/cleanResolvers.md) +- [ValidateTakeArg](functions/ValidateTakeArg.md) diff --git a/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md b/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md index 7846e8f..60bcbd8 100644 --- a/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md +++ b/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md @@ -10,7 +10,7 @@ title: IndexBlockTaskParameters # Interface: IndexBlockTaskParameters -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L9) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L9) ## Extends diff --git a/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md b/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md index 80b9e1a..9dd0247 100644 --- a/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md +++ b/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md @@ -12,4 +12,4 @@ title: IndexerModulesRecord > **IndexerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`IndexerModule`](../classes/IndexerModule.md)\<`unknown`\>\>\> -Defined in: [indexer/src/Indexer.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/Indexer.ts#L11) +Defined in: [indexer/src/Indexer.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/Indexer.ts#L11) diff --git a/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md b/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md index eee0ab3..5f55dc4 100644 --- a/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md +++ b/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md @@ -12,7 +12,7 @@ title: NotifierMandatorySequencerModules > **NotifierMandatorySequencerModules**: `object` -Defined in: [indexer/src/IndexerNotifier.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/indexer/src/IndexerNotifier.ts#L14) +Defined in: [indexer/src/IndexerNotifier.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L14) ## Type declaration diff --git a/src/pages/docs/reference/library/_meta.tsx b/src/pages/docs/reference/library/_meta.tsx index 48a0c5e..c639525 100644 --- a/src/pages/docs/reference/library/_meta.tsx +++ b/src/pages/docs/reference/library/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" + "README": "Overview","classes": "Classes","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" }; \ No newline at end of file diff --git a/src/pages/docs/reference/library/classes/Balance.md b/src/pages/docs/reference/library/classes/Balance.md index bc59df2..bb8e010 100644 --- a/src/pages/docs/reference/library/classes/Balance.md +++ b/src/pages/docs/reference/library/classes/Balance.md @@ -10,7 +10,7 @@ title: Balance # Class: Balance -Defined in: [packages/library/src/runtime/Balances.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L28) +Defined in: [packages/library/src/runtime/Balances.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L28) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -28,7 +28,7 @@ static methods from interface UIntConstructor > **new Balance**(`value`): [`Balance`](Balance.md) -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -76,7 +76,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -190,7 +190,7 @@ Convert provable type from a normal JS type. > `static` **Safe**: `object` -Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L12) +Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L12) #### fromField() @@ -367,7 +367,7 @@ Convert provable type to a normal JS type. > `static` **Unsafe**: `object` -Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L6) +Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L6) #### fromField() @@ -393,7 +393,7 @@ Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit > **get** `static` **max**(): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L35) +Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L35) ##### Returns @@ -411,7 +411,7 @@ Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-ki > **get** `static` **zero**(): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L31) +Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L31) ##### Returns @@ -427,7 +427,7 @@ Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-ki > **add**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -451,7 +451,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -479,7 +479,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -507,7 +507,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -535,7 +535,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -563,7 +563,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -591,7 +591,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> -Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L39) +Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L39) #### Returns @@ -607,7 +607,7 @@ Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-ki > **div**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) Integer division. @@ -634,7 +634,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -668,7 +668,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -692,7 +692,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -716,7 +716,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -740,7 +740,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -764,7 +764,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -788,7 +788,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -815,7 +815,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -839,7 +839,7 @@ Multiplication with overflow checking. > **numBits**(): `64` -Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L43) +Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L43) #### Returns @@ -855,7 +855,7 @@ Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-ki > **sqrtFloor**(): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -873,7 +873,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -912,7 +912,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -936,7 +936,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -954,7 +954,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -972,7 +972,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -991,7 +991,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -1009,7 +1009,7 @@ Turns the [UInt](UInt.md) into a string. > `static` **check**(`x`): `void` -Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L20) +Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L20) Add assertions to the proof to check if `value` is a valid member of type `T`. This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. @@ -1038,7 +1038,7 @@ For instance, calling check function on the type Bool asserts that the value of > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -1064,7 +1064,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **from**(`x`): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L24) +Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L24) #### Parameters @@ -1086,7 +1086,7 @@ Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-ki > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/Balances.md b/src/pages/docs/reference/library/classes/Balances.md index d6d1712..f26c19d 100644 --- a/src/pages/docs/reference/library/classes/Balances.md +++ b/src/pages/docs/reference/library/classes/Balances.md @@ -10,7 +10,7 @@ title: Balances # Class: Balances\ -Defined in: [packages/library/src/runtime/Balances.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L45) +Defined in: [packages/library/src/runtime/Balances.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L45) Base class for runtime modules providing the necessary utilities. @@ -52,7 +52,7 @@ Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:31 > **balances**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`BalancesKey`](BalancesKey.md), [`Balance`](Balance.md)\> -Defined in: [packages/library/src/runtime/Balances.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L49) +Defined in: [packages/library/src/runtime/Balances.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L49) #### Implementation of @@ -227,7 +227,7 @@ Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:33 > **burn**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Balances.ts:99](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L99) +Defined in: [packages/library/src/runtime/Balances.ts:99](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L99) #### Parameters @@ -275,7 +275,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **getBalance**(`tokenId`, `address`): `Promise`\<[`Balance`](Balance.md)\> -Defined in: [packages/library/src/runtime/Balances.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L54) +Defined in: [packages/library/src/runtime/Balances.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L54) #### Parameters @@ -313,7 +313,7 @@ Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:32 > **mint**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Balances.ts:93](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L93) +Defined in: [packages/library/src/runtime/Balances.ts:93](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L93) #### Parameters @@ -339,7 +339,7 @@ Defined in: [packages/library/src/runtime/Balances.ts:93](https://github.com/pro > **setBalance**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Balances.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L63) +Defined in: [packages/library/src/runtime/Balances.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L63) #### Parameters @@ -365,7 +365,7 @@ Defined in: [packages/library/src/runtime/Balances.ts:63](https://github.com/pro > **transfer**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Balances.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L72) +Defined in: [packages/library/src/runtime/Balances.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L72) #### Parameters @@ -399,7 +399,7 @@ Defined in: [packages/library/src/runtime/Balances.ts:72](https://github.com/pro > **transferSigned**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Balances.ts:107](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L107) +Defined in: [packages/library/src/runtime/Balances.ts:107](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L107) #### Parameters diff --git a/src/pages/docs/reference/library/classes/BalancesKey.md b/src/pages/docs/reference/library/classes/BalancesKey.md index 44dc92d..b4504ab 100644 --- a/src/pages/docs/reference/library/classes/BalancesKey.md +++ b/src/pages/docs/reference/library/classes/BalancesKey.md @@ -10,7 +10,7 @@ title: BalancesKey # Class: BalancesKey -Defined in: [packages/library/src/runtime/Balances.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L19) +Defined in: [packages/library/src/runtime/Balances.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L19) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **address**: `PublicKey` = `PublicKey` -Defined in: [packages/library/src/runtime/Balances.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L21) +Defined in: [packages/library/src/runtime/Balances.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L21) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/library/src/runtime/Balances.ts:21](https://github.com/pro > **tokenId**: [`TokenId`](TokenId.md) = `TokenId` -Defined in: [packages/library/src/runtime/Balances.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L20) +Defined in: [packages/library/src/runtime/Balances.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L20) #### Inherited from @@ -414,7 +414,7 @@ Convert provable type to a normal JS type. > `static` **from**(`tokenId`, `address`): [`BalancesKey`](BalancesKey.md) -Defined in: [packages/library/src/runtime/Balances.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L23) +Defined in: [packages/library/src/runtime/Balances.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L23) #### Parameters diff --git a/src/pages/docs/reference/library/classes/FeeTree.md b/src/pages/docs/reference/library/classes/FeeTree.md index d2b5d8e..5545f57 100644 --- a/src/pages/docs/reference/library/classes/FeeTree.md +++ b/src/pages/docs/reference/library/classes/FeeTree.md @@ -10,7 +10,7 @@ title: FeeTree # Class: FeeTree -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L44) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L44) ## Extends diff --git a/src/pages/docs/reference/library/classes/InMemorySequencerModules.md b/src/pages/docs/reference/library/classes/InMemorySequencerModules.md index 21cb540..de50de0 100644 --- a/src/pages/docs/reference/library/classes/InMemorySequencerModules.md +++ b/src/pages/docs/reference/library/classes/InMemorySequencerModules.md @@ -10,7 +10,7 @@ title: InMemorySequencerModules # Class: InMemorySequencerModules -Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/InMemorySequencerModules.ts#L31) +Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/InMemorySequencerModules.ts#L31) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:31](http > `static` **with**\<`SequencerModules`\>(`additionalModules`): `object` & `SequencerModules` -Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/InMemorySequencerModules.ts#L32) +Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/InMemorySequencerModules.ts#L32) #### Type Parameters diff --git a/src/pages/docs/reference/library/classes/MethodFeeConfigData.md b/src/pages/docs/reference/library/classes/MethodFeeConfigData.md index 0d268c6..8b17478 100644 --- a/src/pages/docs/reference/library/classes/MethodFeeConfigData.md +++ b/src/pages/docs/reference/library/classes/MethodFeeConfigData.md @@ -10,7 +10,7 @@ title: MethodFeeConfigData # Class: MethodFeeConfigData -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L32) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L32) ## Extends @@ -58,7 +58,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **baseFee**: [`UInt64`](UInt64.md) = `UInt64` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L34) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L34) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:34](https:/ > **methodId**: `Field` = `Field` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L33) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L33) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:33](https:/ > **perWeightUnitFee**: [`UInt64`](UInt64.md) = `UInt64` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L35) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L35) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:35](https:/ > **weight**: [`UInt64`](UInt64.md) = `UInt64` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L36) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L36) #### Inherited from @@ -570,7 +570,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L38) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L38) #### Returns diff --git a/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md b/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md index 8696c28..d4ccf89 100644 --- a/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md +++ b/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md @@ -10,7 +10,7 @@ title: RuntimeFeeAnalyzerService # Class: RuntimeFeeAnalyzerService -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L56) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L56) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new RuntimeFeeAnalyzerService**(`runtime`): [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L67) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L67) #### Parameters @@ -61,7 +61,7 @@ checks when retrieving it via the getter > **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L68) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L68) ## Accessors @@ -125,7 +125,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **getFeeConfig**(`methodId`): [`MethodFeeConfigData`](MethodFeeConfigData.md) -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:169](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L169) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:169](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L169) #### Parameters @@ -143,7 +143,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:169](https: > **getFeeTree**(): `object` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:161](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L161) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:161](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L161) #### Returns @@ -167,7 +167,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:161](https: > **getRoot**(): `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:185](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L185) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:185](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L185) #### Returns @@ -179,7 +179,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:185](https: > **getWitness**(`methodId`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:180](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L180) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:180](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L180) #### Parameters @@ -197,7 +197,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:180](https: > **initializeFeeTree**(): `Promise`\<`void`\> -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L73) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L73) #### Returns @@ -209,7 +209,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:73](https:/ > `static` **getWitnessType**(): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L57) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L57) #### Returns diff --git a/src/pages/docs/reference/library/classes/SimpleSequencerModules.md b/src/pages/docs/reference/library/classes/SimpleSequencerModules.md index 830f0de..7b4c933 100644 --- a/src/pages/docs/reference/library/classes/SimpleSequencerModules.md +++ b/src/pages/docs/reference/library/classes/SimpleSequencerModules.md @@ -10,7 +10,7 @@ title: SimpleSequencerModules # Class: SimpleSequencerModules -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L46) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L46) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:46](https: > `static` **defaultConfig**(): `object` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:97](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L97) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:97](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L97) #### Returns @@ -60,7 +60,7 @@ Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:97](https: > `static` **defaultWorkerConfig**(): `object` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L109) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L109) #### Returns @@ -116,7 +116,7 @@ Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:109](https > `static` **with**\<`SequencerModules`\>(`additionalModules`): `object` & `Omit`\<`SequencerModules`, `"Database"` \| `"BlockTrigger"` \| `"TaskQueue"` \| `"BaseLayer"` \| `"DatabasePruneModule"`\> & `object` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L60) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L60) #### Type Parameters @@ -138,7 +138,7 @@ Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:60](https: > `static` **worker**\<`QueueModule`, `SequencerModules`\>(`queue`, `additionalModules`): `object` & `SequencerModules` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L47) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L47) #### Type Parameters diff --git a/src/pages/docs/reference/library/classes/TokenId.md b/src/pages/docs/reference/library/classes/TokenId.md index ec2b549..ab7d912 100644 --- a/src/pages/docs/reference/library/classes/TokenId.md +++ b/src/pages/docs/reference/library/classes/TokenId.md @@ -10,7 +10,7 @@ title: TokenId # Class: TokenId -Defined in: [packages/library/src/runtime/Balances.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L18) +Defined in: [packages/library/src/runtime/Balances.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L18) ## Extends diff --git a/src/pages/docs/reference/library/classes/TransactionFeeHook.md b/src/pages/docs/reference/library/classes/TransactionFeeHook.md index a3c3c47..422e1b3 100644 --- a/src/pages/docs/reference/library/classes/TransactionFeeHook.md +++ b/src/pages/docs/reference/library/classes/TransactionFeeHook.md @@ -10,7 +10,7 @@ title: TransactionFeeHook # Class: TransactionFeeHook -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L51) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L51) Transaction hook for deducting transaction fees from the sender's balance. @@ -24,7 +24,7 @@ Transaction hook for deducting transaction fees from the sender's balance. > **new TransactionFeeHook**(`runtime`): [`TransactionFeeHook`](TransactionFeeHook.md) -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L52) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L52) #### Parameters @@ -73,7 +73,7 @@ Defined in: packages/protocol/dist/protocol/TransitioningProtocolModule.d.ts:8 > `protected` **persistedFeeAnalyzer**: `undefined` \| [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) = `undefined` -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L59) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L59) *** @@ -93,7 +93,7 @@ Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:4 > **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L54) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L54) ## Accessors @@ -121,7 +121,7 @@ Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:5 > **get** **balances**(): `Balances` -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L94) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L94) ##### Returns @@ -135,7 +135,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:94](https://github > **get** **config**(): [`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L85) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L85) ##### Returns @@ -145,7 +145,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:85](https://github > **set** **config**(`value`): `void` -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:90](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L90) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:90](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L90) ##### Parameters @@ -169,7 +169,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:90](https://github > **get** **feeAnalyzer**(): [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L98) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L98) ##### Returns @@ -203,7 +203,7 @@ Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:6 > **getFee**(`feeConfig`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L114) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L114) #### Parameters @@ -221,7 +221,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:114](https://githu > **onTransaction**(`executionData`): `Promise`\<`void`\> -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:128](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L128) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:128](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L128) Determine the transaction fee for the given transaction, and transfer it from the transaction sender to the fee recipient. @@ -246,7 +246,7 @@ from the transaction sender to the fee recipient. > **start**(): `Promise`\<`void`\> -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L79) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L79) #### Returns @@ -262,7 +262,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:79](https://github > **transferFee**(`from`, `fee`): `Promise`\<`void`\> -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L105) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L105) #### Parameters @@ -284,7 +284,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:105](https://githu > **verifyConfig**(): `void` -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L64) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L64) #### Returns diff --git a/src/pages/docs/reference/library/classes/UInt.md b/src/pages/docs/reference/library/classes/UInt.md index 9ac051c..637509c 100644 --- a/src/pages/docs/reference/library/classes/UInt.md +++ b/src/pages/docs/reference/library/classes/UInt.md @@ -10,7 +10,7 @@ title: UInt # Class: `abstract` UInt\ -Defined in: [packages/library/src/math/UInt.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L45) +Defined in: [packages/library/src/math/UInt.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L45) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -39,7 +39,7 @@ static methods from interface UIntConstructor > **new UInt**\<`BITS`\>(`value`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -63,7 +63,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -87,7 +87,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -381,7 +381,7 @@ Convert provable type to a normal JS type. > **add**(`y`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -401,7 +401,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -425,7 +425,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -449,7 +449,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -473,7 +473,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -497,7 +497,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -521,7 +521,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > `abstract` **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:91](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L91) +Defined in: [packages/library/src/math/UInt.ts:91](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L91) #### Returns @@ -533,7 +533,7 @@ Defined in: [packages/library/src/math/UInt.ts:91](https://github.com/proto-kit/ > **div**(`y`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) Integer division. @@ -556,7 +556,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -586,7 +586,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -606,7 +606,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -626,7 +626,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -646,7 +646,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -666,7 +666,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -686,7 +686,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -709,7 +709,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -729,7 +729,7 @@ Multiplication with overflow checking. > `abstract` **numBits**(): `BITS` -Defined in: [packages/library/src/math/UInt.ts:89](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L89) +Defined in: [packages/library/src/math/UInt.ts:89](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L89) #### Returns @@ -741,7 +741,7 @@ Defined in: [packages/library/src/math/UInt.ts:89](https://github.com/proto-kit/ > **sqrtFloor**(): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -755,7 +755,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -790,7 +790,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -810,7 +810,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -824,7 +824,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -838,7 +838,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -853,7 +853,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -867,7 +867,7 @@ Turns the [UInt](UInt.md) into a string. > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -889,7 +889,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/UInt112.md b/src/pages/docs/reference/library/classes/UInt112.md index c6bcc8f..c2a5479 100644 --- a/src/pages/docs/reference/library/classes/UInt112.md +++ b/src/pages/docs/reference/library/classes/UInt112.md @@ -10,7 +10,7 @@ title: UInt112 # Class: UInt112 -Defined in: [packages/library/src/math/UInt112.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L6) +Defined in: [packages/library/src/math/UInt112.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L6) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -28,7 +28,7 @@ static methods from interface UIntConstructor > **new UInt112**(`value`): [`UInt112`](UInt112.md) -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -76,7 +76,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -190,7 +190,7 @@ Convert provable type from a normal JS type. > `static` **Safe**: `object` -Defined in: [packages/library/src/math/UInt112.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L13) +Defined in: [packages/library/src/math/UInt112.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L13) #### fromField() @@ -363,7 +363,7 @@ Convert provable type to a normal JS type. > `static` **Unsafe**: `object` -Defined in: [packages/library/src/math/UInt112.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L7) +Defined in: [packages/library/src/math/UInt112.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L7) #### fromField() @@ -385,7 +385,7 @@ Defined in: [packages/library/src/math/UInt112.ts:7](https://github.com/proto-ki > **get** `static` **max**(): [`UInt112`](UInt112.md) -Defined in: [packages/library/src/math/UInt112.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L36) +Defined in: [packages/library/src/math/UInt112.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L36) ##### Returns @@ -399,7 +399,7 @@ Defined in: [packages/library/src/math/UInt112.ts:36](https://github.com/proto-k > **get** `static` **zero**(): [`UInt112`](UInt112.md) -Defined in: [packages/library/src/math/UInt112.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L32) +Defined in: [packages/library/src/math/UInt112.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L32) ##### Returns @@ -411,7 +411,7 @@ Defined in: [packages/library/src/math/UInt112.ts:32](https://github.com/proto-k > **add**(`y`): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -435,7 +435,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -463,7 +463,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -491,7 +491,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -519,7 +519,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -547,7 +547,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -575,7 +575,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`112`\> -Defined in: [packages/library/src/math/UInt112.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L40) +Defined in: [packages/library/src/math/UInt112.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L40) #### Returns @@ -591,7 +591,7 @@ Defined in: [packages/library/src/math/UInt112.ts:40](https://github.com/proto-k > **div**(`y`): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) Integer division. @@ -618,7 +618,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -652,7 +652,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -676,7 +676,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -700,7 +700,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -724,7 +724,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -748,7 +748,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -772,7 +772,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -799,7 +799,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -823,7 +823,7 @@ Multiplication with overflow checking. > **numBits**(): `112` -Defined in: [packages/library/src/math/UInt112.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L44) +Defined in: [packages/library/src/math/UInt112.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L44) #### Returns @@ -839,7 +839,7 @@ Defined in: [packages/library/src/math/UInt112.ts:44](https://github.com/proto-k > **sqrtFloor**(): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -857,7 +857,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -896,7 +896,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -920,7 +920,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -938,7 +938,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -956,7 +956,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -975,7 +975,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -993,7 +993,7 @@ Turns the [UInt](UInt.md) into a string. > **toUInt224**(): [`UInt224`](UInt224.md) -Defined in: [packages/library/src/math/UInt112.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L48) +Defined in: [packages/library/src/math/UInt112.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L48) #### Returns @@ -1005,7 +1005,7 @@ Defined in: [packages/library/src/math/UInt112.ts:48](https://github.com/proto-k > `static` **check**(`x`): `void` -Defined in: [packages/library/src/math/UInt112.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L21) +Defined in: [packages/library/src/math/UInt112.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L21) Add assertions to the proof to check if `value` is a valid member of type `T`. This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. @@ -1034,7 +1034,7 @@ For instance, calling check function on the type Bool asserts that the value of > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -1060,7 +1060,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **from**(`x`): [`UInt112`](UInt112.md) -Defined in: [packages/library/src/math/UInt112.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt112.ts#L25) +Defined in: [packages/library/src/math/UInt112.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L25) #### Parameters @@ -1078,7 +1078,7 @@ Defined in: [packages/library/src/math/UInt112.ts:25](https://github.com/proto-k > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/UInt224.md b/src/pages/docs/reference/library/classes/UInt224.md index 920e120..af1a02b 100644 --- a/src/pages/docs/reference/library/classes/UInt224.md +++ b/src/pages/docs/reference/library/classes/UInt224.md @@ -10,7 +10,7 @@ title: UInt224 # Class: UInt224 -Defined in: [packages/library/src/math/UInt224.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L5) +Defined in: [packages/library/src/math/UInt224.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L5) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -28,7 +28,7 @@ static methods from interface UIntConstructor > **new UInt224**(`value`): [`UInt224`](UInt224.md) -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -76,7 +76,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -190,7 +190,7 @@ Convert provable type from a normal JS type. > `static` **Safe**: `object` -Defined in: [packages/library/src/math/UInt224.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L12) +Defined in: [packages/library/src/math/UInt224.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L12) #### fromField() @@ -363,7 +363,7 @@ Convert provable type to a normal JS type. > `static` **Unsafe**: `object` -Defined in: [packages/library/src/math/UInt224.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L6) +Defined in: [packages/library/src/math/UInt224.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L6) #### fromField() @@ -385,7 +385,7 @@ Defined in: [packages/library/src/math/UInt224.ts:6](https://github.com/proto-ki > **get** `static` **max**(): [`UInt224`](UInt224.md) -Defined in: [packages/library/src/math/UInt224.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L35) +Defined in: [packages/library/src/math/UInt224.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L35) ##### Returns @@ -399,7 +399,7 @@ Defined in: [packages/library/src/math/UInt224.ts:35](https://github.com/proto-k > **get** `static` **zero**(): [`UInt224`](UInt224.md) -Defined in: [packages/library/src/math/UInt224.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L31) +Defined in: [packages/library/src/math/UInt224.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L31) ##### Returns @@ -411,7 +411,7 @@ Defined in: [packages/library/src/math/UInt224.ts:31](https://github.com/proto-k > **add**(`y`): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -435,7 +435,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -463,7 +463,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -491,7 +491,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -519,7 +519,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -547,7 +547,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -575,7 +575,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`224`\> -Defined in: [packages/library/src/math/UInt224.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L39) +Defined in: [packages/library/src/math/UInt224.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L39) #### Returns @@ -591,7 +591,7 @@ Defined in: [packages/library/src/math/UInt224.ts:39](https://github.com/proto-k > **div**(`y`): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) Integer division. @@ -618,7 +618,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -652,7 +652,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -676,7 +676,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -700,7 +700,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -724,7 +724,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -748,7 +748,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -772,7 +772,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -799,7 +799,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -823,7 +823,7 @@ Multiplication with overflow checking. > **numBits**(): `224` -Defined in: [packages/library/src/math/UInt224.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L43) +Defined in: [packages/library/src/math/UInt224.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L43) #### Returns @@ -839,7 +839,7 @@ Defined in: [packages/library/src/math/UInt224.ts:43](https://github.com/proto-k > **sqrtFloor**(): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -857,7 +857,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -896,7 +896,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -920,7 +920,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -938,7 +938,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -956,7 +956,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -975,7 +975,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -993,7 +993,7 @@ Turns the [UInt](UInt.md) into a string. > `static` **check**(`x`): `void` -Defined in: [packages/library/src/math/UInt224.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L20) +Defined in: [packages/library/src/math/UInt224.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L20) Add assertions to the proof to check if `value` is a valid member of type `T`. This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. @@ -1022,7 +1022,7 @@ For instance, calling check function on the type Bool asserts that the value of > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -1048,7 +1048,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **from**(`x`): [`UInt224`](UInt224.md) -Defined in: [packages/library/src/math/UInt224.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt224.ts#L24) +Defined in: [packages/library/src/math/UInt224.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L24) #### Parameters @@ -1066,7 +1066,7 @@ Defined in: [packages/library/src/math/UInt224.ts:24](https://github.com/proto-k > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/UInt32.md b/src/pages/docs/reference/library/classes/UInt32.md index 3a54029..e65825e 100644 --- a/src/pages/docs/reference/library/classes/UInt32.md +++ b/src/pages/docs/reference/library/classes/UInt32.md @@ -10,7 +10,7 @@ title: UInt32 # Class: UInt32 -Defined in: [packages/library/src/math/UInt32.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L6) +Defined in: [packages/library/src/math/UInt32.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L6) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -28,7 +28,7 @@ static methods from interface UIntConstructor > **new UInt32**(`value`): [`UInt32`](UInt32.md) -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -76,7 +76,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -190,7 +190,7 @@ Convert provable type from a normal JS type. > `static` **Safe**: `object` -Defined in: [packages/library/src/math/UInt32.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L13) +Defined in: [packages/library/src/math/UInt32.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L13) #### fromField() @@ -363,7 +363,7 @@ Convert provable type to a normal JS type. > `static` **Unsafe**: `object` -Defined in: [packages/library/src/math/UInt32.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L7) +Defined in: [packages/library/src/math/UInt32.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L7) #### fromField() @@ -385,7 +385,7 @@ Defined in: [packages/library/src/math/UInt32.ts:7](https://github.com/proto-kit > **get** `static` **max**(): [`UInt32`](UInt32.md) -Defined in: [packages/library/src/math/UInt32.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L36) +Defined in: [packages/library/src/math/UInt32.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L36) ##### Returns @@ -399,7 +399,7 @@ Defined in: [packages/library/src/math/UInt32.ts:36](https://github.com/proto-ki > **get** `static` **zero**(): [`UInt32`](UInt32.md) -Defined in: [packages/library/src/math/UInt32.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L32) +Defined in: [packages/library/src/math/UInt32.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L32) ##### Returns @@ -411,7 +411,7 @@ Defined in: [packages/library/src/math/UInt32.ts:32](https://github.com/proto-ki > **add**(`y`): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -435,7 +435,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -463,7 +463,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -491,7 +491,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -519,7 +519,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -547,7 +547,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -575,7 +575,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`32`\> -Defined in: [packages/library/src/math/UInt32.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L40) +Defined in: [packages/library/src/math/UInt32.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L40) #### Returns @@ -591,7 +591,7 @@ Defined in: [packages/library/src/math/UInt32.ts:40](https://github.com/proto-ki > **div**(`y`): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) Integer division. @@ -618,7 +618,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -652,7 +652,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -676,7 +676,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -700,7 +700,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -724,7 +724,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -748,7 +748,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -772,7 +772,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -799,7 +799,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -823,7 +823,7 @@ Multiplication with overflow checking. > **numBits**(): `32` -Defined in: [packages/library/src/math/UInt32.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L44) +Defined in: [packages/library/src/math/UInt32.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L44) #### Returns @@ -839,7 +839,7 @@ Defined in: [packages/library/src/math/UInt32.ts:44](https://github.com/proto-ki > **sqrtFloor**(): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -857,7 +857,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -896,7 +896,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -920,7 +920,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -938,7 +938,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -956,7 +956,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -975,7 +975,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -993,7 +993,7 @@ Turns the [UInt](UInt.md) into a string. > **toUInt64**(): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt32.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L48) +Defined in: [packages/library/src/math/UInt32.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L48) #### Returns @@ -1005,7 +1005,7 @@ Defined in: [packages/library/src/math/UInt32.ts:48](https://github.com/proto-ki > `static` **check**(`x`): `void` -Defined in: [packages/library/src/math/UInt32.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L21) +Defined in: [packages/library/src/math/UInt32.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L21) Add assertions to the proof to check if `value` is a valid member of type `T`. This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. @@ -1034,7 +1034,7 @@ For instance, calling check function on the type Bool asserts that the value of > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -1060,7 +1060,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **from**(`x`): [`UInt32`](UInt32.md) -Defined in: [packages/library/src/math/UInt32.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt32.ts#L25) +Defined in: [packages/library/src/math/UInt32.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L25) #### Parameters @@ -1078,7 +1078,7 @@ Defined in: [packages/library/src/math/UInt32.ts:25](https://github.com/proto-ki > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/UInt64.md b/src/pages/docs/reference/library/classes/UInt64.md index 71f6946..b65c906 100644 --- a/src/pages/docs/reference/library/classes/UInt64.md +++ b/src/pages/docs/reference/library/classes/UInt64.md @@ -10,7 +10,7 @@ title: UInt64 # Class: UInt64 -Defined in: [packages/library/src/math/UInt64.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L5) +Defined in: [packages/library/src/math/UInt64.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L5) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -32,7 +32,7 @@ static methods from interface UIntConstructor > **new UInt64**(`value`): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -56,7 +56,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -80,7 +80,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -194,7 +194,7 @@ Convert provable type from a normal JS type. > `static` **Safe**: `object` -Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L12) +Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L12) #### fromField() @@ -367,7 +367,7 @@ Convert provable type to a normal JS type. > `static` **Unsafe**: `object` -Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L6) +Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L6) #### fromField() @@ -389,7 +389,7 @@ Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit > **get** `static` **max**(): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L35) +Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L35) ##### Returns @@ -403,7 +403,7 @@ Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-ki > **get** `static` **zero**(): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L31) +Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L31) ##### Returns @@ -415,7 +415,7 @@ Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-ki > **add**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -439,7 +439,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -467,7 +467,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -495,7 +495,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -523,7 +523,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -551,7 +551,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -579,7 +579,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> -Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L39) +Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L39) #### Returns @@ -595,7 +595,7 @@ Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-ki > **div**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) Integer division. @@ -622,7 +622,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -656,7 +656,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -680,7 +680,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -704,7 +704,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -728,7 +728,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -752,7 +752,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -776,7 +776,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -803,7 +803,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -827,7 +827,7 @@ Multiplication with overflow checking. > **numBits**(): `64` -Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L43) +Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L43) #### Returns @@ -843,7 +843,7 @@ Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-ki > **sqrtFloor**(): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -861,7 +861,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -900,7 +900,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -924,7 +924,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -942,7 +942,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -960,7 +960,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -979,7 +979,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -997,7 +997,7 @@ Turns the [UInt](UInt.md) into a string. > `static` **check**(`x`): `void` -Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L20) +Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L20) Add assertions to the proof to check if `value` is a valid member of type `T`. This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. @@ -1026,7 +1026,7 @@ For instance, calling check function on the type Bool asserts that the value of > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -1052,7 +1052,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **from**(`x`): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt64.ts#L24) +Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L24) #### Parameters @@ -1070,7 +1070,7 @@ Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-ki > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/VanillaProtocolModules.md b/src/pages/docs/reference/library/classes/VanillaProtocolModules.md index 86c6407..3110662 100644 --- a/src/pages/docs/reference/library/classes/VanillaProtocolModules.md +++ b/src/pages/docs/reference/library/classes/VanillaProtocolModules.md @@ -10,7 +10,7 @@ title: VanillaProtocolModules # Class: VanillaProtocolModules -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L18) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L18) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:18](https:/ > `static` **defaultConfig**(): `object` -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L51) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L51) #### Returns @@ -84,7 +84,7 @@ Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:51](https:/ > `static` **mandatoryConfig**(): `object` -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L41) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L41) #### Returns @@ -116,7 +116,7 @@ Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:41](https:/ > `static` **mandatoryModules**\<`ProtocolModules`\>(`additionalModules`): [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `ProtocolModules` -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L19) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L19) #### Type Parameters @@ -138,7 +138,7 @@ Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:19](https:/ > `static` **with**\<`ProtocolModules`\>(`additionalModules`): [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object` & `ProtocolModules` -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L32) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L32) #### Type Parameters diff --git a/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md b/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md index ebede92..10be53f 100644 --- a/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md +++ b/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md @@ -10,7 +10,7 @@ title: VanillaRuntimeModules # Class: VanillaRuntimeModules -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/VanillaRuntimeModules.ts#L10) +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/VanillaRuntimeModules.ts#L10) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:10](https://g > `static` **defaultConfig**(): `object` -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/VanillaRuntimeModules.ts#L20) +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/VanillaRuntimeModules.ts#L20) #### Returns @@ -44,7 +44,7 @@ Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:20](https://g > `static` **with**\<`RuntimeModules`\>(`additionalModules`): `object` & `RuntimeModules` -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/VanillaRuntimeModules.ts#L11) +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/VanillaRuntimeModules.ts#L11) #### Type Parameters diff --git a/src/pages/docs/reference/library/classes/WithdrawalEvent.md b/src/pages/docs/reference/library/classes/WithdrawalEvent.md index 766e336..160765b 100644 --- a/src/pages/docs/reference/library/classes/WithdrawalEvent.md +++ b/src/pages/docs/reference/library/classes/WithdrawalEvent.md @@ -10,7 +10,7 @@ title: WithdrawalEvent # Class: WithdrawalEvent -Defined in: [packages/library/src/runtime/Withdrawals.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L20) +Defined in: [packages/library/src/runtime/Withdrawals.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L20) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` -Defined in: [packages/library/src/runtime/Withdrawals.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L21) +Defined in: [packages/library/src/runtime/Withdrawals.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L21) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/library/src/runtime/Withdrawals.ts:21](https://github.com/ > **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` -Defined in: [packages/library/src/runtime/Withdrawals.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L22) +Defined in: [packages/library/src/runtime/Withdrawals.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L22) #### Inherited from diff --git a/src/pages/docs/reference/library/classes/WithdrawalKey.md b/src/pages/docs/reference/library/classes/WithdrawalKey.md index 3dbbf2a..5acf2b2 100644 --- a/src/pages/docs/reference/library/classes/WithdrawalKey.md +++ b/src/pages/docs/reference/library/classes/WithdrawalKey.md @@ -10,7 +10,7 @@ title: WithdrawalKey # Class: WithdrawalKey -Defined in: [packages/library/src/runtime/Withdrawals.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L15) +Defined in: [packages/library/src/runtime/Withdrawals.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L15) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **index**: `Field` = `Field` -Defined in: [packages/library/src/runtime/Withdrawals.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L16) +Defined in: [packages/library/src/runtime/Withdrawals.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L16) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/library/src/runtime/Withdrawals.ts:16](https://github.com/ > **tokenId**: `Field` = `Field` -Defined in: [packages/library/src/runtime/Withdrawals.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L17) +Defined in: [packages/library/src/runtime/Withdrawals.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L17) #### Inherited from diff --git a/src/pages/docs/reference/library/classes/Withdrawals.md b/src/pages/docs/reference/library/classes/Withdrawals.md index f407e0f..ecacd5e 100644 --- a/src/pages/docs/reference/library/classes/Withdrawals.md +++ b/src/pages/docs/reference/library/classes/Withdrawals.md @@ -10,7 +10,7 @@ title: Withdrawals # Class: Withdrawals -Defined in: [packages/library/src/runtime/Withdrawals.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L26) +Defined in: [packages/library/src/runtime/Withdrawals.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L26) Base class for runtime modules providing the necessary utilities. @@ -24,7 +24,7 @@ Base class for runtime modules providing the necessary utilities. > **new Withdrawals**(`balances`): [`Withdrawals`](Withdrawals.md) -Defined in: [packages/library/src/runtime/Withdrawals.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L38) +Defined in: [packages/library/src/runtime/Withdrawals.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L38) #### Parameters @@ -61,7 +61,7 @@ checks when retrieving it via the getter > **events**: [`RuntimeEvents`](../../module/classes/RuntimeEvents.md)\<\{ `withdrawal`: *typeof* [`WithdrawalEvent`](WithdrawalEvent.md); \}\> -Defined in: [packages/library/src/runtime/Withdrawals.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L27) +Defined in: [packages/library/src/runtime/Withdrawals.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L27) #### Overrides @@ -127,7 +127,7 @@ Holds all method names that are callable throw transactions > **withdrawalCounters**: [`StateMap`](../../protocol/classes/StateMap.md)\<`Field`, `Field`\> -Defined in: [packages/library/src/runtime/Withdrawals.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L31) +Defined in: [packages/library/src/runtime/Withdrawals.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L31) *** @@ -135,7 +135,7 @@ Defined in: [packages/library/src/runtime/Withdrawals.ts:31](https://github.com/ > **withdrawals**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`WithdrawalKey`](WithdrawalKey.md), [`Withdrawal`](../../protocol/classes/Withdrawal.md)\> -Defined in: [packages/library/src/runtime/Withdrawals.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L33) +Defined in: [packages/library/src/runtime/Withdrawals.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L33) *** @@ -263,7 +263,7 @@ Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:32 > `protected` **queueWithdrawal**(`withdrawal`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Withdrawals.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L42) +Defined in: [packages/library/src/runtime/Withdrawals.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L42) #### Parameters @@ -281,7 +281,7 @@ Defined in: [packages/library/src/runtime/Withdrawals.ts:42](https://github.com/ > **withdraw**(`address`, `amount`, `tokenId`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Withdrawals.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Withdrawals.ts#L59) +Defined in: [packages/library/src/runtime/Withdrawals.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L59) #### Parameters diff --git a/src/pages/docs/reference/library/globals.md b/src/pages/docs/reference/library/globals.md new file mode 100644 index 0000000..d12c654 --- /dev/null +++ b/src/pages/docs/reference/library/globals.md @@ -0,0 +1,60 @@ +--- +title: "@proto-kit/library" +--- + +[**@proto-kit/library**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/library + +# @proto-kit/library + +## Classes + +- [Balance](classes/Balance.md) +- [Balances](classes/Balances.md) +- [BalancesKey](classes/BalancesKey.md) +- [FeeTree](classes/FeeTree.md) +- [InMemorySequencerModules](classes/InMemorySequencerModules.md) +- [MethodFeeConfigData](classes/MethodFeeConfigData.md) +- [RuntimeFeeAnalyzerService](classes/RuntimeFeeAnalyzerService.md) +- [SimpleSequencerModules](classes/SimpleSequencerModules.md) +- [TokenId](classes/TokenId.md) +- [TransactionFeeHook](classes/TransactionFeeHook.md) +- [UInt](classes/UInt.md) +- [UInt112](classes/UInt112.md) +- [UInt224](classes/UInt224.md) +- [UInt32](classes/UInt32.md) +- [UInt64](classes/UInt64.md) +- [VanillaProtocolModules](classes/VanillaProtocolModules.md) +- [VanillaRuntimeModules](classes/VanillaRuntimeModules.md) +- [WithdrawalEvent](classes/WithdrawalEvent.md) +- [WithdrawalKey](classes/WithdrawalKey.md) +- [Withdrawals](classes/Withdrawals.md) + +## Interfaces + +- [BalancesEvents](interfaces/BalancesEvents.md) +- [FeeIndexes](interfaces/FeeIndexes.md) +- [FeeTreeValues](interfaces/FeeTreeValues.md) +- [MethodFeeConfig](interfaces/MethodFeeConfig.md) +- [RuntimeFeeAnalyzerServiceConfig](interfaces/RuntimeFeeAnalyzerServiceConfig.md) +- [TransactionFeeHookConfig](interfaces/TransactionFeeHookConfig.md) + +## Type Aliases + +- [AdditionalSequencerModules](type-aliases/AdditionalSequencerModules.md) +- [InMemorySequencerModulesRecord](type-aliases/InMemorySequencerModulesRecord.md) +- [MinimalBalances](type-aliases/MinimalBalances.md) +- [MinimumAdditionalSequencerModules](type-aliases/MinimumAdditionalSequencerModules.md) +- [SimpleSequencerModulesRecord](type-aliases/SimpleSequencerModulesRecord.md) +- [SimpleSequencerWorkerModulesRecord](type-aliases/SimpleSequencerWorkerModulesRecord.md) +- [UIntConstructor](type-aliases/UIntConstructor.md) +- [VanillaProtocolModulesRecord](type-aliases/VanillaProtocolModulesRecord.md) +- [VanillaRuntimeModulesRecord](type-aliases/VanillaRuntimeModulesRecord.md) + +## Variables + +- [errors](variables/errors.md) +- [treeFeeHeight](variables/treeFeeHeight.md) diff --git a/src/pages/docs/reference/library/interfaces/BalancesEvents.md b/src/pages/docs/reference/library/interfaces/BalancesEvents.md index cf75a52..d656754 100644 --- a/src/pages/docs/reference/library/interfaces/BalancesEvents.md +++ b/src/pages/docs/reference/library/interfaces/BalancesEvents.md @@ -10,7 +10,7 @@ title: BalancesEvents # Interface: BalancesEvents -Defined in: [packages/library/src/runtime/Balances.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L30) +Defined in: [packages/library/src/runtime/Balances.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L30) ## Extends @@ -26,4 +26,4 @@ Defined in: [packages/library/src/runtime/Balances.ts:30](https://github.com/pro > **setBalance**: \[[`BalancesKey`](../classes/BalancesKey.md), [`Balance`](../classes/Balance.md)\] -Defined in: [packages/library/src/runtime/Balances.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L31) +Defined in: [packages/library/src/runtime/Balances.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L31) diff --git a/src/pages/docs/reference/library/interfaces/FeeIndexes.md b/src/pages/docs/reference/library/interfaces/FeeIndexes.md index c2b544c..1e180d5 100644 --- a/src/pages/docs/reference/library/interfaces/FeeIndexes.md +++ b/src/pages/docs/reference/library/interfaces/FeeIndexes.md @@ -10,7 +10,7 @@ title: FeeIndexes # Interface: FeeIndexes -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L28) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L28) ## Indexable diff --git a/src/pages/docs/reference/library/interfaces/FeeTreeValues.md b/src/pages/docs/reference/library/interfaces/FeeTreeValues.md index d2e4814..2451999 100644 --- a/src/pages/docs/reference/library/interfaces/FeeTreeValues.md +++ b/src/pages/docs/reference/library/interfaces/FeeTreeValues.md @@ -10,7 +10,7 @@ title: FeeTreeValues # Interface: FeeTreeValues -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L24) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L24) ## Indexable diff --git a/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md b/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md index 4294b16..533c827 100644 --- a/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md +++ b/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md @@ -10,7 +10,7 @@ title: MethodFeeConfig # Interface: MethodFeeConfig -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L17) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L17) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:17](https:/ > **baseFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L19) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L19) *** @@ -26,7 +26,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:19](https:/ > **methodId**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L18) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L18) *** @@ -34,7 +34,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:18](https:/ > **perWeightUnitFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L20) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L20) *** @@ -42,4 +42,4 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:20](https:/ > **weight**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L21) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L21) diff --git a/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md b/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md index 214406b..b0135fc 100644 --- a/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md +++ b/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md @@ -10,7 +10,7 @@ title: RuntimeFeeAnalyzerServiceConfig # Interface: RuntimeFeeAnalyzerServiceConfig -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L46) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L46) ## Extended by @@ -22,7 +22,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:46](https:/ > **baseFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) *** @@ -30,7 +30,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https:/ > **feeRecipient**: `string` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) *** @@ -38,7 +38,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https:/ > **methods**: `object` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) #### Index Signature @@ -50,7 +50,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https:/ > **perWeightUnitFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) *** @@ -58,4 +58,4 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https:/ > **tokenId**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) diff --git a/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md b/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md index 00ba2a2..476128b 100644 --- a/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md +++ b/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md @@ -10,7 +10,7 @@ title: TransactionFeeHookConfig # Interface: TransactionFeeHookConfig -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/TransactionFeeHook.ts#L33) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L33) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:33](https://github > **baseFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https:/ > **feeRecipient**: `string` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https:/ > **methods**: `object` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) #### Index Signature @@ -62,7 +62,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https:/ > **perWeightUnitFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https:/ > **tokenId**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) #### Inherited from diff --git a/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md b/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md index 53707bf..0abcc8b 100644 --- a/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md +++ b/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md @@ -12,4 +12,4 @@ title: AdditionalSequencerModules > **AdditionalSequencerModules**: [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) & [`MinimumAdditionalSequencerModules`](MinimumAdditionalSequencerModules.md) -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L36) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L36) diff --git a/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md index ed462c6..c491bb6 100644 --- a/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md +++ b/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md @@ -12,7 +12,7 @@ title: InMemorySequencerModulesRecord > **InMemorySequencerModulesRecord**: `object` -Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/InMemorySequencerModules.ts#L16) +Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/InMemorySequencerModules.ts#L16) ## Type declaration diff --git a/src/pages/docs/reference/library/type-aliases/MinimalBalances.md b/src/pages/docs/reference/library/type-aliases/MinimalBalances.md index a4828a5..05cc804 100644 --- a/src/pages/docs/reference/library/type-aliases/MinimalBalances.md +++ b/src/pages/docs/reference/library/type-aliases/MinimalBalances.md @@ -12,7 +12,7 @@ title: MinimalBalances > **MinimalBalances**: `object` -Defined in: [packages/library/src/runtime/Balances.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L34) +Defined in: [packages/library/src/runtime/Balances.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L34) ## Type declaration diff --git a/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md b/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md index bccdb16..f072c75 100644 --- a/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md +++ b/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md @@ -12,7 +12,7 @@ title: MinimumAdditionalSequencerModules > **MinimumAdditionalSequencerModules**: `object` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L26) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L26) ## Type declaration diff --git a/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md index 6baccd1..4e73e0e 100644 --- a/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md +++ b/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md @@ -12,4 +12,4 @@ title: SimpleSequencerModulesRecord > **SimpleSequencerModulesRecord**: [`MinimumAdditionalSequencerModules`](MinimumAdditionalSequencerModules.md) & `PreconfiguredSimpleSequencerModulesRecord` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L33) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L33) diff --git a/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md index c6f78c6..613fdd8 100644 --- a/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md +++ b/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md @@ -12,7 +12,7 @@ title: SimpleSequencerWorkerModulesRecord > **SimpleSequencerWorkerModulesRecord**: `object` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/sequencer/SimpleSequencerModules.ts#L39) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L39) ## Type declaration diff --git a/src/pages/docs/reference/library/type-aliases/UIntConstructor.md b/src/pages/docs/reference/library/type-aliases/UIntConstructor.md index 7304d42..f0aa99e 100644 --- a/src/pages/docs/reference/library/type-aliases/UIntConstructor.md +++ b/src/pages/docs/reference/library/type-aliases/UIntConstructor.md @@ -12,7 +12,7 @@ title: UIntConstructor > **UIntConstructor**\<`BITS`\>: `object` -Defined in: [packages/library/src/math/UInt.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/math/UInt.ts#L24) +Defined in: [packages/library/src/math/UInt.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L24) ## Type Parameters diff --git a/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md b/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md index dbb06ba..f04fabf 100644 --- a/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md +++ b/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md @@ -12,7 +12,7 @@ title: VanillaProtocolModulesRecord > **VanillaProtocolModulesRecord**: [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object` -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/protocol/VanillaProtocolModules.ts#L14) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L14) ## Type declaration diff --git a/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md b/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md index 7b57cda..42b9657 100644 --- a/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md +++ b/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md @@ -12,7 +12,7 @@ title: VanillaRuntimeModulesRecord > **VanillaRuntimeModulesRecord**: `object` -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/VanillaRuntimeModules.ts#L6) +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/VanillaRuntimeModules.ts#L6) ## Type declaration diff --git a/src/pages/docs/reference/library/variables/errors.md b/src/pages/docs/reference/library/variables/errors.md index d140016..53f1690 100644 --- a/src/pages/docs/reference/library/variables/errors.md +++ b/src/pages/docs/reference/library/variables/errors.md @@ -12,7 +12,7 @@ title: errors > `const` **errors**: `object` -Defined in: [packages/library/src/runtime/Balances.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/runtime/Balances.ts#L13) +Defined in: [packages/library/src/runtime/Balances.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L13) ## Type declaration diff --git a/src/pages/docs/reference/library/variables/treeFeeHeight.md b/src/pages/docs/reference/library/variables/treeFeeHeight.md index 76a28dc..dddaab2 100644 --- a/src/pages/docs/reference/library/variables/treeFeeHeight.md +++ b/src/pages/docs/reference/library/variables/treeFeeHeight.md @@ -12,4 +12,4 @@ title: treeFeeHeight > `const` **treeFeeHeight**: `10` = `10` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L43) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L43) diff --git a/src/pages/docs/reference/module/classes/InMemoryStateService.md b/src/pages/docs/reference/module/classes/InMemoryStateService.md index 86fc3b4..22ef17f 100644 --- a/src/pages/docs/reference/module/classes/InMemoryStateService.md +++ b/src/pages/docs/reference/module/classes/InMemoryStateService.md @@ -10,7 +10,7 @@ title: InMemoryStateService # Class: InMemoryStateService -Defined in: [module/src/state/InMemoryStateService.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/state/InMemoryStateService.ts#L7) +Defined in: [module/src/state/InMemoryStateService.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/state/InMemoryStateService.ts#L7) Naive implementation of an in-memory variant of the StateService interface @@ -39,7 +39,7 @@ Naive implementation of an in-memory variant of the StateService interface > **values**: `Record`\<`string`, `null` \| `Field`[]\> = `{}` -Defined in: [module/src/state/InMemoryStateService.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/state/InMemoryStateService.ts#L12) +Defined in: [module/src/state/InMemoryStateService.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/state/InMemoryStateService.ts#L12) This mapping container null values if the specific entry has been deleted. This is used by the CachedState service to keep track of deletions @@ -50,7 +50,7 @@ This is used by the CachedState service to keep track of deletions > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [module/src/state/InMemoryStateService.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/state/InMemoryStateService.ts#L14) +Defined in: [module/src/state/InMemoryStateService.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/state/InMemoryStateService.ts#L14) #### Parameters @@ -72,7 +72,7 @@ Defined in: [module/src/state/InMemoryStateService.ts:14](https://github.com/pro > **set**(`key`, `value`): `Promise`\<`void`\> -Defined in: [module/src/state/InMemoryStateService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/state/InMemoryStateService.ts#L18) +Defined in: [module/src/state/InMemoryStateService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/state/InMemoryStateService.ts#L18) #### Parameters diff --git a/src/pages/docs/reference/module/classes/MethodIdFactory.md b/src/pages/docs/reference/module/classes/MethodIdFactory.md index 28dda82..3216e10 100644 --- a/src/pages/docs/reference/module/classes/MethodIdFactory.md +++ b/src/pages/docs/reference/module/classes/MethodIdFactory.md @@ -10,7 +10,7 @@ title: MethodIdFactory # Class: MethodIdFactory -Defined in: [module/src/factories/MethodIdFactory.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/factories/MethodIdFactory.ts#L5) +Defined in: [module/src/factories/MethodIdFactory.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/factories/MethodIdFactory.ts#L5) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -43,7 +43,7 @@ deps that are necessary for the sequencer to work. > **dependencies**(): `object` -Defined in: [module/src/factories/MethodIdFactory.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/factories/MethodIdFactory.ts#L6) +Defined in: [module/src/factories/MethodIdFactory.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/factories/MethodIdFactory.ts#L6) #### Returns diff --git a/src/pages/docs/reference/module/classes/MethodIdResolver.md b/src/pages/docs/reference/module/classes/MethodIdResolver.md index b1f3ebf..2ca298e 100644 --- a/src/pages/docs/reference/module/classes/MethodIdResolver.md +++ b/src/pages/docs/reference/module/classes/MethodIdResolver.md @@ -10,7 +10,7 @@ title: MethodIdResolver # Class: MethodIdResolver -Defined in: [module/src/runtime/MethodIdResolver.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/MethodIdResolver.ts#L18) +Defined in: [module/src/runtime/MethodIdResolver.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/MethodIdResolver.ts#L18) Please see `getMethodId` to learn more about methodId encoding @@ -21,7 +21,7 @@ methodId encoding > **new MethodIdResolver**(`runtime`): [`MethodIdResolver`](MethodIdResolver.md) -Defined in: [module/src/runtime/MethodIdResolver.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/MethodIdResolver.ts#L23) +Defined in: [module/src/runtime/MethodIdResolver.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/MethodIdResolver.ts#L23) #### Parameters @@ -39,7 +39,7 @@ Defined in: [module/src/runtime/MethodIdResolver.ts:23](https://github.com/proto > **getMethodId**(`moduleName`, `methodName`): `bigint` -Defined in: [module/src/runtime/MethodIdResolver.ts:100](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/MethodIdResolver.ts#L100) +Defined in: [module/src/runtime/MethodIdResolver.ts:100](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/MethodIdResolver.ts#L100) #### Parameters @@ -61,7 +61,7 @@ Defined in: [module/src/runtime/MethodIdResolver.ts:100](https://github.com/prot > **getMethodNameFromId**(`methodId`): `undefined` \| \[`string`, `string`\] -Defined in: [module/src/runtime/MethodIdResolver.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/MethodIdResolver.ts#L86) +Defined in: [module/src/runtime/MethodIdResolver.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/MethodIdResolver.ts#L86) #### Parameters @@ -79,7 +79,7 @@ Defined in: [module/src/runtime/MethodIdResolver.ts:86](https://github.com/proto > **methodIdMap**(): [`RuntimeMethodIdMapping`](../../protocol/type-aliases/RuntimeMethodIdMapping.md) -Defined in: [module/src/runtime/MethodIdResolver.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/MethodIdResolver.ts#L47) +Defined in: [module/src/runtime/MethodIdResolver.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/MethodIdResolver.ts#L47) The purpose of this method is to provide a dictionary where we can look up properties like methodId and invocationType diff --git a/src/pages/docs/reference/module/classes/MethodParameterEncoder.md b/src/pages/docs/reference/module/classes/MethodParameterEncoder.md index fca384a..5ab2176 100644 --- a/src/pages/docs/reference/module/classes/MethodParameterEncoder.md +++ b/src/pages/docs/reference/module/classes/MethodParameterEncoder.md @@ -10,7 +10,7 @@ title: MethodParameterEncoder # Class: MethodParameterEncoder -Defined in: [module/src/method/MethodParameterEncoder.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L76) +Defined in: [module/src/method/MethodParameterEncoder.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L76) ## Constructors @@ -18,7 +18,7 @@ Defined in: [module/src/method/MethodParameterEncoder.ts:76](https://github.com/ > **new MethodParameterEncoder**(`types`): [`MethodParameterEncoder`](MethodParameterEncoder.md) -Defined in: [module/src/method/MethodParameterEncoder.ts:120](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L120) +Defined in: [module/src/method/MethodParameterEncoder.ts:120](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L120) #### Parameters @@ -36,7 +36,7 @@ Defined in: [module/src/method/MethodParameterEncoder.ts:120](https://github.com > **decode**(`fields`, `auxiliary`): `Promise`\<`ArgArray`\> -Defined in: [module/src/method/MethodParameterEncoder.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L122) +Defined in: [module/src/method/MethodParameterEncoder.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L122) #### Parameters @@ -58,7 +58,7 @@ Defined in: [module/src/method/MethodParameterEncoder.ts:122](https://github.com > **encode**(`args`): `object` -Defined in: [module/src/method/MethodParameterEncoder.ts:184](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L184) +Defined in: [module/src/method/MethodParameterEncoder.ts:184](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L184) Variant of encode() for provable code that skips the unprovable json encoding @@ -87,7 +87,7 @@ json encoding > **fieldSize**(): `number` -Defined in: [module/src/method/MethodParameterEncoder.ts:246](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L246) +Defined in: [module/src/method/MethodParameterEncoder.ts:246](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L246) #### Returns @@ -99,7 +99,7 @@ Defined in: [module/src/method/MethodParameterEncoder.ts:246](https://github.com > `static` **fieldSize**(`type`): `undefined` \| `number` -Defined in: [module/src/method/MethodParameterEncoder.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L109) +Defined in: [module/src/method/MethodParameterEncoder.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L109) #### Parameters @@ -117,7 +117,7 @@ Defined in: [module/src/method/MethodParameterEncoder.ts:109](https://github.com > `static` **fromMethod**(`target`, `methodName`): [`MethodParameterEncoder`](MethodParameterEncoder.md) -Defined in: [module/src/method/MethodParameterEncoder.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/MethodParameterEncoder.ts#L77) +Defined in: [module/src/method/MethodParameterEncoder.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L77) #### Parameters diff --git a/src/pages/docs/reference/module/classes/Runtime.md b/src/pages/docs/reference/module/classes/Runtime.md index 0c37ba6..fc0cd19 100644 --- a/src/pages/docs/reference/module/classes/Runtime.md +++ b/src/pages/docs/reference/module/classes/Runtime.md @@ -10,7 +10,7 @@ title: Runtime # Class: Runtime\ -Defined in: [module/src/runtime/Runtime.ts:270](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L270) +Defined in: [module/src/runtime/Runtime.ts:270](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L270) Wrapper for an application specific runtime, which helps orchestrate runtime modules into an interoperable runtime. @@ -34,7 +34,7 @@ runtime modules into an interoperable runtime. > **new Runtime**\<`Modules`\>(`definition`): [`Runtime`](Runtime.md)\<`Modules`\> -Defined in: [module/src/runtime/Runtime.ts:296](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L296) +Defined in: [module/src/runtime/Runtime.ts:296](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L296) Creates a new Runtime from the provided config @@ -73,7 +73,7 @@ checks when retrieving it via the getter > **definition**: [`RuntimeDefinition`](../interfaces/RuntimeDefinition.md)\<`Modules`\> -Defined in: [module/src/runtime/Runtime.ts:287](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L287) +Defined in: [module/src/runtime/Runtime.ts:287](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L287) #### Overrides @@ -85,7 +85,7 @@ Defined in: [module/src/runtime/Runtime.ts:287](https://github.com/proto-kit/fra > `optional` **program**: `any` -Defined in: [module/src/runtime/Runtime.ts:285](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L285) +Defined in: [module/src/runtime/Runtime.ts:285](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L285) *** @@ -93,7 +93,7 @@ Defined in: [module/src/runtime/Runtime.ts:285](https://github.com/proto-kit/fra > **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> -Defined in: [module/src/runtime/Runtime.ts:289](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L289) +Defined in: [module/src/runtime/Runtime.ts:289](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L289) #### Implementation of @@ -107,7 +107,7 @@ Defined in: [module/src/runtime/Runtime.ts:289](https://github.com/proto-kit/fra > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [module/src/runtime/Runtime.ts:309](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L309) +Defined in: [module/src/runtime/Runtime.ts:309](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L309) ##### Returns @@ -177,7 +177,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:81 > **get** **dependencyContainer**(): `DependencyContainer` -Defined in: [module/src/runtime/Runtime.ts:330](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L330) +Defined in: [module/src/runtime/Runtime.ts:330](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L330) ##### Returns @@ -211,7 +211,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:99 > **get** **methodIdResolver**(): [`MethodIdResolver`](MethodIdResolver.md) -Defined in: [module/src/runtime/Runtime.ts:323](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L323) +Defined in: [module/src/runtime/Runtime.ts:323](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L323) ##### Returns @@ -249,7 +249,7 @@ list of module names > **get** **runtimeModuleNames**(): `string`[] -Defined in: [module/src/runtime/Runtime.ts:382](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L382) +Defined in: [module/src/runtime/Runtime.ts:382](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L382) ##### Returns @@ -265,7 +265,7 @@ A list of names of all the registered module names > **get** **stateService**(): [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) -Defined in: [module/src/runtime/Runtime.ts:319](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L319) +Defined in: [module/src/runtime/Runtime.ts:319](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L319) ##### Returns @@ -283,7 +283,7 @@ Defined in: [module/src/runtime/Runtime.ts:319](https://github.com/proto-kit/fra > **get** **stateServiceProvider**(): [`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) -Defined in: [module/src/runtime/Runtime.ts:313](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L313) +Defined in: [module/src/runtime/Runtime.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L313) ##### Returns @@ -347,7 +347,7 @@ using e.g. a for loop. > **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> -Defined in: [module/src/runtime/Runtime.ts:386](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L386) +Defined in: [module/src/runtime/Runtime.ts:386](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L386) #### Parameters @@ -419,7 +419,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:115 > **create**(`childContainerProvider`): `void` -Defined in: [module/src/runtime/Runtime.ts:303](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L303) +Defined in: [module/src/runtime/Runtime.ts:303](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L303) This is a placeholder for individual modules to override. This method will be called whenever the underlying container fully @@ -445,7 +445,7 @@ initialized > **decorateModule**(`moduleName`, `containedModule`): `void` -Defined in: [module/src/runtime/Runtime.ts:369](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L369) +Defined in: [module/src/runtime/Runtime.ts:369](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L369) Add a name and other respective properties required by RuntimeModules, that come from the current Runtime @@ -476,7 +476,7 @@ Name of the runtime module to decorate > **getMethodById**(`methodId`): `undefined` \| (...`args`) => `Promise`\<`unknown`\> -Defined in: [module/src/runtime/Runtime.ts:338](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L338) +Defined in: [module/src/runtime/Runtime.ts:338](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L338) #### Parameters @@ -765,7 +765,7 @@ such as only injecting other known modules. > `static` **from**\<`Modules`\>(`definition`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](Runtime.md)\<`Modules`\>\> -Defined in: [module/src/runtime/Runtime.ts:274](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L274) +Defined in: [module/src/runtime/Runtime.ts:274](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L274) #### Type Parameters diff --git a/src/pages/docs/reference/module/classes/RuntimeEvents.md b/src/pages/docs/reference/module/classes/RuntimeEvents.md index 967891b..f48c3c5 100644 --- a/src/pages/docs/reference/module/classes/RuntimeEvents.md +++ b/src/pages/docs/reference/module/classes/RuntimeEvents.md @@ -10,7 +10,7 @@ title: RuntimeEvents # Class: RuntimeEvents\ -Defined in: [module/src/runtime/RuntimeModule.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L25) +Defined in: [module/src/runtime/RuntimeModule.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L25) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:25](https://github.com/proto-ki > **new RuntimeEvents**\<`Events`\>(`events`): [`RuntimeEvents`](RuntimeEvents.md)\<`Events`\> -Defined in: [module/src/runtime/RuntimeModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L26) +Defined in: [module/src/runtime/RuntimeModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L26) #### Parameters @@ -40,7 +40,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:26](https://github.com/proto-ki > **emit**\<`Key`\>(`eventName`, `event`): `void` -Defined in: [module/src/runtime/RuntimeModule.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L47) +Defined in: [module/src/runtime/RuntimeModule.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L47) #### Type Parameters @@ -66,7 +66,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:47](https://github.com/proto-ki > **emitIf**\<`Key`\>(`condition`, `eventName`, `event`): `void` -Defined in: [module/src/runtime/RuntimeModule.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L28) +Defined in: [module/src/runtime/RuntimeModule.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L28) #### Type Parameters diff --git a/src/pages/docs/reference/module/classes/RuntimeModule.md b/src/pages/docs/reference/module/classes/RuntimeModule.md index 1f35921..9aeb25e 100644 --- a/src/pages/docs/reference/module/classes/RuntimeModule.md +++ b/src/pages/docs/reference/module/classes/RuntimeModule.md @@ -10,7 +10,7 @@ title: RuntimeModule # Class: RuntimeModule\ -Defined in: [module/src/runtime/RuntimeModule.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L59) +Defined in: [module/src/runtime/RuntimeModule.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L59) Base class for runtime modules providing the necessary utilities. @@ -33,7 +33,7 @@ Base class for runtime modules providing the necessary utilities. > **new RuntimeModule**\<`Config`\>(): [`RuntimeModule`](RuntimeModule.md)\<`Config`\> -Defined in: [module/src/runtime/RuntimeModule.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L82) +Defined in: [module/src/runtime/RuntimeModule.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L82) #### Returns @@ -64,7 +64,7 @@ checks when retrieving it via the getter > `optional` **events**: [`RuntimeEvents`](RuntimeEvents.md)\<`any`\> = `undefined` -Defined in: [module/src/runtime/RuntimeModule.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L80) +Defined in: [module/src/runtime/RuntimeModule.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L80) *** @@ -72,7 +72,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:80](https://github.com/proto-ki > **isRuntimeModule**: `boolean` = `true` -Defined in: [module/src/runtime/RuntimeModule.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L74) +Defined in: [module/src/runtime/RuntimeModule.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L74) This property exists only to typecheck that the RuntimeModule was extended correctly in e.g. a decorator. We need at least @@ -84,7 +84,7 @@ one non-optional property in this class to make the typechecking work. > `optional` **name**: `string` -Defined in: [module/src/runtime/RuntimeModule.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L76) +Defined in: [module/src/runtime/RuntimeModule.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L76) *** @@ -92,7 +92,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:76](https://github.com/proto-ki > `optional` **runtime**: [`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md) -Defined in: [module/src/runtime/RuntimeModule.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L78) +Defined in: [module/src/runtime/RuntimeModule.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L78) *** @@ -100,7 +100,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:78](https://github.com/proto-ki > `readonly` **runtimeMethodNames**: `string`[] = `[]` -Defined in: [module/src/runtime/RuntimeModule.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L67) +Defined in: [module/src/runtime/RuntimeModule.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L67) Holds all method names that are callable throw transactions @@ -110,7 +110,7 @@ Holds all method names that are callable throw transactions > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [module/src/runtime/RuntimeModule.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L62) +Defined in: [module/src/runtime/RuntimeModule.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L62) ## Accessors @@ -154,7 +154,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **get** **network**(): [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [module/src/runtime/RuntimeModule.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L109) +Defined in: [module/src/runtime/RuntimeModule.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L109) ##### Returns @@ -168,7 +168,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:109](https://github.com/proto-k > **get** **transaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) -Defined in: [module/src/runtime/RuntimeModule.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L105) +Defined in: [module/src/runtime/RuntimeModule.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L105) ##### Returns @@ -202,7 +202,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **getInputs**(): [`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) -Defined in: [module/src/runtime/RuntimeModule.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeModule.ts#L92) +Defined in: [module/src/runtime/RuntimeModule.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L92) #### Returns diff --git a/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md b/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md index 65d8bc9..9c958d8 100644 --- a/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md +++ b/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md @@ -10,7 +10,7 @@ title: RuntimeZkProgrammable # Class: RuntimeZkProgrammable\ -Defined in: [module/src/runtime/Runtime.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L77) +Defined in: [module/src/runtime/Runtime.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L77) ## Extends @@ -26,7 +26,7 @@ Defined in: [module/src/runtime/Runtime.ts:77](https://github.com/proto-kit/fram > **new RuntimeZkProgrammable**\<`Modules`\>(`runtime`): [`RuntimeZkProgrammable`](RuntimeZkProgrammable.md)\<`Modules`\> -Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L80) +Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L80) #### Parameters @@ -48,7 +48,7 @@ Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/fram > **runtime**: [`Runtime`](Runtime.md)\<`Modules`\> -Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L80) +Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L80) ## Accessors @@ -58,7 +58,7 @@ Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/fram > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [module/src/runtime/Runtime.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L84) +Defined in: [module/src/runtime/Runtime.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L84) ##### Returns @@ -114,7 +114,7 @@ Defined in: common/dist/zkProgrammable/ZkProgrammable.d.ts:35 > **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\>[] -Defined in: [module/src/runtime/Runtime.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L88) +Defined in: [module/src/runtime/Runtime.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L88) #### Returns diff --git a/src/pages/docs/reference/module/functions/combineMethodName.md b/src/pages/docs/reference/module/functions/combineMethodName.md index ab40125..5e929c9 100644 --- a/src/pages/docs/reference/module/functions/combineMethodName.md +++ b/src/pages/docs/reference/module/functions/combineMethodName.md @@ -12,7 +12,7 @@ title: combineMethodName > **combineMethodName**(`runtimeModuleName`, `methodName`): `string` -Defined in: [module/src/method/runtimeMethod.ts:163](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L163) +Defined in: [module/src/method/runtimeMethod.ts:163](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L163) ## Parameters diff --git a/src/pages/docs/reference/module/functions/getAllPropertyNames.md b/src/pages/docs/reference/module/functions/getAllPropertyNames.md index 182e77b..a6951ae 100644 --- a/src/pages/docs/reference/module/functions/getAllPropertyNames.md +++ b/src/pages/docs/reference/module/functions/getAllPropertyNames.md @@ -12,7 +12,7 @@ title: getAllPropertyNames > **getAllPropertyNames**(`obj`): (`string` \| `symbol`)[] -Defined in: [module/src/runtime/Runtime.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L39) +Defined in: [module/src/runtime/Runtime.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L39) ## Parameters diff --git a/src/pages/docs/reference/module/functions/isRuntimeMethod.md b/src/pages/docs/reference/module/functions/isRuntimeMethod.md index 14f8525..bee55e9 100644 --- a/src/pages/docs/reference/module/functions/isRuntimeMethod.md +++ b/src/pages/docs/reference/module/functions/isRuntimeMethod.md @@ -12,7 +12,7 @@ title: isRuntimeMethod > **isRuntimeMethod**(`target`, `propertyKey`): `boolean` -Defined in: [module/src/method/runtimeMethod.ts:182](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L182) +Defined in: [module/src/method/runtimeMethod.ts:182](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L182) Checks the metadata of the provided runtime module and its method, to see if it has been decorated with @runtimeMethod() diff --git a/src/pages/docs/reference/module/functions/runtimeMessage.md b/src/pages/docs/reference/module/functions/runtimeMessage.md index 911ae89..8feeac7 100644 --- a/src/pages/docs/reference/module/functions/runtimeMessage.md +++ b/src/pages/docs/reference/module/functions/runtimeMessage.md @@ -12,7 +12,7 @@ title: runtimeMessage > **runtimeMessage**(): (`target`, `methodName`, `descriptor`) => `void` -Defined in: [module/src/method/runtimeMethod.ts:297](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L297) +Defined in: [module/src/method/runtimeMethod.ts:297](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L297) ## Returns diff --git a/src/pages/docs/reference/module/functions/runtimeMethod.md b/src/pages/docs/reference/module/functions/runtimeMethod.md index fc85080..ad0ed78 100644 --- a/src/pages/docs/reference/module/functions/runtimeMethod.md +++ b/src/pages/docs/reference/module/functions/runtimeMethod.md @@ -12,7 +12,7 @@ title: runtimeMethod > **runtimeMethod**(): (`target`, `methodName`, `descriptor`) => `void` -Defined in: [module/src/method/runtimeMethod.ts:303](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L303) +Defined in: [module/src/method/runtimeMethod.ts:303](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L303) ## Returns diff --git a/src/pages/docs/reference/module/functions/runtimeModule.md b/src/pages/docs/reference/module/functions/runtimeModule.md index 76d869f..95bdab2 100644 --- a/src/pages/docs/reference/module/functions/runtimeModule.md +++ b/src/pages/docs/reference/module/functions/runtimeModule.md @@ -12,7 +12,7 @@ title: runtimeModule > **runtimeModule**(): (`target`) => `void` -Defined in: [module/src/module/decorator.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/module/decorator.ts#L10) +Defined in: [module/src/module/decorator.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/module/decorator.ts#L10) Marks the decorated class as a runtime module, while also making it injectable with our dependency injection solution. diff --git a/src/pages/docs/reference/module/functions/state.md b/src/pages/docs/reference/module/functions/state.md index 84c7701..e6b5c64 100644 --- a/src/pages/docs/reference/module/functions/state.md +++ b/src/pages/docs/reference/module/functions/state.md @@ -12,7 +12,7 @@ title: state > **state**(): \<`TargetRuntimeModule`\>(`target`, `propertyKey`) => `void` -Defined in: [module/src/state/decorator.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/state/decorator.ts#L23) +Defined in: [module/src/state/decorator.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/state/decorator.ts#L23) Decorates a runtime module property as state, passing down some underlying values to improve developer experience. diff --git a/src/pages/docs/reference/module/functions/toEventsHash.md b/src/pages/docs/reference/module/functions/toEventsHash.md index ee595d9..a0a1e9c 100644 --- a/src/pages/docs/reference/module/functions/toEventsHash.md +++ b/src/pages/docs/reference/module/functions/toEventsHash.md @@ -12,7 +12,7 @@ title: toEventsHash > **toEventsHash**(`events`): `Field` -Defined in: [module/src/method/runtimeMethod.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L56) +Defined in: [module/src/method/runtimeMethod.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L56) ## Parameters diff --git a/src/pages/docs/reference/module/functions/toStateTransitionsHash.md b/src/pages/docs/reference/module/functions/toStateTransitionsHash.md index 981440f..1d15b32 100644 --- a/src/pages/docs/reference/module/functions/toStateTransitionsHash.md +++ b/src/pages/docs/reference/module/functions/toStateTransitionsHash.md @@ -12,7 +12,7 @@ title: toStateTransitionsHash > **toStateTransitionsHash**(`stateTransitions`): `Field` -Defined in: [module/src/method/runtimeMethod.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L39) +Defined in: [module/src/method/runtimeMethod.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L39) ## Parameters diff --git a/src/pages/docs/reference/module/functions/toWrappedMethod.md b/src/pages/docs/reference/module/functions/toWrappedMethod.md index 575bd31..3dcaeca 100644 --- a/src/pages/docs/reference/module/functions/toWrappedMethod.md +++ b/src/pages/docs/reference/module/functions/toWrappedMethod.md @@ -12,7 +12,7 @@ title: toWrappedMethod > **toWrappedMethod**(`this`, `methodName`, `moduleMethod`, `options`): [`AsyncWrappedMethod`](../type-aliases/AsyncWrappedMethod.md) -Defined in: [module/src/method/runtimeMethod.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L76) +Defined in: [module/src/method/runtimeMethod.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L76) ## Parameters diff --git a/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md b/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md index ced5107..0d8b0c4 100644 --- a/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md +++ b/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md @@ -10,7 +10,7 @@ title: RuntimeDefinition # Interface: RuntimeDefinition\ -Defined in: [module/src/runtime/Runtime.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L72) +Defined in: [module/src/runtime/Runtime.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L72) Definition / required arguments for the Runtime class @@ -24,7 +24,7 @@ Definition / required arguments for the Runtime class > `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> -Defined in: [module/src/runtime/Runtime.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L74) +Defined in: [module/src/runtime/Runtime.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L74) *** @@ -32,4 +32,4 @@ Defined in: [module/src/runtime/Runtime.ts:74](https://github.com/proto-kit/fram > **modules**: `Modules` -Defined in: [module/src/runtime/Runtime.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L73) +Defined in: [module/src/runtime/Runtime.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L73) diff --git a/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md b/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md index c6d1ea7..ef07640 100644 --- a/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md +++ b/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md @@ -10,7 +10,7 @@ title: RuntimeEnvironment # Interface: RuntimeEnvironment -Defined in: [module/src/runtime/RuntimeEnvironment.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeEnvironment.ts#L10) +Defined in: [module/src/runtime/RuntimeEnvironment.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeEnvironment.ts#L10) ## Extends @@ -36,7 +36,7 @@ Defined in: common/dist/zkProgrammable/ZkProgrammable.d.ts:38 > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [module/src/runtime/RuntimeEnvironment.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeEnvironment.ts#L12) +Defined in: [module/src/runtime/RuntimeEnvironment.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeEnvironment.ts#L12) ##### Returns @@ -50,7 +50,7 @@ Defined in: [module/src/runtime/RuntimeEnvironment.ts:12](https://github.com/pro > **get** **methodIdResolver**(): [`MethodIdResolver`](../classes/MethodIdResolver.md) -Defined in: [module/src/runtime/RuntimeEnvironment.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeEnvironment.ts#L15) +Defined in: [module/src/runtime/RuntimeEnvironment.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeEnvironment.ts#L15) ##### Returns @@ -64,7 +64,7 @@ Defined in: [module/src/runtime/RuntimeEnvironment.ts:15](https://github.com/pro > **get** **stateService**(): [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) -Defined in: [module/src/runtime/RuntimeEnvironment.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeEnvironment.ts#L13) +Defined in: [module/src/runtime/RuntimeEnvironment.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeEnvironment.ts#L13) ##### Returns @@ -78,7 +78,7 @@ Defined in: [module/src/runtime/RuntimeEnvironment.ts:13](https://github.com/pro > **get** **stateServiceProvider**(): [`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) -Defined in: [module/src/runtime/RuntimeEnvironment.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/RuntimeEnvironment.ts#L14) +Defined in: [module/src/runtime/RuntimeEnvironment.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeEnvironment.ts#L14) ##### Returns diff --git a/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md b/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md index 9eff9d2..65f9ddf 100644 --- a/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md +++ b/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md @@ -12,7 +12,7 @@ title: AsyncWrappedMethod > **AsyncWrappedMethod**: (...`args`) => `Promise`\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> -Defined in: [module/src/method/runtimeMethod.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L72) +Defined in: [module/src/method/runtimeMethod.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L72) ## Parameters diff --git a/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md b/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md index 7301540..35b9cea 100644 --- a/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md +++ b/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md @@ -12,4 +12,4 @@ title: RuntimeMethodInvocationType > **RuntimeMethodInvocationType**: `"SIGNATURE"` \| `"INCOMING_MESSAGE"` -Defined in: [module/src/method/runtimeMethod.ts:191](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L191) +Defined in: [module/src/method/runtimeMethod.ts:191](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L191) diff --git a/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md b/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md index 3a34196..fc46ac7 100644 --- a/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md +++ b/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md @@ -12,7 +12,7 @@ title: RuntimeModulesRecord > **RuntimeModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\>\>\> -Defined in: [module/src/runtime/Runtime.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/runtime/Runtime.ts#L60) +Defined in: [module/src/runtime/Runtime.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L60) Record of modules accepted by the Runtime module container. diff --git a/src/pages/docs/reference/module/type-aliases/WrappedMethod.md b/src/pages/docs/reference/module/type-aliases/WrappedMethod.md index 27f3869..184f65f 100644 --- a/src/pages/docs/reference/module/type-aliases/WrappedMethod.md +++ b/src/pages/docs/reference/module/type-aliases/WrappedMethod.md @@ -12,7 +12,7 @@ title: WrappedMethod > **WrappedMethod**: (...`args`) => [`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md) -Defined in: [module/src/method/runtimeMethod.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L71) +Defined in: [module/src/method/runtimeMethod.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L71) ## Parameters diff --git a/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md index e348bba..34d5e75 100644 --- a/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md +++ b/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md @@ -12,4 +12,4 @@ title: runtimeMethodMetadataKey > `const` **runtimeMethodMetadataKey**: `"yab-method"` = `"yab-method"` -Defined in: [module/src/method/runtimeMethod.ts:170](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L170) +Defined in: [module/src/method/runtimeMethod.ts:170](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L170) diff --git a/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md index f2dff12..33a0890 100644 --- a/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md +++ b/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md @@ -12,4 +12,4 @@ title: runtimeMethodNamesMetadataKey > `const` **runtimeMethodNamesMetadataKey**: `"proto-kit-runtime-methods"` = `"proto-kit-runtime-methods"` -Defined in: [module/src/method/runtimeMethod.ts:171](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L171) +Defined in: [module/src/method/runtimeMethod.ts:171](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L171) diff --git a/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md index 7c0fa82..8e155ad 100644 --- a/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md +++ b/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md @@ -12,4 +12,4 @@ title: runtimeMethodTypeMetadataKey > `const` **runtimeMethodTypeMetadataKey**: `"proto-kit-runtime-method-type"` = `"proto-kit-runtime-method-type"` -Defined in: [module/src/method/runtimeMethod.ts:172](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/module/src/method/runtimeMethod.ts#L172) +Defined in: [module/src/method/runtimeMethod.ts:172](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L172) diff --git a/src/pages/docs/reference/persistance/_meta.tsx b/src/pages/docs/reference/persistance/_meta.tsx index 62983bf..9304eb2 100644 --- a/src/pages/docs/reference/persistance/_meta.tsx +++ b/src/pages/docs/reference/persistance/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","interfaces": "Interfaces","type-aliases": "Type Aliases" + "README": "Overview","classes": "Classes","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases" }; \ No newline at end of file diff --git a/src/pages/docs/reference/persistance/classes/BatchMapper.md b/src/pages/docs/reference/persistance/classes/BatchMapper.md index ae0b039..ba15ea5 100644 --- a/src/pages/docs/reference/persistance/classes/BatchMapper.md +++ b/src/pages/docs/reference/persistance/classes/BatchMapper.md @@ -10,7 +10,7 @@ title: BatchMapper # Class: BatchMapper -Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L9) +Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L9) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:9]( > **mapIn**(`input`): [`Batch`](../../sequencer/interfaces/Batch.md) -Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L12) +Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L12) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:12] > **mapOut**(`input`): \[\{ `height`: `number`; `proof`: `JsonValue`; `settlementTransactionHash`: `null` \| `string`; \}, `string`[]\] -Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L20) +Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L20) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/BlockMapper.md b/src/pages/docs/reference/persistance/classes/BlockMapper.md index 16f65f1..82e9f3d 100644 --- a/src/pages/docs/reference/persistance/classes/BlockMapper.md +++ b/src/pages/docs/reference/persistance/classes/BlockMapper.md @@ -10,7 +10,7 @@ title: BlockMapper # Class: BlockMapper -Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L10) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L10) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:10] > **mapIn**(`input`): [`Block`](../../sequencer/interfaces/Block.md) -Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L11) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L11) #### Parameters @@ -100,7 +100,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:11] > **mapOut**(`input`): `object` -Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L40) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L40) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/BlockResultMapper.md b/src/pages/docs/reference/persistance/classes/BlockResultMapper.md index c091900..c527c47 100644 --- a/src/pages/docs/reference/persistance/classes/BlockResultMapper.md +++ b/src/pages/docs/reference/persistance/classes/BlockResultMapper.md @@ -10,7 +10,7 @@ title: BlockResultMapper # Class: BlockResultMapper -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L11) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L11) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper. > **new BlockResultMapper**(`stArrayMapper`): [`BlockResultMapper`](BlockResultMapper.md) -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L14) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L14) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper. > **mapIn**(`input`): [`BlockResult`](../../sequencer/interfaces/BlockResult.md) -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L18) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L18) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper. > **mapOut**(`input`): `object` -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L38) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L38) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/FieldMapper.md b/src/pages/docs/reference/persistance/classes/FieldMapper.md index cb36416..392fb2e 100644 --- a/src/pages/docs/reference/persistance/classes/FieldMapper.md +++ b/src/pages/docs/reference/persistance/classes/FieldMapper.md @@ -10,7 +10,7 @@ title: FieldMapper # Class: FieldMapper -Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L7) +Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L7) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:7]( > **mapIn**(`input`): `Field`[] -Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L8) +Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L8) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:8]( > **mapOut**(`input`): `string` -Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L12) +Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L12) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md b/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md index b325cae..2b4cd9c 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md +++ b/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md @@ -10,7 +10,7 @@ title: PrismaBatchStore # Class: PrismaBatchStore -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L14) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L14) ## Implements @@ -23,7 +23,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:14](ht > **new PrismaBatchStore**(`connection`, `batchMapper`): [`PrismaBatchStore`](PrismaBatchStore.md) -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L15) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L15) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:15](ht > **getBatchAt**(`height`): `Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L20) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L20) #### Parameters @@ -67,7 +67,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:20](ht > **getCurrentBatchHeight**(): `Promise`\<`number`\> -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L42) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L42) #### Returns @@ -83,7 +83,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:42](ht > **getLatestBatch**(): `Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L71) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L71) #### Returns @@ -99,7 +99,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:71](ht > **pushBatch**(`batch`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L51) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L51) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md b/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md index 203f5e6..abcb480 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md +++ b/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md @@ -10,7 +10,7 @@ title: PrismaBlockStorage # Class: PrismaBlockStorage -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L30) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L30) ## Implements @@ -24,7 +24,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:30]( > **new PrismaBlockStorage**(`connection`, `transactionResultMapper`, `transactionMapper`, `blockResultMapper`, `blockMapper`): [`PrismaBlockStorage`](PrismaBlockStorage.md) -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L33) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L33) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:33]( > **getBlock**(`hash`): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L77) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L77) #### Parameters @@ -80,7 +80,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:77]( > **getBlockAt**(`height`): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L73) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L73) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:73]( > **getCurrentBlockHeight**(): `Promise`\<`number`\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:157](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L157) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:157](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L157) #### Returns @@ -118,7 +118,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:157] > **getLatestBlock**(): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:185](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L185) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:185](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L185) #### Returns @@ -134,7 +134,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:185] > **getLatestBlockAndResult**(): `Promise`\<`undefined` \| [`BlockWithMaybeResult`](../../sequencer/interfaces/BlockWithMaybeResult.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:167](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L167) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:167](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L167) #### Returns @@ -150,7 +150,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:167] > **getNewBlocks**(): `Promise`\<[`BlockWithPreviousResult`](../../sequencer/interfaces/BlockWithPreviousResult.md)[]\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:201](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L201) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:201](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L201) #### Returns @@ -166,7 +166,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:201] > **pushBlock**(`block`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L81) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L81) #### Parameters @@ -188,7 +188,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:81]( > **pushResult**(`result`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:139](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L139) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:139](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L139) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md b/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md index e7886ac..4b0d993 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md +++ b/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md @@ -10,7 +10,7 @@ title: PrismaDatabaseConnection # Class: PrismaDatabaseConnection -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L37) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L37) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -115,7 +115,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **get** **prismaClient**(): `PrismaClient`\<`never`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L43) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L43) ##### Returns @@ -131,7 +131,7 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:43](https://gi > **close**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:137](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L137) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:137](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L137) #### Returns @@ -165,7 +165,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): [`OmitKeys`](../../common/type-aliases/OmitKeys.md)\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L50) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L50) #### Returns @@ -181,7 +181,7 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:50](https://gi > **executeInTransaction**(`f`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:141](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L141) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:141](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L141) #### Parameters @@ -199,7 +199,7 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:141](https://g > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L82) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L82) #### Returns @@ -211,7 +211,7 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:82](https://gi > **start**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:117](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L117) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:117](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L117) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md b/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md index 79fd0b9..ec1610a 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md +++ b/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md @@ -10,7 +10,7 @@ title: PrismaMessageStorage # Class: PrismaMessageStorage -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L9) +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L9) Interface to store Messages previously fetched by a IncomingMessageadapter @@ -24,7 +24,7 @@ Interface to store Messages previously fetched by a IncomingMessageadapter > **new PrismaMessageStorage**(`connection`, `transactionMapper`): [`PrismaMessageStorage`](PrismaMessageStorage.md) -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L10) +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L10) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:10 > **getMessages**(`fromMessageHash`): `Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L15) +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L15) #### Parameters @@ -68,7 +68,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:15 > **pushMessages**(`fromMessageHash`, `toMessageHash`, `messages`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L44) +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L44) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md b/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md index 6cdaff8..d530929 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md +++ b/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md @@ -10,7 +10,7 @@ title: PrismaRedisDatabase # Class: PrismaRedisDatabase -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L31) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L31) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -39,7 +39,7 @@ deps that are necessary for the sequencer to work. > **new PrismaRedisDatabase**(): [`PrismaRedisDatabase`](PrismaRedisDatabase.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L39) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L39) #### Returns @@ -70,7 +70,7 @@ checks when retrieving it via the getter > **prisma**: [`PrismaDatabaseConnection`](PrismaDatabaseConnection.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L35) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L35) *** @@ -78,7 +78,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:35](https://github. > **redis**: [`RedisConnectionModule`](RedisConnectionModule.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L37) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L37) *** @@ -134,7 +134,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L53) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L53) ##### Returns @@ -152,7 +152,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:53](https://github. > **get** **prismaClient**(): `PrismaClient`\<`never`\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L45) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L45) ##### Returns @@ -170,7 +170,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:45](https://github. > **get** **redisClient**(): `RedisClientType` -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L49) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L49) ##### Returns @@ -186,7 +186,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:49](https://github. > **close**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L78) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L78) #### Returns @@ -202,7 +202,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:78](https://github. > **create**(`childContainerProvider`): `void` -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L57) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L57) #### Parameters @@ -224,7 +224,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:57](https://github. > **dependencies**(): [`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L63) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L63) #### Returns @@ -240,7 +240,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:63](https://github. > **executeInTransaction**(`f`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L88) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L88) #### Parameters @@ -262,7 +262,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:88](https://github. > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L83) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L83) Prunes all data from the database connection. Note: This function should only be called immediately at startup, @@ -282,7 +282,7 @@ everything else will lead to unexpected behaviour and errors > **start**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L70) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L70) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md b/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md index 0f1c2d6..0c288f5 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md +++ b/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md @@ -10,7 +10,7 @@ title: PrismaSettlementStorage # Class: PrismaSettlementStorage -Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L9) +Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L9) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts > **new PrismaSettlementStorage**(`connection`, `settlementMapper`): [`PrismaSettlementStorage`](PrismaSettlementStorage.md) -Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L10) +Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L10) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts > **pushSettlement**(`settlement`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L15) +Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L15) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaStateService.md b/src/pages/docs/reference/persistance/classes/PrismaStateService.md index fa6e1c4..b0e7052 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaStateService.md +++ b/src/pages/docs/reference/persistance/classes/PrismaStateService.md @@ -10,7 +10,7 @@ title: PrismaStateService # Class: PrismaStateService -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L16) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L16) This Interface should be implemented for services that store the state in an external storage (like a DB). This can be used in conjunction with @@ -26,7 +26,7 @@ CachedStateService to preload keys for In-Circuit usage. > **new PrismaStateService**(`connection`, `mask`): [`PrismaStateService`](PrismaStateService.md) -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L23) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L23) #### Parameters @@ -50,7 +50,7 @@ A indicator to which masking level the values belong > **commit**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L28) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L28) #### Returns @@ -66,7 +66,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:28]( > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L79) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L79) #### Parameters @@ -88,7 +88,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:79]( > **getMany**(`keys`): `Promise`\<[`StateEntry`](../../sequencer/interfaces/StateEntry.md)[]\> -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L54) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L54) #### Parameters @@ -110,7 +110,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:54]( > **openTransaction**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L75) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L75) #### Returns @@ -126,7 +126,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:75]( > **writeStates**(`entries`): `void` -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaStateService.ts#L84) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L84) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md b/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md index 03fee94..497025c 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md +++ b/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md @@ -10,7 +10,7 @@ title: PrismaTransactionStorage # Class: PrismaTransactionStorage -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L9) +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L9) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.t > **new PrismaTransactionStorage**(`connection`, `transactionMapper`): [`PrismaTransactionStorage`](PrismaTransactionStorage.md) -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L10) +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L10) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.t > **findTransaction**(`hash`): `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md); \}\> -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L42) +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L42) Finds a transaction by its hash. It returns both pending transaction and already included transactions @@ -71,7 +71,7 @@ and batch number where applicable. > **getPendingUserTransactions**(): `Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L15) +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L15) #### Returns @@ -87,7 +87,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.t > **pushUserTransaction**(`tx`): `Promise`\<`boolean`\> -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L31) +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L31) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md b/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md index d81305e..9ac8d4e 100644 --- a/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md +++ b/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md @@ -10,7 +10,7 @@ title: RedisConnectionModule # Class: RedisConnectionModule -Defined in: [packages/persistance/src/RedisConnection.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L24) +Defined in: [packages/persistance/src/RedisConnection.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L24) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -115,7 +115,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> -Defined in: [packages/persistance/src/RedisConnection.ts:91](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L91) +Defined in: [packages/persistance/src/RedisConnection.ts:91](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L91) ##### Returns @@ -133,7 +133,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:91](https://github.com/ > **get** **redisClient**(): `RedisClientType` -Defined in: [packages/persistance/src/RedisConnection.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L30) +Defined in: [packages/persistance/src/RedisConnection.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L30) ##### Returns @@ -149,7 +149,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:30](https://github.com/ > **clearDatabase**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L56) +Defined in: [packages/persistance/src/RedisConnection.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L56) #### Returns @@ -161,7 +161,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:56](https://github.com/ > **close**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L81) +Defined in: [packages/persistance/src/RedisConnection.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L81) #### Returns @@ -195,7 +195,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): `Pick`\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> -Defined in: [packages/persistance/src/RedisConnection.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L39) +Defined in: [packages/persistance/src/RedisConnection.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L39) #### Returns @@ -211,7 +211,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:39](https://github.com/ > **executeInTransaction**(`f`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L98) +Defined in: [packages/persistance/src/RedisConnection.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L98) #### Parameters @@ -229,7 +229,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:98](https://github.com/ > **init**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L60) +Defined in: [packages/persistance/src/RedisConnection.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L60) #### Returns @@ -241,7 +241,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:60](https://github.com/ > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L85) +Defined in: [packages/persistance/src/RedisConnection.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L85) #### Returns @@ -253,7 +253,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:85](https://github.com/ > **start**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L77) +Defined in: [packages/persistance/src/RedisConnection.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L77) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md b/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md index 57a3abf..a6edd2d 100644 --- a/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md +++ b/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md @@ -10,7 +10,7 @@ title: RedisMerkleTreeStore # Class: RedisMerkleTreeStore -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L10) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L10) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:10] > **new RedisMerkleTreeStore**(`connection`, `mask`): [`RedisMerkleTreeStore`](RedisMerkleTreeStore.md) -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L13) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L13) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:13] > **commit**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L26) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L26) #### Returns @@ -60,7 +60,7 @@ Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:26] > **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L48) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L48) #### Parameters @@ -82,7 +82,7 @@ Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:48] > **openTransaction**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L22) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L22) #### Returns @@ -98,7 +98,7 @@ Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:22] > **writeNodes**(`nodes`): `void` -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L62) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L62) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/SettlementMapper.md b/src/pages/docs/reference/persistance/classes/SettlementMapper.md index 8208860..aa5ca7a 100644 --- a/src/pages/docs/reference/persistance/classes/SettlementMapper.md +++ b/src/pages/docs/reference/persistance/classes/SettlementMapper.md @@ -10,7 +10,7 @@ title: SettlementMapper # Class: SettlementMapper -Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L8) +Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L8) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.t > **mapIn**(`input`): [`Settlement`](../../sequencer/interfaces/Settlement.md) -Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L11) +Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L11) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.t > **mapOut**(`input`): \[\{ `promisedMessagesHash`: `string`; `transactionHash`: `string`; \}, `number`[]\] -Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L21) +Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L21) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md b/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md index 9d65ed5..28c3e00 100644 --- a/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md +++ b/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md @@ -10,7 +10,7 @@ title: StateTransitionArrayMapper # Class: StateTransitionArrayMapper -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L22) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L22) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMap > **new StateTransitionArrayMapper**(`stMapper`): [`StateTransitionArrayMapper`](StateTransitionArrayMapper.md) -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L26) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L26) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMap > **mapIn**(`input`): [`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md)[] -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L28) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L28) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMap > **mapOut**(`input`): `JsonValue` -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L39) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L39) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md b/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md index e2951d0..efd1ad2 100644 --- a/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md +++ b/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md @@ -10,7 +10,7 @@ title: StateTransitionMapper # Class: StateTransitionMapper -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L8) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L8) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMap > **mapIn**(`input`): [`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md) -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L11) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L11) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMap > **mapOut**(`input`): `JsonObject` -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L16) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md b/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md index 7647b77..e14bfed 100644 --- a/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md +++ b/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md @@ -10,7 +10,7 @@ title: TransactionExecutionResultMapper # Class: TransactionExecutionResultMapper -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L49) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L49) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper. > **new TransactionExecutionResultMapper**(`transactionMapper`, `stArrayMapper`, `eventArrayMapper`): [`TransactionExecutionResultMapper`](TransactionExecutionResultMapper.md) -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L56) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L56) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper. > **mapIn**(`input`): [`TransactionExecutionResult`](../../sequencer/interfaces/TransactionExecutionResult.md) -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L62) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L62) #### Parameters @@ -70,7 +70,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper. > **mapOut**(`input`): \[`Omit`\<\{ `blockHash`: `string`; `events`: `JsonValue`; `protocolTransitions`: `JsonValue`; `stateTransitions`: `JsonValue`; `status`: `boolean`; `statusMessage`: `null` \| `string`; `txHash`: `string`; \}, `"blockHash"`\>, \{ `argsFields`: `string`[]; `auxiliaryData`: `string`[]; `hash`: `string`; `isMessage`: `boolean`; `methodId`: `string`; `nonce`: `string`; `sender`: `string`; `signature_r`: `string`; `signature_s`: `string`; \}\] -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L80) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L80) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/TransactionMapper.md b/src/pages/docs/reference/persistance/classes/TransactionMapper.md index b41e066..ae7acc4 100644 --- a/src/pages/docs/reference/persistance/classes/TransactionMapper.md +++ b/src/pages/docs/reference/persistance/classes/TransactionMapper.md @@ -10,7 +10,7 @@ title: TransactionMapper # Class: TransactionMapper -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L19) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L19) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper. > **mapIn**(`input`): [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L22) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L22) #### Parameters @@ -88,7 +88,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper. > **mapOut**(`input`): `object` -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L32) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L32) #### Parameters diff --git a/src/pages/docs/reference/persistance/globals.md b/src/pages/docs/reference/persistance/globals.md new file mode 100644 index 0000000..4ad8e34 --- /dev/null +++ b/src/pages/docs/reference/persistance/globals.md @@ -0,0 +1,45 @@ +--- +title: "@proto-kit/persistance" +--- + +[**@proto-kit/persistance**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/persistance + +# @proto-kit/persistance + +## Classes + +- [BatchMapper](classes/BatchMapper.md) +- [BlockMapper](classes/BlockMapper.md) +- [BlockResultMapper](classes/BlockResultMapper.md) +- [FieldMapper](classes/FieldMapper.md) +- [PrismaBatchStore](classes/PrismaBatchStore.md) +- [PrismaBlockStorage](classes/PrismaBlockStorage.md) +- [PrismaDatabaseConnection](classes/PrismaDatabaseConnection.md) +- [PrismaMessageStorage](classes/PrismaMessageStorage.md) +- [PrismaRedisDatabase](classes/PrismaRedisDatabase.md) +- [PrismaSettlementStorage](classes/PrismaSettlementStorage.md) +- [PrismaStateService](classes/PrismaStateService.md) +- [PrismaTransactionStorage](classes/PrismaTransactionStorage.md) +- [RedisConnectionModule](classes/RedisConnectionModule.md) +- [RedisMerkleTreeStore](classes/RedisMerkleTreeStore.md) +- [SettlementMapper](classes/SettlementMapper.md) +- [StateTransitionArrayMapper](classes/StateTransitionArrayMapper.md) +- [StateTransitionMapper](classes/StateTransitionMapper.md) +- [TransactionExecutionResultMapper](classes/TransactionExecutionResultMapper.md) +- [TransactionMapper](classes/TransactionMapper.md) + +## Interfaces + +- [PrismaConnection](interfaces/PrismaConnection.md) +- [PrismaDatabaseConfig](interfaces/PrismaDatabaseConfig.md) +- [PrismaRedisCombinedConfig](interfaces/PrismaRedisCombinedConfig.md) +- [RedisConnection](interfaces/RedisConnection.md) +- [RedisConnectionConfig](interfaces/RedisConnectionConfig.md) + +## Type Aliases + +- [RedisTransaction](type-aliases/RedisTransaction.md) diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md b/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md index 3e0e16e..a6e230e 100644 --- a/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md +++ b/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md @@ -10,7 +10,7 @@ title: PrismaConnection # Interface: PrismaConnection -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L32) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L32) ## Accessors @@ -20,7 +20,7 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:32](https://gi > **get** **prismaClient**(): `PrismaClient`\<`never`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L33) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L33) ##### Returns diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md b/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md index 5fb4f1d..e56a68e 100644 --- a/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md +++ b/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md @@ -10,7 +10,7 @@ title: PrismaDatabaseConfig # Interface: PrismaDatabaseConfig -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L16) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L16) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:16](https://gi > `optional` **connection**: `string` \| \{ `db`: \{ `name`: `string`; `schema`: `string`; \}; `host`: `string`; `password`: `string`; `port`: `number`; `username`: `string`; \} -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaDatabaseConnection.ts#L18) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L18) diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md b/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md index 3b98b43..fb158ed 100644 --- a/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md +++ b/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md @@ -10,7 +10,7 @@ title: PrismaRedisCombinedConfig # Interface: PrismaRedisCombinedConfig -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L24) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L24) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:24](https://github. > **prisma**: [`PrismaDatabaseConfig`](PrismaDatabaseConfig.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L25) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L25) *** @@ -26,4 +26,4 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:25](https://github. > **redis**: [`RedisConnectionConfig`](RedisConnectionConfig.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/PrismaRedisDatabase.ts#L26) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L26) diff --git a/src/pages/docs/reference/persistance/interfaces/RedisConnection.md b/src/pages/docs/reference/persistance/interfaces/RedisConnection.md index 8200174..eca65b9 100644 --- a/src/pages/docs/reference/persistance/interfaces/RedisConnection.md +++ b/src/pages/docs/reference/persistance/interfaces/RedisConnection.md @@ -10,7 +10,7 @@ title: RedisConnection # Interface: RedisConnection -Defined in: [packages/persistance/src/RedisConnection.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L19) +Defined in: [packages/persistance/src/RedisConnection.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L19) ## Accessors @@ -20,7 +20,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:19](https://github.com/ > **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> -Defined in: [packages/persistance/src/RedisConnection.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L21) +Defined in: [packages/persistance/src/RedisConnection.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L21) ##### Returns @@ -34,7 +34,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:21](https://github.com/ > **get** **redisClient**(): `RedisClientType` -Defined in: [packages/persistance/src/RedisConnection.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L20) +Defined in: [packages/persistance/src/RedisConnection.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L20) ##### Returns diff --git a/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md b/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md index 85e03b9..1e2e23f 100644 --- a/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md +++ b/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md @@ -10,7 +10,7 @@ title: RedisConnectionConfig # Interface: RedisConnectionConfig -Defined in: [packages/persistance/src/RedisConnection.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L10) +Defined in: [packages/persistance/src/RedisConnection.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L10) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:10](https://github.com/ > **host**: `string` -Defined in: [packages/persistance/src/RedisConnection.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L11) +Defined in: [packages/persistance/src/RedisConnection.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L11) *** @@ -26,7 +26,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:11](https://github.com/ > `optional` **password**: `string` -Defined in: [packages/persistance/src/RedisConnection.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L12) +Defined in: [packages/persistance/src/RedisConnection.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L12) *** @@ -34,7 +34,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:12](https://github.com/ > `optional` **port**: `number` -Defined in: [packages/persistance/src/RedisConnection.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L13) +Defined in: [packages/persistance/src/RedisConnection.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L13) *** @@ -42,4 +42,4 @@ Defined in: [packages/persistance/src/RedisConnection.ts:13](https://github.com/ > `optional` **username**: `string` -Defined in: [packages/persistance/src/RedisConnection.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L14) +Defined in: [packages/persistance/src/RedisConnection.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L14) diff --git a/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md b/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md index 2c45671..6c96173 100644 --- a/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md +++ b/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md @@ -12,4 +12,4 @@ title: RedisTransaction > **RedisTransaction**: `ReturnType`\<`RedisClientType`\[`"multi"`\]\> -Defined in: [packages/persistance/src/RedisConnection.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/persistance/src/RedisConnection.ts#L17) +Defined in: [packages/persistance/src/RedisConnection.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L17) diff --git a/src/pages/docs/reference/processor/_meta.tsx b/src/pages/docs/reference/processor/_meta.tsx index a31554d..b6944c5 100644 --- a/src/pages/docs/reference/processor/_meta.tsx +++ b/src/pages/docs/reference/processor/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" + "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases" }; \ No newline at end of file diff --git a/src/pages/docs/reference/processor/classes/BlockFetching.md b/src/pages/docs/reference/processor/classes/BlockFetching.md index 2e536e1..cd2ff33 100644 --- a/src/pages/docs/reference/processor/classes/BlockFetching.md +++ b/src/pages/docs/reference/processor/classes/BlockFetching.md @@ -10,7 +10,7 @@ title: BlockFetching # Class: BlockFetching -Defined in: [packages/processor/src/indexer/BlockFetching.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L36) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L36) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new BlockFetching**(`blockMapper`, `blockResultMapper`, `transactionResultMapper`): [`BlockFetching`](BlockFetching.md) -Defined in: [packages/processor/src/indexer/BlockFetching.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L37) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L37) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/processor/src/indexer/BlockFetching.ts:37](https://github. > **blockMapper**: [`BlockMapper`](../../persistance/classes/BlockMapper.md) -Defined in: [packages/processor/src/indexer/BlockFetching.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L38) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L38) *** @@ -62,7 +62,7 @@ Defined in: [packages/processor/src/indexer/BlockFetching.ts:38](https://github. > **blockResultMapper**: [`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) -Defined in: [packages/processor/src/indexer/BlockFetching.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L39) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L39) *** @@ -85,7 +85,7 @@ checks when retrieving it via the getter > **transactionResultMapper**: [`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) -Defined in: [packages/processor/src/indexer/BlockFetching.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L40) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L40) ## Accessors @@ -149,7 +149,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **fetchBlock**(`height`): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> -Defined in: [packages/processor/src/indexer/BlockFetching.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L45) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L45) #### Parameters @@ -167,7 +167,7 @@ Defined in: [packages/processor/src/indexer/BlockFetching.ts:45](https://github. > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/indexer/BlockFetching.ts:146](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L146) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:146](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L146) #### Returns diff --git a/src/pages/docs/reference/processor/classes/Database.md b/src/pages/docs/reference/processor/classes/Database.md index 7dbfb99..3967dc3 100644 --- a/src/pages/docs/reference/processor/classes/Database.md +++ b/src/pages/docs/reference/processor/classes/Database.md @@ -10,7 +10,7 @@ title: Database # Class: Database\ -Defined in: [packages/processor/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L11) +Defined in: [packages/processor/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L11) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -42,7 +42,7 @@ deps that are necessary for the sequencer to work. > **new Database**\<`PrismaClient`\>(`prismaClient`): [`Database`](Database.md)\<`PrismaClient`\> -Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L15) +Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L15) #### Parameters @@ -79,7 +79,7 @@ checks when retrieving it via the getter > **prismaClient**: `PrismaClient` -Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L15) +Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L15) #### Implementation of @@ -147,7 +147,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): `object` -Defined in: [packages/processor/src/storage/Database.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L29) +Defined in: [packages/processor/src/storage/Database.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L29) #### Returns @@ -171,7 +171,7 @@ Defined in: [packages/processor/src/storage/Database.ts:29](https://github.com/p > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/storage/Database.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L37) +Defined in: [packages/processor/src/storage/Database.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L37) #### Returns @@ -183,7 +183,7 @@ Defined in: [packages/processor/src/storage/Database.ts:37](https://github.com/p > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/storage/Database.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L50) +Defined in: [packages/processor/src/storage/Database.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L50) #### Returns @@ -199,7 +199,7 @@ Defined in: [packages/processor/src/storage/Database.ts:50](https://github.com/p > `static` **from**\<`PrismaClient`\>(`prismaClient`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Database`](Database.md)\<`PrismaClient`\>\> -Defined in: [packages/processor/src/storage/Database.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/Database.ts#L19) +Defined in: [packages/processor/src/storage/Database.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L19) #### Type Parameters diff --git a/src/pages/docs/reference/processor/classes/DatabasePruneModule.md b/src/pages/docs/reference/processor/classes/DatabasePruneModule.md index 1a0adf6..db3a1a5 100644 --- a/src/pages/docs/reference/processor/classes/DatabasePruneModule.md +++ b/src/pages/docs/reference/processor/classes/DatabasePruneModule.md @@ -10,7 +10,7 @@ title: DatabasePruneModule # Class: DatabasePruneModule -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/DatabasePruneModule.ts#L14) +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/DatabasePruneModule.ts#L14) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new DatabasePruneModule**(`database`): [`DatabasePruneModule`](DatabasePruneModule.md) -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/DatabasePruneModule.ts#L15) +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/DatabasePruneModule.ts#L15) #### Parameters @@ -117,7 +117,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/DatabasePruneModule.ts#L21) +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/DatabasePruneModule.ts#L21) #### Returns diff --git a/src/pages/docs/reference/processor/classes/HandlersExecutor.md b/src/pages/docs/reference/processor/classes/HandlersExecutor.md index f09f090..5b92915 100644 --- a/src/pages/docs/reference/processor/classes/HandlersExecutor.md +++ b/src/pages/docs/reference/processor/classes/HandlersExecutor.md @@ -10,7 +10,7 @@ title: HandlersExecutor # Class: HandlersExecutor\ -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L28) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L28) Used by various module sub-types that may need to be configured @@ -59,7 +59,7 @@ checks when retrieving it via the getter > **database**: `undefined` \| `PrismaDatabaseConnection`\<`PrismaClient`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L36) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L36) *** @@ -67,7 +67,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:36](https://git > **handlers**: `undefined` \| `Handlers` -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L34) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L34) *** @@ -75,7 +75,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:34](https://git > **isExecuting**: `boolean` = `false` -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L32) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L32) ## Accessors @@ -117,7 +117,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **create**(`childContainerProvider`): `void` -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L38) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L38) #### Parameters @@ -139,7 +139,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:38](https://git > **execute**(`block`): `Promise`\<`void`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L83) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L83) #### Parameters @@ -157,7 +157,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:83](https://git > **onAfterHandlers**(`client`, `block`): `Promise`\<`void`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L72) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L72) #### Parameters @@ -179,7 +179,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:72](https://git > **onBlock**(`client`, `block`): `Promise`\<`void`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L60) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L60) #### Parameters @@ -201,7 +201,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:60](https://git > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L46) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L46) #### Returns @@ -217,7 +217,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:46](https://git > `static` **from**\<`PrismaClient`, `Handlers`\>(`handlers`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`HandlersExecutor`](HandlersExecutor.md)\<`PrismaClient`, `Handlers`\>\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L48) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L48) #### Type Parameters diff --git a/src/pages/docs/reference/processor/classes/Processor.md b/src/pages/docs/reference/processor/classes/Processor.md index ab1bd7f..de481af 100644 --- a/src/pages/docs/reference/processor/classes/Processor.md +++ b/src/pages/docs/reference/processor/classes/Processor.md @@ -10,7 +10,7 @@ title: Processor # Class: Processor\ -Defined in: [packages/processor/src/Processor.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/Processor.ts#L15) +Defined in: [packages/processor/src/Processor.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/Processor.ts#L15) Reusable module container facilitating registration, resolution configuration, decoration and validation of modules @@ -560,7 +560,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/Processor.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/Processor.ts#L24) +Defined in: [packages/processor/src/Processor.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/Processor.ts#L24) #### Returns @@ -601,7 +601,7 @@ such as only injecting other known modules. > `static` **from**\<`Modules`\>(`definition`): [`Processor`](Processor.md)\<`Modules`\> -Defined in: [packages/processor/src/Processor.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/Processor.ts#L18) +Defined in: [packages/processor/src/Processor.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/Processor.ts#L18) #### Type Parameters diff --git a/src/pages/docs/reference/processor/classes/ProcessorModule.md b/src/pages/docs/reference/processor/classes/ProcessorModule.md index fbe9783..4b65362 100644 --- a/src/pages/docs/reference/processor/classes/ProcessorModule.md +++ b/src/pages/docs/reference/processor/classes/ProcessorModule.md @@ -10,7 +10,7 @@ title: ProcessorModule # Class: `abstract` ProcessorModule\ -Defined in: [packages/processor/src/ProcessorModule.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/ProcessorModule.ts#L3) +Defined in: [packages/processor/src/ProcessorModule.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/ProcessorModule.ts#L3) Used by various module sub-types that may need to be configured @@ -121,7 +121,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `abstract` **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/ProcessorModule.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/ProcessorModule.ts#L6) +Defined in: [packages/processor/src/ProcessorModule.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/ProcessorModule.ts#L6) #### Returns diff --git a/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md b/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md index 9c6e0ae..8ed20a8 100644 --- a/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md +++ b/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md @@ -10,7 +10,7 @@ title: ResolverFactoryGraphqlModule # Class: ResolverFactoryGraphqlModule\ -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L49) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L49) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new ResolverFactoryGraphqlModule**\<`PrismaClient`\>(`graphqlServer`): [`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\> -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) #### Parameters @@ -65,7 +65,7 @@ checks when retrieving it via the getter > **database**: `undefined` \| `PrismaDatabaseConnection`\<`PrismaClient`\> -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L62) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L62) *** @@ -73,7 +73,7 @@ Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:62](http > **graphqlServer**: [`GraphqlServer`](../../api/classes/GraphqlServer.md) -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) ## Accessors @@ -115,7 +115,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **create**(`childContainerProvider`): `void` -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L68) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L68) #### Parameters @@ -137,7 +137,7 @@ Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:68](http > **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L77) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L77) #### Returns @@ -153,7 +153,7 @@ Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:77](http > `static` **from**\<`PrismaClient`\>(`resolvers`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\>\> -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L52) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L52) #### Type Parameters diff --git a/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md b/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md index ea7037a..47f5b0b 100644 --- a/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md +++ b/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md @@ -10,7 +10,7 @@ title: TimedProcessorTrigger # Class: TimedProcessorTrigger -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L15) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L15) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new TimedProcessorTrigger**(`blockStorage`, `blockFetching`, `handlersExecutor`): [`TimedProcessorTrigger`](TimedProcessorTrigger.md) -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L18) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L18) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:18](https: > **blockFetching**: [`BlockFetching`](BlockFetching.md) -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L20) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L20) *** @@ -62,7 +62,7 @@ Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:20](https: > **blockStorage**: `BlockStorage` -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L19) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L19) *** @@ -70,7 +70,7 @@ Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:19](https: > **catchingUp**: `boolean` = `false` -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L16) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L16) *** @@ -93,7 +93,7 @@ checks when retrieving it via the getter > **handlersExecutor**: [`HandlersExecutor`](HandlersExecutor.md)\<`BasePrismaClient`, [`HandlersRecord`](../interfaces/HandlersRecord.md)\<`BasePrismaClient`\>\> -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L22) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L22) ## Accessors @@ -135,7 +135,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **catchUp**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L61) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L61) #### Returns @@ -169,7 +169,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **processNextBlock**(): `Promise`\<`boolean`\> -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L30) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L30) #### Returns @@ -181,7 +181,7 @@ Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:30](https: > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L77) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L77) #### Returns diff --git a/src/pages/docs/reference/processor/functions/ValidateTakeArg.md b/src/pages/docs/reference/processor/functions/ValidateTakeArg.md index f42c3db..8a002fb 100644 --- a/src/pages/docs/reference/processor/functions/ValidateTakeArg.md +++ b/src/pages/docs/reference/processor/functions/ValidateTakeArg.md @@ -12,7 +12,7 @@ title: ValidateTakeArg > **ValidateTakeArg**(): `MethodDecorator` -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L34) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L34) ## Returns diff --git a/src/pages/docs/reference/processor/functions/cleanResolvers.md b/src/pages/docs/reference/processor/functions/cleanResolvers.md index 9cdc70c..9b80f44 100644 --- a/src/pages/docs/reference/processor/functions/cleanResolvers.md +++ b/src/pages/docs/reference/processor/functions/cleanResolvers.md @@ -12,7 +12,7 @@ title: cleanResolvers > **cleanResolvers**(`resolvers`): `NonEmptyArray`\<`Function`\> -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L12) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L12) ## Parameters diff --git a/src/pages/docs/reference/processor/globals.md b/src/pages/docs/reference/processor/globals.md new file mode 100644 index 0000000..1b6eb78 --- /dev/null +++ b/src/pages/docs/reference/processor/globals.md @@ -0,0 +1,42 @@ +--- +title: "@proto-kit/processor" +--- + +[**@proto-kit/processor**](README.md) + +*** + +[Documentation](../../README.md) / @proto-kit/processor + +# @proto-kit/processor + +## Classes + +- [BlockFetching](classes/BlockFetching.md) +- [Database](classes/Database.md) +- [DatabasePruneModule](classes/DatabasePruneModule.md) +- [HandlersExecutor](classes/HandlersExecutor.md) +- [Processor](classes/Processor.md) +- [ProcessorModule](classes/ProcessorModule.md) +- [ResolverFactoryGraphqlModule](classes/ResolverFactoryGraphqlModule.md) +- [TimedProcessorTrigger](classes/TimedProcessorTrigger.md) + +## Interfaces + +- [BlockFetchingConfig](interfaces/BlockFetchingConfig.md) +- [BlockResponse](interfaces/BlockResponse.md) +- [DatabasePruneModuleConfig](interfaces/DatabasePruneModuleConfig.md) +- [HandlersExecutorConfig](interfaces/HandlersExecutorConfig.md) +- [HandlersRecord](interfaces/HandlersRecord.md) +- [TimedProcessorTriggerConfig](interfaces/TimedProcessorTriggerConfig.md) + +## Type Aliases + +- [BlockHandler](type-aliases/BlockHandler.md) +- [ClientTransaction](type-aliases/ClientTransaction.md) +- [ProcessorModulesRecord](type-aliases/ProcessorModulesRecord.md) + +## Functions + +- [cleanResolvers](functions/cleanResolvers.md) +- [ValidateTakeArg](functions/ValidateTakeArg.md) diff --git a/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md b/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md index fe36add..d5cc853 100644 --- a/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md +++ b/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md @@ -10,7 +10,7 @@ title: BlockFetchingConfig # Interface: BlockFetchingConfig -Defined in: [packages/processor/src/indexer/BlockFetching.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L19) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L19) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/processor/src/indexer/BlockFetching.ts:19](https://github. > **url**: `string` -Defined in: [packages/processor/src/indexer/BlockFetching.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L20) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L20) diff --git a/src/pages/docs/reference/processor/interfaces/BlockResponse.md b/src/pages/docs/reference/processor/interfaces/BlockResponse.md index a5ab58d..2399c5f 100644 --- a/src/pages/docs/reference/processor/interfaces/BlockResponse.md +++ b/src/pages/docs/reference/processor/interfaces/BlockResponse.md @@ -10,7 +10,7 @@ title: BlockResponse # Interface: BlockResponse -Defined in: [packages/processor/src/indexer/BlockFetching.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L23) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L23) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/processor/src/indexer/BlockFetching.ts:23](https://github. > **data**: `object` -Defined in: [packages/processor/src/indexer/BlockFetching.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/indexer/BlockFetching.ts#L24) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L24) #### findFirstBlock diff --git a/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md b/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md index 2071577..28673a9 100644 --- a/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md +++ b/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md @@ -10,7 +10,7 @@ title: DatabasePruneModuleConfig # Interface: DatabasePruneModuleConfig -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/DatabasePruneModule.ts#L9) +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/DatabasePruneModule.ts#L9) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:9](https://gi > `optional` **pruneOnStartup**: `boolean` -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/storage/DatabasePruneModule.ts#L10) +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/DatabasePruneModule.ts#L10) diff --git a/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md b/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md index 5af3aa3..1a0dfc3 100644 --- a/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md +++ b/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md @@ -10,7 +10,7 @@ title: HandlersExecutorConfig # Interface: HandlersExecutorConfig -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L22) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L22) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:22](https://git > `optional` **maxWait**: `number` -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L23) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L23) *** @@ -26,4 +26,4 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:23](https://git > `optional` **timeout**: `number` -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L24) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L24) diff --git a/src/pages/docs/reference/processor/interfaces/HandlersRecord.md b/src/pages/docs/reference/processor/interfaces/HandlersRecord.md index 67c6d5d..25b48be 100644 --- a/src/pages/docs/reference/processor/interfaces/HandlersRecord.md +++ b/src/pages/docs/reference/processor/interfaces/HandlersRecord.md @@ -10,7 +10,7 @@ title: HandlersRecord # Interface: HandlersRecord\ -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L18) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L18) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:18](https://git > **onBlock**: [`BlockHandler`](../type-aliases/BlockHandler.md)\<`PrismaClient`\>[] -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L19) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L19) diff --git a/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md b/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md index 9ecae67..913c4ed 100644 --- a/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md +++ b/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md @@ -10,7 +10,7 @@ title: TimedProcessorTriggerConfig # Interface: TimedProcessorTriggerConfig -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L10) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L10) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:10](https: > `optional` **interval**: `number` -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/triggers/TimedProcessorTrigger.ts#L11) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L11) diff --git a/src/pages/docs/reference/processor/type-aliases/BlockHandler.md b/src/pages/docs/reference/processor/type-aliases/BlockHandler.md index b505093..940c119 100644 --- a/src/pages/docs/reference/processor/type-aliases/BlockHandler.md +++ b/src/pages/docs/reference/processor/type-aliases/BlockHandler.md @@ -12,7 +12,7 @@ title: BlockHandler > **BlockHandler**\<`PrismaClient`\>: (`client`, `block`) => `Promise`\<`void`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L13) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L13) ## Type Parameters diff --git a/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md b/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md index 5c0549d..84859bc 100644 --- a/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md +++ b/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md @@ -12,7 +12,7 @@ title: ClientTransaction > **ClientTransaction**\<`PrismaClient`\>: `Parameters`\<`Parameters`\<`PrismaClient`\[`"$transaction"`\]\>\[`0`\]\>\[`0`\] -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/handlers/HandlersExecutor.ts#L10) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L10) ## Type Parameters diff --git a/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md b/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md index 1124685..b25b45e 100644 --- a/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md +++ b/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md @@ -12,4 +12,4 @@ title: ProcessorModulesRecord > **ProcessorModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ProcessorModule`](../classes/ProcessorModule.md)\<`unknown`\>\>\> -Defined in: [packages/processor/src/Processor.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/processor/src/Processor.ts#L11) +Defined in: [packages/processor/src/Processor.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/Processor.ts#L11) diff --git a/src/pages/docs/reference/protocol/classes/AccountState.md b/src/pages/docs/reference/protocol/classes/AccountState.md index 241ee41..6b1cd3f 100644 --- a/src/pages/docs/reference/protocol/classes/AccountState.md +++ b/src/pages/docs/reference/protocol/classes/AccountState.md @@ -10,7 +10,7 @@ title: AccountState # Class: AccountState -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/AccountStateHook.ts#L10) +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/AccountStateHook.ts#L10) ## Extends @@ -46,7 +46,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **nonce**: `UInt64` = `UInt64` -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/AccountStateHook.ts#L11) +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/AccountStateHook.ts#L11) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/AccountStateHook.md b/src/pages/docs/reference/protocol/classes/AccountStateHook.md index 74c25b3..d3073a0 100644 --- a/src/pages/docs/reference/protocol/classes/AccountStateHook.md +++ b/src/pages/docs/reference/protocol/classes/AccountStateHook.md @@ -10,7 +10,7 @@ title: AccountStateHook # Class: AccountStateHook -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/AccountStateHook.ts#L15) +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/AccountStateHook.ts#L15) ## Extends @@ -36,7 +36,7 @@ Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:15](https://github. > **accountState**: [`StateMap`](StateMap.md)\<`PublicKey`, [`AccountState`](AccountState.md)\> -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/AccountStateHook.ts#L16) +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/AccountStateHook.ts#L16) *** @@ -59,7 +59,7 @@ checks when retrieving it via the getter > `optional` **name**: `string` -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) #### Inherited from @@ -71,7 +71,7 @@ Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](h > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -85,7 +85,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -135,7 +135,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -157,7 +157,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **onTransaction**(`__namedParameters`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/AccountStateHook.ts#L21) +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/AccountStateHook.ts#L21) #### Parameters @@ -179,7 +179,7 @@ Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:21](https://github. > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md index 87d6d94..e48d522 100644 --- a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md +++ b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md @@ -10,7 +10,7 @@ title: BlockHashMerkleTree # Class: BlockHashMerkleTree -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L4) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L4) ## Extends diff --git a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md index 8114bee..616401f 100644 --- a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md +++ b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md @@ -10,7 +10,7 @@ title: BlockHashMerkleTreeWitness # Class: BlockHashMerkleTreeWitness -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L5) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L5) ## Extends diff --git a/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md b/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md index f4654d6..ce56694 100644 --- a/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md +++ b/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md @@ -10,7 +10,7 @@ title: BlockHashTreeEntry # Class: BlockHashTreeEntry -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L7) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L7) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **blockHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L8) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L8) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTre > **closed**: `Bool` = `Bool` -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L9) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L9) #### Inherited from @@ -406,7 +406,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L13) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L13) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/BlockHeightHook.md b/src/pages/docs/reference/protocol/classes/BlockHeightHook.md index 084b7fd..e699bc3 100644 --- a/src/pages/docs/reference/protocol/classes/BlockHeightHook.md +++ b/src/pages/docs/reference/protocol/classes/BlockHeightHook.md @@ -10,7 +10,7 @@ title: BlockHeightHook # Class: BlockHeightHook -Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/BlockHeightHook.ts#L4) +Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/BlockHeightHook.ts#L4) ## Extends @@ -51,7 +51,7 @@ checks when retrieving it via the getter > `optional` **name**: `string` -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) #### Inherited from @@ -63,7 +63,7 @@ Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](h > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -127,7 +127,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **afterBlock**(`networkState`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/BlockHeightHook.ts#L5) +Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/BlockHeightHook.ts#L5) #### Parameters @@ -149,7 +149,7 @@ Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:5](https://github.co > **beforeBlock**(`networkState`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/BlockHeightHook.ts#L14) +Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/BlockHeightHook.ts#L14) #### Parameters @@ -171,7 +171,7 @@ Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:14](https://github.c > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -193,7 +193,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/BlockProver.md b/src/pages/docs/reference/protocol/classes/BlockProver.md index 409dfd8..30b965d 100644 --- a/src/pages/docs/reference/protocol/classes/BlockProver.md +++ b/src/pages/docs/reference/protocol/classes/BlockProver.md @@ -10,7 +10,7 @@ title: BlockProver # Class: BlockProver -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:907](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L907) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:907](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L907) BlockProver class, which aggregates a AppChainProof and a StateTransitionProof into a single BlockProof, that can @@ -31,7 +31,7 @@ then be merged to be committed to the base-layer contract > **new BlockProver**(`stateTransitionProver`, `runtime`, `transactionHooks`, `blockHooks`, `verificationKeyService`): [`BlockProver`](BlockProver.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:913](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L913) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:913](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L913) #### Parameters @@ -84,7 +84,7 @@ checks when retrieving it via the getter > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -96,7 +96,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > `readonly` **runtime**: [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> & [`CompilableModule`](../../common/interfaces/CompilableModule.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:921](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L921) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:921](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L921) *** @@ -104,7 +104,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:921](https://gith > `readonly` **stateTransitionProver**: [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> & [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:915](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L915) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:915](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L915) *** @@ -112,7 +112,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:915](https://gith > **zkProgrammable**: [`BlockProverProgrammable`](BlockProverProgrammable.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:911](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L911) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:911](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L911) #### Implementation of @@ -126,7 +126,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:911](https://gith > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -176,7 +176,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compile**(`registry`): `Promise`\<`undefined` \| `Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:940](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L940) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:940](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L940) #### Parameters @@ -198,7 +198,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:940](https://gith > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -220,7 +220,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:983](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L983) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:983](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L983) #### Parameters @@ -250,7 +250,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:983](https://gith > **proveBlock**(`publicInput`, `networkState`, `blockWitness`, `transactionProof`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:967](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L967) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:967](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L967) #### Parameters @@ -284,7 +284,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:967](https://gith > **proveTransaction**(`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:951](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L951) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:951](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L951) #### Parameters @@ -322,7 +322,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:951](https://gith > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md b/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md index 472f9c5..465a189 100644 --- a/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md +++ b/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md @@ -10,7 +10,7 @@ title: BlockProverExecutionData # Class: BlockProverExecutionData -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L57) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L57) ## Extends @@ -54,7 +54,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L60) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L60) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:60](https://git > **signature**: `Signature` = `Signature` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L59) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L59) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:59](https://git > **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L58) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L58) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md b/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md index 2676d3d..9524682 100644 --- a/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md +++ b/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md @@ -10,7 +10,7 @@ title: BlockProverProgrammable # Class: BlockProverProgrammable -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:135](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L135) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:135](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L135) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:135](https://gith > **new BlockProverProgrammable**(`prover`, `stateTransitionProver`, `runtime`, `transactionHooks`, `blockHooks`, `verificationKeyService`): [`BlockProverProgrammable`](BlockProverProgrammable.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:139](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L139) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:139](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L139) #### Parameters @@ -64,7 +64,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:139](https://gith > **name**: `string` = `"BlockProver"` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:153](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L153) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:153](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L153) *** @@ -72,7 +72,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:153](https://gith > `readonly` **runtime**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:145](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L145) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:145](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L145) *** @@ -80,7 +80,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:145](https://gith > `readonly` **stateTransitionProver**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:141](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L141) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:141](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L141) ## Accessors @@ -90,7 +90,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:141](https://gith > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:155](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L155) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:155](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L155) ##### Returns @@ -124,7 +124,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:34 > **applyTransaction**(`state`, `stateTransitionProof`, `runtimeProof`, `executionData`, `verificationKey`): `Promise`\<[`BlockProverState`](../interfaces/BlockProverState.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:170](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L170) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:170](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L170) Applies and checks the two proofs and applies the corresponding state changes to the given state @@ -165,7 +165,7 @@ The new BlockProver-state to be used as public output > **assertProtocolTransitions**(`stateTransitionProof`, `executionData`, `runtimeProof`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:264](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L264) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:264](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L264) #### Parameters @@ -213,7 +213,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:35 > **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:656](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L656) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:656](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L656) #### Parameters @@ -239,7 +239,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:656](https://gith > **proveBlock**(`publicInput`, `networkState`, `blockWitness`, `transactionProof`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:482](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L482) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:482](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L482) #### Parameters @@ -269,7 +269,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:482](https://gith > **proveTransaction**(`publicInput`, `stateProof`, `runtimeProof`, `executionData`, `verificationKeyWitness`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:406](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L406) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L406) #### Parameters @@ -303,7 +303,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:406](https://gith > **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`BlockProverPublicInput`](BlockProverPublicInput.md), [`BlockProverPublicOutput`](BlockProverPublicOutput.md)\>[] -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:798](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L798) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:798](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L798) Creates the BlockProver ZkProgram. Recursive linking of proofs is done via the previously diff --git a/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md b/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md index 019b1fd..b8b861f 100644 --- a/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md +++ b/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md @@ -10,7 +10,7 @@ title: BlockProverPublicInput # Class: BlockProverPublicInput -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L20) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L20) ## Extends @@ -70,7 +70,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **blockHashRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L24) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L24) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:24](https://git > **blockNumber**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L27) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L27) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:27](https://git > **eternalTransactionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L25) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L25) #### Inherited from @@ -106,7 +106,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:25](https://git > **incomingMessagesHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L26) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L26) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:26](https://git > **networkStateHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L23) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L23) #### Inherited from @@ -130,7 +130,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:23](https://git > **stateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L22) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L22) #### Inherited from @@ -142,7 +142,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:22](https://git > **transactionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L21) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L21) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md b/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md index ab6a6b7..a4c2bb2 100644 --- a/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md +++ b/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md @@ -10,7 +10,7 @@ title: BlockProverPublicOutput # Class: BlockProverPublicOutput -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L30) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L30) ## Extends @@ -74,7 +74,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **blockHashRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L34) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L34) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:34](https://git > **blockNumber**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L38) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L38) #### Inherited from @@ -98,7 +98,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:38](https://git > **closed**: `Bool` = `Bool` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L37) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L37) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:37](https://git > **eternalTransactionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L35) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L35) #### Inherited from @@ -122,7 +122,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:35](https://git > **incomingMessagesHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L36) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L36) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:36](https://git > **networkStateHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L33) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L33) #### Inherited from @@ -146,7 +146,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:33](https://git > **stateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L32) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L32) #### Inherited from @@ -158,7 +158,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:32](https://git > **transactionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L31) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L31) #### Inherited from @@ -790,7 +790,7 @@ Convert provable type to a normal JS type. > **equals**(`input`, `closed`): `Bool` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L40) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L40) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/BridgeContract.md b/src/pages/docs/reference/protocol/classes/BridgeContract.md index 97440c6..4438fc3 100644 --- a/src/pages/docs/reference/protocol/classes/BridgeContract.md +++ b/src/pages/docs/reference/protocol/classes/BridgeContract.md @@ -10,7 +10,7 @@ title: BridgeContract # Class: BridgeContract -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:211](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L211) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:211](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L211) ## Extends @@ -82,7 +82,7 @@ A list of event types that can be emitted using this.emitEvent()`. > **outgoingMessageCursor**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:219](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L219) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:219](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L219) #### Implementation of @@ -163,7 +163,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > **settlementContractAddress**: `State`\<`PublicKey`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:215](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L215) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:215](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L215) #### Overrides @@ -175,7 +175,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:215](h > **stateRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:217](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L217) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:217](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L217) #### Implementation of @@ -271,7 +271,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) #### SettlementContract @@ -600,7 +600,7 @@ Approve a list of account updates (with arbitrarily many children). > **approveBase**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) #### Returns @@ -684,7 +684,7 @@ async deploy() { > **deployProvable**(`verificationKey`, `signedSettlement`, `permissions`, `settlementContractAddress`): `Promise`\<`AccountUpdate`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) Function to deploy the bridging contract in a provable way, so that it can be a provable process initiated by the settlement contract with a baked-in vk @@ -946,7 +946,7 @@ Same as `SmartContract.self` but explicitly creates a new AccountUpdate. > **redeem**(`additionUpdate`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:234](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L234) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:234](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L234) #### Parameters @@ -968,7 +968,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:234](h > `protected` **redeemBase**(`additionUpdate`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) #### Parameters @@ -1016,7 +1016,7 @@ with the only difference being that quick mock proofs are filled in instead of r > **rollupOutgoingMessages**(`batch`): `Promise`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:227](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L227) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:227](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L227) #### Parameters @@ -1038,7 +1038,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:227](h > **rollupOutgoingMessagesBase**(`batch`): `Promise`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) #### Parameters @@ -1143,7 +1143,7 @@ Transfer `amount` of tokens from `from` to `to`. > **updateStateRoot**(`root`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:222](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L222) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:222](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L222) #### Parameters @@ -1165,7 +1165,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:222](h > **updateStateRootBase**(`root`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/BridgeContractBase.md b/src/pages/docs/reference/protocol/classes/BridgeContractBase.md index 79ce557..9943b86 100644 --- a/src/pages/docs/reference/protocol/classes/BridgeContractBase.md +++ b/src/pages/docs/reference/protocol/classes/BridgeContractBase.md @@ -10,7 +10,7 @@ title: BridgeContractBase # Class: `abstract` BridgeContractBase -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L54) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L54) ## Extends @@ -82,7 +82,7 @@ A list of event types that can be emitted using this.emitEvent()`. > `abstract` **outgoingMessageCursor**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L66) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L66) *** @@ -155,7 +155,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > `abstract` **settlementContractAddress**: `State`\<`PublicKey`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L62) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L62) *** @@ -163,7 +163,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:62](ht > `abstract` **stateRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L64) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L64) *** @@ -251,7 +251,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) #### SettlementContract @@ -576,7 +576,7 @@ Approve a list of account updates (with arbitrarily many children). > **approveBase**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) #### Returns @@ -660,7 +660,7 @@ async deploy() { > **deployProvable**(`verificationKey`, `signedSettlement`, `permissions`, `settlementContractAddress`): `Promise`\<`AccountUpdate`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) Function to deploy the bridging contract in a provable way, so that it can be a provable process initiated by the settlement contract with a baked-in vk @@ -914,7 +914,7 @@ Same as `SmartContract.self` but explicitly creates a new AccountUpdate. > `protected` **redeemBase**(`additionUpdate`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) #### Parameters @@ -958,7 +958,7 @@ with the only difference being that quick mock proofs are filled in instead of r > **rollupOutgoingMessagesBase**(`batch`): `Promise`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) #### Parameters @@ -1059,7 +1059,7 @@ Transfer `amount` of tokens from `from` to `to`. > **updateStateRootBase**(`root`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md index bac2a2f..ac8796d 100644 --- a/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md +++ b/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md @@ -10,7 +10,7 @@ title: BridgeContractProtocolModule # Class: BridgeContractProtocolModule -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L18) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L18) This module type is used to define a contract module that can be used to construct and inject smart contract instances. @@ -92,7 +92,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compile**(`registry`): `Promise`\<\{ `BridgeContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L38) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L38) #### Parameters @@ -114,7 +114,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolMo > **contractFactory**(): *typeof* [`BridgeContract`](BridgeContract.md) -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L22) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L22) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ContractModule.md b/src/pages/docs/reference/protocol/classes/ContractModule.md index fc33e18..1833f55 100644 --- a/src/pages/docs/reference/protocol/classes/ContractModule.md +++ b/src/pages/docs/reference/protocol/classes/ContractModule.md @@ -10,7 +10,7 @@ title: ContractModule # Class: `abstract` ContractModule\ -Defined in: [packages/protocol/src/settlement/ContractModule.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/ContractModule.ts#L22) +Defined in: [packages/protocol/src/settlement/ContractModule.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/ContractModule.ts#L22) This module type is used to define a contract module that can be used to construct and inject smart contract instances. @@ -108,7 +108,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > `abstract` **compile**(`registry`): `Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> -Defined in: [packages/protocol/src/settlement/ContractModule.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/ContractModule.ts#L28) +Defined in: [packages/protocol/src/settlement/ContractModule.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/ContractModule.ts#L28) #### Parameters @@ -130,7 +130,7 @@ Defined in: [packages/protocol/src/settlement/ContractModule.ts:28](https://gith > `abstract` **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<`ContractType`\> -Defined in: [packages/protocol/src/settlement/ContractModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/ContractModule.ts#L26) +Defined in: [packages/protocol/src/settlement/ContractModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/ContractModule.ts#L26) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/CurrentBlock.md b/src/pages/docs/reference/protocol/classes/CurrentBlock.md index 8850e3a..833aac9 100644 --- a/src/pages/docs/reference/protocol/classes/CurrentBlock.md +++ b/src/pages/docs/reference/protocol/classes/CurrentBlock.md @@ -10,7 +10,7 @@ title: CurrentBlock # Class: CurrentBlock -Defined in: [packages/protocol/src/model/network/NetworkState.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L4) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L4) ## Extends @@ -46,7 +46,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **height**: `UInt64` = `UInt64` -Defined in: [packages/protocol/src/model/network/NetworkState.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L5) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L5) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md b/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md index 81c60ce..468331e 100644 --- a/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md +++ b/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md @@ -10,7 +10,7 @@ title: DefaultProvableHashList # Class: DefaultProvableHashList\ -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L46) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L46) Utilities for creating a hash list from a given value type. @@ -28,7 +28,7 @@ Utilities for creating a hash list from a given value type. > **new DefaultProvableHashList**\<`Value`\>(`valueType`, `commitment`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L7) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L7) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.c > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L47) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L47) #### Parameters @@ -100,7 +100,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:47](https://github. > **push**(`value`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -129,7 +129,7 @@ Current hash list. > **pushIf**(`value`, `condition`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L29) #### Parameters @@ -155,7 +155,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github. > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/Deposit.md b/src/pages/docs/reference/protocol/classes/Deposit.md index aa97e8a..4c03376 100644 --- a/src/pages/docs/reference/protocol/classes/Deposit.md +++ b/src/pages/docs/reference/protocol/classes/Deposit.md @@ -10,7 +10,7 @@ title: Deposit # Class: Deposit -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Deposit.ts#L3) +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Deposit.ts#L3) ## Extends @@ -54,7 +54,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **address**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Deposit.ts#L5) +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Deposit.ts#L5) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:5](https://git > **amount**: `UInt64` = `UInt64` -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Deposit.ts#L6) +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Deposit.ts#L6) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:6](https://git > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Deposit.ts#L4) +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Deposit.ts#L4) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md index d60dd2d..07b75e0 100644 --- a/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md +++ b/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md @@ -10,7 +10,7 @@ title: DispatchContractProtocolModule # Class: DispatchContractProtocolModule -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L22) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L22) This module type is used to define a contract module that can be used to construct and inject smart contract instances. @@ -29,7 +29,7 @@ ContractType generic. > **new DispatchContractProtocolModule**(`runtime`): [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L26) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L26) #### Parameters @@ -100,7 +100,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compile**(`registry`): `Promise`\<\{ `DispatchSmartContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L65) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L65) #### Parameters @@ -122,7 +122,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocol > **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md)\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L49) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L49) #### Returns @@ -160,7 +160,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **eventsDefinition**(): `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L30) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L30) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md b/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md index 697d79d..3326396 100644 --- a/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md +++ b/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md @@ -10,7 +10,7 @@ title: DispatchSmartContract # Class: DispatchSmartContract -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:229](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L229) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:229](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L229) ## Extends @@ -64,7 +64,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 > **events**: `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) A list of event types that can be emitted using this.emitEvent()`. @@ -86,7 +86,7 @@ A list of event types that can be emitted using this.emitEvent()`. > **honoredMessagesHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:235](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L235) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:235](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L235) #### Overrides @@ -98,7 +98,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **promisedMessagesHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:233](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L233) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:233](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L233) #### Implementation of @@ -179,7 +179,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > **settlementContract**: `State`\<`PublicKey`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:237](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L237) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:237](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L237) #### Overrides @@ -191,7 +191,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **tokenBridgeCount**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:241](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L241) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:241](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L241) #### Overrides @@ -203,7 +203,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **tokenBridgeRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:239](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L239) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:239](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L239) #### Overrides @@ -295,7 +295,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) #### incomingMessagesPaths @@ -529,7 +529,7 @@ tx.sign([senderKey, zkAppKey]); > **deposit**(`amount`, `tokenId`, `bridgingContract`, `bridgingContractAttestation`, `l2Receiver`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:273](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L273) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:273](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L273) #### Parameters @@ -563,7 +563,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `protected` **dispatchMessage**\<`Type`\>(`methodId`, `value`, `valueType`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) #### Type Parameters @@ -667,7 +667,7 @@ Events will be emitted as a part of the transaction and can be collected by arch > **enableTokenDeposits**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:244](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L244) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:244](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L244) #### Parameters @@ -697,7 +697,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `protected` **enableTokenDepositsBase**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) #### Parameters @@ -804,7 +804,7 @@ class MyContract extends SmartContract { > **initialize**(`settlementContract`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:268](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L268) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:268](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L268) #### Parameters @@ -826,7 +826,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `protected` **initializeBase**(`settlementContract`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) #### Parameters @@ -949,7 +949,7 @@ authorization flow. > **updateMessagesHash**(`executedMessagesHash`, `newPromisedMessagesHash`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:257](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L257) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:257](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L257) #### Parameters @@ -975,7 +975,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `protected` **updateMessagesHashBase**(`executedMessagesHash`, `newPromisedMessagesHash`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md b/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md index d81b54d..5c2f77a 100644 --- a/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md +++ b/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md @@ -10,7 +10,7 @@ title: DispatchSmartContractBase # Class: `abstract` DispatchSmartContractBase -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L59) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L59) ## Extends @@ -64,7 +64,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 > **events**: `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) A list of event types that can be emitted using this.emitEvent()`. @@ -86,7 +86,7 @@ A list of event types that can be emitted using this.emitEvent()`. > `abstract` **honoredMessagesHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L77) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L77) *** @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `abstract` **promisedMessagesHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L75) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L75) *** @@ -167,7 +167,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > `abstract` **settlementContract**: `State`\<`PublicKey`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L79) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L79) *** @@ -175,7 +175,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `abstract` **tokenBridgeCount**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L83) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L83) *** @@ -183,7 +183,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `abstract` **tokenBridgeRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L81) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L81) *** @@ -271,7 +271,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) #### incomingMessagesPaths @@ -501,7 +501,7 @@ tx.sign([senderKey, zkAppKey]); > `protected` **dispatchMessage**\<`Type`\>(`methodId`, `value`, `valueType`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) #### Type Parameters @@ -601,7 +601,7 @@ Events will be emitted as a part of the transaction and can be collected by arch > `protected` **enableTokenDepositsBase**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) #### Parameters @@ -704,7 +704,7 @@ class MyContract extends SmartContract { > `protected` **initializeBase**(`settlementContract`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) #### Parameters @@ -823,7 +823,7 @@ authorization flow. > `protected` **updateMessagesHashBase**(`executedMessagesHash`, `newPromisedMessagesHash`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md b/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md index a1813e5..666c000 100644 --- a/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md +++ b/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md @@ -10,7 +10,7 @@ title: DynamicBlockProof # Class: DynamicBlockProof -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L49) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L49) ## Extends @@ -155,7 +155,7 @@ Alternatively, you can use {@FeatureFlags.fromZkProgram} to compute the set of f > `static` **maxProofsVerified**: `2` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L57) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L57) #### Overrides @@ -167,7 +167,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `static` **publicInputType**: *typeof* [`BlockProverPublicInput`](BlockProverPublicInput.md) = `BlockProverPublicInput` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L53) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L53) #### Overrides @@ -179,7 +179,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `static` **publicOutputType**: *typeof* [`BlockProverPublicOutput`](BlockProverPublicOutput.md) = `BlockProverPublicOutput` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L55) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L55) #### Overrides diff --git a/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md b/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md index 0302c3f..ce8eea1 100644 --- a/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md +++ b/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md @@ -10,7 +10,7 @@ title: DynamicRuntimeProof # Class: DynamicRuntimeProof -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L63) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L63) ## Extends @@ -155,7 +155,7 @@ Alternatively, you can use {@FeatureFlags.fromZkProgram} to compute the set of f > `static` **maxProofsVerified**: `0` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L72) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L72) #### Overrides @@ -167,7 +167,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:72](https://git > `static` **publicInputType**: `ProvablePureExtended`\<`void`, `void`, `null`\> = `Void` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L67) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L67) #### Overrides @@ -179,7 +179,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:67](https://git > `static` **publicOutputType**: *typeof* [`MethodPublicOutput`](MethodPublicOutput.md) = `MethodPublicOutput` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L69) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L69) #### Overrides diff --git a/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md b/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md index 531fc79..43554f7 100644 --- a/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md +++ b/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md @@ -10,7 +10,7 @@ title: LastStateRootBlockHook # Class: LastStateRootBlockHook -Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L5) +Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L5) ## Extends @@ -51,7 +51,7 @@ checks when retrieving it via the getter > `optional` **name**: `string` -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) #### Inherited from @@ -63,7 +63,7 @@ Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](h > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -127,7 +127,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **afterBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L8) +Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L8) #### Parameters @@ -153,7 +153,7 @@ Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:8](https://gi > **beforeBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L20) +Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L20) #### Parameters @@ -179,7 +179,7 @@ Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:20](https://g > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -201,7 +201,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md b/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md index 8d008bd..a7909fd 100644 --- a/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md +++ b/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md @@ -10,7 +10,7 @@ title: MethodPublicOutput # Class: MethodPublicOutput -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L7) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L7) Public input used to link in-circuit execution with the proof's public input. @@ -69,7 +69,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **eventsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L13) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L13) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:13](https://githu > **isMessage**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L12) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L12) #### Inherited from @@ -93,7 +93,7 @@ Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:12](https://githu > **networkStateHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L11) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L11) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:11](https://githu > **stateTransitionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L8) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L8) #### Inherited from @@ -117,7 +117,7 @@ Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:8](https://github > **status**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L9) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L9) #### Inherited from @@ -129,7 +129,7 @@ Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:9](https://github > **transactionHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/MethodPublicOutput.ts#L10) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L10) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md b/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md index f1b5251..43481c3 100644 --- a/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md +++ b/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md @@ -10,7 +10,7 @@ title: MethodVKConfigData # Class: MethodVKConfigData -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L13) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L13) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **methodId**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L14) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L14) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificatio > **vkHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L15) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L15) #### Inherited from @@ -406,7 +406,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L17) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L17) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/MinaActions.md b/src/pages/docs/reference/protocol/classes/MinaActions.md index 2510be7..a56909f 100644 --- a/src/pages/docs/reference/protocol/classes/MinaActions.md +++ b/src/pages/docs/reference/protocol/classes/MinaActions.md @@ -10,7 +10,7 @@ title: MinaActions # Class: MinaActions -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L28) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L28) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:28](htt > `static` **actionHash**(`action`, `previousHash`): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L29) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md b/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md index 9d476bf..0b4b33a 100644 --- a/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md +++ b/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md @@ -10,7 +10,7 @@ title: MinaActionsHashList # Class: MinaActionsHashList -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L69) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L69) Utilities for creating a hash list from a given value type. @@ -24,7 +24,7 @@ Utilities for creating a hash list from a given value type. > **new MinaActionsHashList**(`internalCommitment`): [`MinaActionsHashList`](MinaActionsHashList.md) -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L70) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L70) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:70](htt > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > `readonly` **prefix**: `string` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](htt > `protected` `readonly` **valueType**: `ProvablePure`\<`Field`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > `protected` **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) #### Parameters @@ -104,7 +104,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](htt > **push**(`value`): [`MinaActionsHashList`](MinaActionsHashList.md) -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -133,7 +133,7 @@ Current hash list. > **pushIf**(`value`, `condition`): [`MinaActionsHashList`](MinaActionsHashList.md) -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L29) #### Parameters @@ -159,7 +159,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github. > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/MinaEvents.md b/src/pages/docs/reference/protocol/classes/MinaEvents.md index 497c10e..4e6c1e4 100644 --- a/src/pages/docs/reference/protocol/classes/MinaEvents.md +++ b/src/pages/docs/reference/protocol/classes/MinaEvents.md @@ -10,7 +10,7 @@ title: MinaEvents # Class: MinaEvents -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L41) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:41](htt > `static` **eventHash**(`event`, `previousHash`): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L42) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L42) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md b/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md index 087c9d9..be40be9 100644 --- a/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md +++ b/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md @@ -10,7 +10,7 @@ title: MinaPrefixedProvableHashList # Class: MinaPrefixedProvableHashList\ -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L51) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L51) Utilities for creating a hash list from a given value type. @@ -32,7 +32,7 @@ Utilities for creating a hash list from a given value type. > **new MinaPrefixedProvableHashList**\<`Value`\>(`valueType`, `prefix`, `internalCommitment`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L54) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L54) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:54](htt > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > `readonly` **prefix**: `string` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) *** @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](htt > `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > `protected` **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) #### Parameters @@ -116,7 +116,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](htt > **push**(`value`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -145,7 +145,7 @@ Current hash list. > **pushIf**(`value`, `condition`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L29) #### Parameters @@ -171,7 +171,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github. > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/NetworkState.md b/src/pages/docs/reference/protocol/classes/NetworkState.md index 5c22f43..5d68b15 100644 --- a/src/pages/docs/reference/protocol/classes/NetworkState.md +++ b/src/pages/docs/reference/protocol/classes/NetworkState.md @@ -10,7 +10,7 @@ title: NetworkState # Class: NetworkState -Defined in: [packages/protocol/src/model/network/NetworkState.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L12) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L12) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **block**: [`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` -Defined in: [packages/protocol/src/model/network/NetworkState.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L13) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L13) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/network/NetworkState.ts:13](https://git > **previous**: [`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` -Defined in: [packages/protocol/src/model/network/NetworkState.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L14) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L14) #### Inherited from @@ -406,7 +406,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/model/network/NetworkState.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L16) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L16) #### Returns @@ -418,7 +418,7 @@ Defined in: [packages/protocol/src/model/network/NetworkState.ts:16](https://git > `static` **empty**(): [`NetworkState`](NetworkState.md) -Defined in: [packages/protocol/src/model/network/NetworkState.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L23) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L23) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md b/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md index 55c2b10..44eb96a 100644 --- a/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md +++ b/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md @@ -10,7 +10,7 @@ title: NetworkStateSettlementModule # Class: NetworkStateSettlementModule -Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L14) +Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L14) Used by various module sub-types that may need to be configured @@ -53,7 +53,7 @@ checks when retrieving it via the getter > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -117,7 +117,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **beforeSettlement**(`smartContract`, `__namedParameters`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L15) +Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L15) #### Parameters @@ -143,7 +143,7 @@ Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModu > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -165,7 +165,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/Option.md b/src/pages/docs/reference/protocol/classes/Option.md index 1fa7bd7..0f36e90 100644 --- a/src/pages/docs/reference/protocol/classes/Option.md +++ b/src/pages/docs/reference/protocol/classes/Option.md @@ -10,7 +10,7 @@ title: Option # Class: Option\ -Defined in: [packages/protocol/src/model/Option.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L84) +Defined in: [packages/protocol/src/model/Option.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L84) Option facilitating in-circuit values that may or may not exist. @@ -28,7 +28,7 @@ Option facilitating in-circuit values that may or may not exist. > **new Option**\<`Value`\>(`isSome`, `value`, `valueType`, `isForcedSome`): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L122) +Defined in: [packages/protocol/src/model/Option.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L122) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/Option.ts:122](https://github.com/proto > **isForcedSome**: `Bool` -Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L24) +Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L24) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto- > **isSome**: `Bool` -Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L23) +Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L23) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto- > **value**: `Value` -Defined in: [packages/protocol/src/model/Option.ts:124](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L124) +Defined in: [packages/protocol/src/model/Option.ts:124](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L124) *** @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/model/Option.ts:124](https://github.com/proto > **valueType**: `FlexibleProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:125](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L125) +Defined in: [packages/protocol/src/model/Option.ts:125](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L125) ## Accessors @@ -104,7 +104,7 @@ Defined in: [packages/protocol/src/model/Option.ts:125](https://github.com/proto > **get** **treeValue**(): `Field` -Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L34) +Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L34) ##### Returns @@ -122,7 +122,7 @@ Tree representation of the current value > **clone**(): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:135](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L135) +Defined in: [packages/protocol/src/model/Option.ts:135](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L135) #### Returns @@ -138,7 +138,7 @@ Defined in: [packages/protocol/src/model/Option.ts:135](https://github.com/proto > **encodeValueToFields**(): `Field`[] -Defined in: [packages/protocol/src/model/Option.ts:131](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L131) +Defined in: [packages/protocol/src/model/Option.ts:131](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L131) #### Returns @@ -154,7 +154,7 @@ Defined in: [packages/protocol/src/model/Option.ts:131](https://github.com/proto > **forceSome**(): `void` -Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L44) +Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L44) #### Returns @@ -170,7 +170,7 @@ Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto- > **orElse**(`defaultValue`): `Value` -Defined in: [packages/protocol/src/model/Option.ts:148](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L148) +Defined in: [packages/protocol/src/model/Option.ts:148](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L148) #### Parameters @@ -191,7 +191,7 @@ otherwise returns the given defaultValue > **toConstant**(): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:157](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L157) +Defined in: [packages/protocol/src/model/Option.ts:157](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L157) #### Returns @@ -203,7 +203,7 @@ Defined in: [packages/protocol/src/model/Option.ts:157](https://github.com/proto > **toFields**(): `Field`[] -Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L53) +Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L53) Returns the `to`-value as decoded as a list of fields Not in circuit @@ -222,7 +222,7 @@ Not in circuit > **toJSON**(): `object` -Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L70) +Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L70) #### Returns @@ -250,7 +250,7 @@ Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto- > **toProvable**(): [`ProvableOption`](ProvableOption.md) -Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L63) +Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L63) #### Returns @@ -268,7 +268,7 @@ Provable representation of the current option. > `static` **from**\<`Value`\>(`isSome`, `value`, `valueType`): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:93](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L93) +Defined in: [packages/protocol/src/model/Option.ts:93](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L93) Creates a new Option from the provided parameters @@ -302,7 +302,7 @@ New option from the provided parameters. > `static` **fromValue**\<`Value`\>(`value`, `valueType`): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L108) +Defined in: [packages/protocol/src/model/Option.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L108) Creates a new Option from the provided parameters @@ -332,7 +332,7 @@ New option from the provided parameters. > `static` **none**(): [`Option`](Option.md)\<`Field`\> -Defined in: [packages/protocol/src/model/Option.ts:118](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L118) +Defined in: [packages/protocol/src/model/Option.ts:118](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L118) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/OptionBase.md b/src/pages/docs/reference/protocol/classes/OptionBase.md index 79e878c..2de9709 100644 --- a/src/pages/docs/reference/protocol/classes/OptionBase.md +++ b/src/pages/docs/reference/protocol/classes/OptionBase.md @@ -10,7 +10,7 @@ title: OptionBase # Class: `abstract` OptionBase -Defined in: [packages/protocol/src/model/Option.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L21) +Defined in: [packages/protocol/src/model/Option.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L21) ## Extended by @@ -23,7 +23,7 @@ Defined in: [packages/protocol/src/model/Option.ts:21](https://github.com/proto- > `protected` **new OptionBase**(`isSome`, `isForcedSome`): [`OptionBase`](OptionBase.md) -Defined in: [packages/protocol/src/model/Option.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L22) +Defined in: [packages/protocol/src/model/Option.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L22) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/protocol/src/model/Option.ts:22](https://github.com/proto- > **isForcedSome**: `Bool` -Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L24) +Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L24) *** @@ -53,7 +53,7 @@ Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto- > **isSome**: `Bool` -Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L23) +Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L23) ## Accessors @@ -63,7 +63,7 @@ Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto- > **get** **treeValue**(): `Field` -Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L34) +Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L34) ##### Returns @@ -77,7 +77,7 @@ Tree representation of the current value > `abstract` `protected` **clone**(): [`OptionBase`](OptionBase.md) -Defined in: [packages/protocol/src/model/Option.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L29) +Defined in: [packages/protocol/src/model/Option.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L29) #### Returns @@ -89,7 +89,7 @@ Defined in: [packages/protocol/src/model/Option.ts:29](https://github.com/proto- > `abstract` `protected` **encodeValueToFields**(): `Field`[] -Defined in: [packages/protocol/src/model/Option.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L27) +Defined in: [packages/protocol/src/model/Option.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L27) #### Returns @@ -101,7 +101,7 @@ Defined in: [packages/protocol/src/model/Option.ts:27](https://github.com/proto- > **forceSome**(): `void` -Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L44) +Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L44) #### Returns @@ -113,7 +113,7 @@ Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto- > **toFields**(): `Field`[] -Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L53) +Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L53) Returns the `to`-value as decoded as a list of fields Not in circuit @@ -128,7 +128,7 @@ Not in circuit > **toJSON**(): `object` -Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L70) +Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L70) #### Returns @@ -152,7 +152,7 @@ Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto- > **toProvable**(): [`ProvableOption`](ProvableOption.md) -Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L63) +Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L63) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md index ec1ccec..0844a3a 100644 --- a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md +++ b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md @@ -10,7 +10,7 @@ title: OutgoingMessageArgument # Class: OutgoingMessageArgument -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L8) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L8) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **value**: [`Withdrawal`](Withdrawal.md) = `Withdrawal` -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L10) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L10) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.t > **witness**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L9) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L9) #### Inherited from @@ -474,7 +474,7 @@ Convert provable type to a normal JS type. > `static` **dummy**(): [`OutgoingMessageArgument`](OutgoingMessageArgument.md) -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L12) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L12) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md index 38c0e47..0299b5c 100644 --- a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md +++ b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md @@ -10,7 +10,7 @@ title: OutgoingMessageArgumentBatch # Class: OutgoingMessageArgumentBatch -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L20) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L20) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **arguments**: [`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L21) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L21) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.t > **isDummys**: `Bool`[] -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L26) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L26) #### Inherited from @@ -406,7 +406,7 @@ Convert provable type to a normal JS type. > `static` **fromMessages**(`providedArguments`): [`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L28) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L28) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md index 1630274..36d1c1d 100644 --- a/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md +++ b/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md @@ -10,7 +10,7 @@ title: OutgoingMessageKey # Class: OutgoingMessageKey -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L49) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L49) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **index**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L50) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L50) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:50](ht > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L51) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L51) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/Path.md b/src/pages/docs/reference/protocol/classes/Path.md index 9227cca..677a25c 100644 --- a/src/pages/docs/reference/protocol/classes/Path.md +++ b/src/pages/docs/reference/protocol/classes/Path.md @@ -10,7 +10,7 @@ title: Path # Class: Path -Defined in: [packages/protocol/src/model/Path.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Path.ts#L8) +Defined in: [packages/protocol/src/model/Path.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Path.ts#L8) Helps manage path (key) identifiers for key-values in trees. @@ -30,7 +30,7 @@ Helps manage path (key) identifiers for key-values in trees. > `static` **fromKey**\<`KeyType`\>(`path`, `keyType`, `key`): `Field` -Defined in: [packages/protocol/src/model/Path.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Path.ts#L42) +Defined in: [packages/protocol/src/model/Path.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Path.ts#L42) Encodes an existing path with the provided key into a single Field. @@ -64,7 +64,7 @@ Field representation of the leading path + the provided key. > `static` **fromProperty**(`className`, `propertyKey`): `Field` -Defined in: [packages/protocol/src/model/Path.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Path.ts#L26) +Defined in: [packages/protocol/src/model/Path.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Path.ts#L26) Encodes a class name and its property name into a Field @@ -90,7 +90,7 @@ Field representation of class name + property name > `static` **toField**(`value`): `Field` -Defined in: [packages/protocol/src/model/Path.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Path.ts#L15) +Defined in: [packages/protocol/src/model/Path.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Path.ts#L15) Encodes a JS string as a Field diff --git a/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md b/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md index a3acfa2..13ebf76 100644 --- a/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md +++ b/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md @@ -10,7 +10,7 @@ title: PrefixedProvableHashList # Class: PrefixedProvableHashList\ -Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/PrefixedProvableHashList.ts#L6) +Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/PrefixedProvableHashList.ts#L6) Utilities for creating a hash list from a given value type. @@ -28,7 +28,7 @@ Utilities for creating a hash list from a given value type. > **new PrefixedProvableHashList**\<`Value`\>(`valueType`, `prefix`, `internalCommitment`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/PrefixedProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/PrefixedProvableHashList.ts#L9) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:9](https:// > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > `protected` **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/PrefixedProvableHashList.ts#L18) +Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/PrefixedProvableHashList.ts#L18) #### Parameters @@ -104,7 +104,7 @@ Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:18](https:/ > **push**(`value`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -133,7 +133,7 @@ Current hash list. > **pushIf**(`value`, `condition`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L29) #### Parameters @@ -159,7 +159,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github. > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/PreviousBlock.md b/src/pages/docs/reference/protocol/classes/PreviousBlock.md index 1cd5d17..f4336ea 100644 --- a/src/pages/docs/reference/protocol/classes/PreviousBlock.md +++ b/src/pages/docs/reference/protocol/classes/PreviousBlock.md @@ -10,7 +10,7 @@ title: PreviousBlock # Class: PreviousBlock -Defined in: [packages/protocol/src/model/network/NetworkState.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L8) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L8) ## Extends @@ -46,7 +46,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **rootHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/network/NetworkState.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/network/NetworkState.ts#L9) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L9) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/Protocol.md b/src/pages/docs/reference/protocol/classes/Protocol.md index 02b425b..e5b3b66 100644 --- a/src/pages/docs/reference/protocol/classes/Protocol.md +++ b/src/pages/docs/reference/protocol/classes/Protocol.md @@ -10,7 +10,7 @@ title: Protocol # Class: Protocol\ -Defined in: [packages/protocol/src/protocol/Protocol.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L60) +Defined in: [packages/protocol/src/protocol/Protocol.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L60) Reusable module container facilitating registration, resolution configuration, decoration and validation of modules @@ -33,7 +33,7 @@ configuration, decoration and validation of modules > **new Protocol**\<`Modules`\>(`definition`): [`Protocol`](Protocol.md)\<`Modules`\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L78) +Defined in: [packages/protocol/src/protocol/Protocol.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L78) #### Parameters @@ -70,7 +70,7 @@ checks when retrieving it via the getter > **definition**: [`ProtocolDefinition`](../interfaces/ProtocolDefinition.md)\<`Modules`\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L76) +Defined in: [packages/protocol/src/protocol/Protocol.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L76) #### Overrides @@ -84,7 +84,7 @@ Defined in: [packages/protocol/src/protocol/Protocol.ts:76](https://github.com/p > **get** **blockProver**(): [`BlockProvable`](../interfaces/BlockProvable.md) -Defined in: [packages/protocol/src/protocol/Protocol.ts:115](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L115) +Defined in: [packages/protocol/src/protocol/Protocol.ts:115](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L115) ##### Returns @@ -150,7 +150,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 > **get** **dependencyContainer**(): `DependencyContainer` -Defined in: [packages/protocol/src/protocol/Protocol.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L105) +Defined in: [packages/protocol/src/protocol/Protocol.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L105) ##### Returns @@ -202,7 +202,7 @@ list of module names > **get** **stateService**(): [`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) -Defined in: [packages/protocol/src/protocol/Protocol.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L83) +Defined in: [packages/protocol/src/protocol/Protocol.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L83) ##### Returns @@ -220,7 +220,7 @@ Defined in: [packages/protocol/src/protocol/Protocol.ts:83](https://github.com/p > **get** **stateServiceProvider**(): [`StateServiceProvider`](StateServiceProvider.md) -Defined in: [packages/protocol/src/protocol/Protocol.ts:87](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L87) +Defined in: [packages/protocol/src/protocol/Protocol.ts:87](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L87) ##### Returns @@ -238,7 +238,7 @@ Defined in: [packages/protocol/src/protocol/Protocol.ts:87](https://github.com/p > **get** **stateTransitionProver**(): [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) -Defined in: [packages/protocol/src/protocol/Protocol.ts:123](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L123) +Defined in: [packages/protocol/src/protocol/Protocol.ts:123](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L123) ##### Returns @@ -348,7 +348,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/Protocol.ts:133](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L133) +Defined in: [packages/protocol/src/protocol/Protocol.ts:133](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L133) This is a placeholder for individual modules to override. This method will be called whenever the underlying container fully @@ -374,7 +374,7 @@ initialized > **decorateModule**(`moduleName`, `containedModule`): `void` -Defined in: [packages/protocol/src/protocol/Protocol.ts:91](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L91) +Defined in: [packages/protocol/src/protocol/Protocol.ts:91](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L91) Override this in the child class to provide custom features or module checks @@ -403,7 +403,7 @@ features or module checks > **getAreProofsEnabled**(): [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/Protocol.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L129) +Defined in: [packages/protocol/src/protocol/Protocol.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L129) #### Returns @@ -658,7 +658,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:186](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L186) +Defined in: [packages/protocol/src/protocol/Protocol.ts:186](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L186) #### Returns @@ -699,7 +699,7 @@ such as only injecting other known modules. > `static` **from**\<`Modules`\>(`modules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](Protocol.md)\<`Modules`\>\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L66) +Defined in: [packages/protocol/src/protocol/Protocol.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L66) #### Type Parameters diff --git a/src/pages/docs/reference/protocol/classes/ProtocolModule.md b/src/pages/docs/reference/protocol/classes/ProtocolModule.md index 147516e..fe9e8ba 100644 --- a/src/pages/docs/reference/protocol/classes/ProtocolModule.md +++ b/src/pages/docs/reference/protocol/classes/ProtocolModule.md @@ -10,7 +10,7 @@ title: ProtocolModule # Class: `abstract` ProtocolModule\ -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L11) Used by various module sub-types that may need to be configured @@ -65,7 +65,7 @@ checks when retrieving it via the getter > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) ## Accessors @@ -75,7 +75,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -121,7 +121,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -143,7 +143,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md b/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md index ce9974d..948fcf3 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md +++ b/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md @@ -10,7 +10,7 @@ title: ProvableBlockHook # Class: `abstract` ProvableBlockHook\ -Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProvableBlockHook.ts#L7) +Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProvableBlockHook.ts#L7) ## Extends @@ -60,7 +60,7 @@ checks when retrieving it via the getter > `optional` **name**: `string` -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](h > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -136,7 +136,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > `abstract` **afterBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProvableBlockHook.ts#L15) +Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProvableBlockHook.ts#L15) #### Parameters @@ -158,7 +158,7 @@ Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:15](https://git > `abstract` **beforeBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProvableBlockHook.ts#L10) +Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProvableBlockHook.ts#L10) #### Parameters @@ -180,7 +180,7 @@ Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:10](https://git > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -202,7 +202,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableHashList.md b/src/pages/docs/reference/protocol/classes/ProvableHashList.md index ccbcbd2..b477f14 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableHashList.md +++ b/src/pages/docs/reference/protocol/classes/ProvableHashList.md @@ -10,7 +10,7 @@ title: ProvableHashList # Class: `abstract` ProvableHashList\ -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L6) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L6) Utilities for creating a hash list from a given value type. @@ -31,7 +31,7 @@ Utilities for creating a hash list from a given value type. > **new ProvableHashList**\<`Value`\>(`valueType`, `commitment`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L7) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L7) #### Parameters @@ -53,7 +53,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.c > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) *** @@ -61,7 +61,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) ## Methods @@ -69,7 +69,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > `abstract` `protected` **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L12) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L12) #### Parameters @@ -87,7 +87,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:12](https://github. > **push**(`value`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -112,7 +112,7 @@ Current hash list. > **pushIf**(`value`, `condition`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L29) #### Parameters @@ -134,7 +134,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github. > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableOption.md b/src/pages/docs/reference/protocol/classes/ProvableOption.md index 28bb333..032d242 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableOption.md +++ b/src/pages/docs/reference/protocol/classes/ProvableOption.md @@ -10,7 +10,7 @@ title: ProvableOption # Class: ProvableOption -Defined in: [packages/protocol/src/model/Option.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L11) +Defined in: [packages/protocol/src/model/Option.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L11) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **isSome**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/Option.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L12) +Defined in: [packages/protocol/src/model/Option.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L12) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/Option.ts:12](https://github.com/proto- > **value**: `Field` = `Field` -Defined in: [packages/protocol/src/model/Option.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L13) +Defined in: [packages/protocol/src/model/Option.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L13) #### Inherited from @@ -406,7 +406,7 @@ Convert provable type to a normal JS type. > **toSome**(): [`ProvableOption`](ProvableOption.md) -Defined in: [packages/protocol/src/model/Option.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/Option.ts#L15) +Defined in: [packages/protocol/src/model/Option.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L15) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md b/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md index fc8b639..132f319 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md +++ b/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md @@ -10,7 +10,7 @@ title: ProvableReductionHashList # Class: ProvableReductionHashList\ -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L5) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L5) Utilities for creating a hash list from a given value type. @@ -32,7 +32,7 @@ Utilities for creating a hash list from a given value type. > **new ProvableReductionHashList**\<`Value`\>(`valueType`, `commitment`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L7) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L7) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.c > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > **unconstrainedList**: `Value`[] = `[]` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) *** @@ -78,7 +78,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https:/ > `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) #### Parameters @@ -112,7 +112,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https: > **push**(`value`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -141,7 +141,7 @@ Current hash list. > **pushAndReduce**(`value`, `reduce`): `object` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) #### Parameters @@ -171,7 +171,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https: > **pushIf**(`value`, `condition`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) #### Parameters @@ -197,7 +197,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https: > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md b/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md index 00705aa..7961355 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md +++ b/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md @@ -10,7 +10,7 @@ title: ProvableSettlementHook # Class: `abstract` ProvableSettlementHook\ -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L29) +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L29) Used by various module sub-types that may need to be configured @@ -61,7 +61,7 @@ checks when retrieving it via the getter > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -125,7 +125,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > `abstract` **beforeSettlement**(`smartContract`, `inputs`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L32) +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L32) #### Parameters @@ -147,7 +147,7 @@ Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook. > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -169,7 +169,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md b/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md index 85d3bef..23c20a9 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md +++ b/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md @@ -10,7 +10,7 @@ title: ProvableStateTransition # Class: ProvableStateTransition -Defined in: [packages/protocol/src/model/StateTransition.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L10) +Defined in: [packages/protocol/src/model/StateTransition.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L10) Provable representation of a State Transition, used to normalize state transitions of various value types for @@ -58,7 +58,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **from**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` -Defined in: [packages/protocol/src/model/StateTransition.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L14) +Defined in: [packages/protocol/src/model/StateTransition.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L14) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:14](https://github.c > **path**: `Field` = `Field` -Defined in: [packages/protocol/src/model/StateTransition.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L11) +Defined in: [packages/protocol/src/model/StateTransition.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L11) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:11](https://github.c > **to**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` -Defined in: [packages/protocol/src/model/StateTransition.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L17) +Defined in: [packages/protocol/src/model/StateTransition.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L17) #### Inherited from @@ -522,7 +522,7 @@ Convert provable type to a normal JS type. > `static` **dummy**(): [`ProvableStateTransition`](ProvableStateTransition.md) -Defined in: [packages/protocol/src/model/StateTransition.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L19) +Defined in: [packages/protocol/src/model/StateTransition.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L19) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md b/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md index 5c53774..b99111a 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md +++ b/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md @@ -10,7 +10,7 @@ title: ProvableStateTransitionType # Class: ProvableStateTransitionType -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L27) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L27) ## Extends @@ -46,7 +46,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **type**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L28) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L28) #### Inherited from @@ -344,7 +344,7 @@ Convert provable type to a normal JS type. > **get** `static` **normal**(): [`ProvableStateTransitionType`](ProvableStateTransitionType.md) -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L30) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L30) ##### Returns @@ -358,7 +358,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:30](htt > **get** `static` **protocol**(): [`ProvableStateTransitionType`](ProvableStateTransitionType.md) -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L36) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L36) ##### Returns @@ -370,7 +370,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:36](htt > **isNormal**(): `Bool` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L42) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L42) #### Returns @@ -382,7 +382,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:42](htt > **isProtocol**(): `Bool` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L46) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L46) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md b/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md index c042068..88f8124 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md +++ b/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md @@ -10,7 +10,7 @@ title: ProvableTransactionHook # Class: `abstract` ProvableTransactionHook\ -Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProvableTransactionHook.ts#L7) +Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProvableTransactionHook.ts#L7) ## Extends @@ -60,7 +60,7 @@ checks when retrieving it via the getter > `optional` **name**: `string` -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](h > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -136,7 +136,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -158,7 +158,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > `abstract` **onTransaction**(`executionData`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProvableTransactionHook.ts#L10) +Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProvableTransactionHook.ts#L10) #### Parameters @@ -176,7 +176,7 @@ Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:10](https > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/PublicKeyOption.md b/src/pages/docs/reference/protocol/classes/PublicKeyOption.md index 535fd35..64db171 100644 --- a/src/pages/docs/reference/protocol/classes/PublicKeyOption.md +++ b/src/pages/docs/reference/protocol/classes/PublicKeyOption.md @@ -10,7 +10,7 @@ title: PublicKeyOption # Class: PublicKeyOption -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L26) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L26) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **isSome**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L5) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L5) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://g > **value**: `PublicKey` = `valueType` -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L6) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L6) #### Inherited from @@ -420,7 +420,7 @@ Convert provable type to a normal JS type. > `static` **fromSome**(`value`): `Generic`\<`PublicKey`\> -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L8) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L8) #### Parameters @@ -442,7 +442,7 @@ Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://g > `static` **none**(`value`): `Generic`\<`PublicKey`\> -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L15) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L15) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md index 1f32379..2c263ba 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md @@ -10,7 +10,7 @@ title: RuntimeMethodExecutionContext # Class: RuntimeMethodExecutionContext -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L54) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L54) Execution context used to wrap runtime module methods, allowing them to post relevant information (such as execution status) @@ -52,7 +52,7 @@ Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d > **input**: `undefined` \| [`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md) -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L57) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L57) *** @@ -60,7 +60,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **methods**: `string`[] = `[]` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L55) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L55) #### Overrides @@ -72,7 +72,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **result**: [`RuntimeProvableMethodExecutionResult`](RuntimeProvableMethodExecutionResult.md) -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L62) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L62) #### Overrides @@ -120,7 +120,7 @@ Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d > **addEvent**(`eventType`, `event`, `eventName`, `condition`): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:83](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L83) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L83) #### Parameters @@ -150,7 +150,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **addStateTransition**\<`Value`\>(`stateTransition`): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L78) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L78) Adds an in-method generated state transition to the current context @@ -176,7 +176,7 @@ State transition to add to the context > **afterMethod**(): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:152](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L152) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:152](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L152) Removes the latest method from the execution context stack, keeping track of the amount of 'unfinished' methods. Allowing @@ -231,7 +231,7 @@ Name of the method being captured in the context > **clear**(): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:148](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L148) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:148](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L148) Manually clears/resets the execution context @@ -249,7 +249,7 @@ Manually clears/resets the execution context > **current**(): `object` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:166](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L166) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:166](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L166) Had to override current() otherwise it would not infer the type of result correctly (parent type would be reused) @@ -309,7 +309,7 @@ which can be collected and ran asynchronously at a later point in time. > **setSimulated**(`simulated`): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:141](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L141) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:141](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L141) #### Parameters @@ -327,7 +327,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **setStatus**(`status`): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L114) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L114) #### Parameters @@ -347,7 +347,7 @@ Execution status of the current method > **setStatusMessage**(`message`?, `stackTrace`?): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L102) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L102) #### Parameters @@ -371,7 +371,7 @@ Status message to acompany the current status > **setup**(`input`): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:125](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L125) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:125](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L125) #### Parameters @@ -391,7 +391,7 @@ Input witness data required for a runtime execution > **witnessInput**(): [`RuntimeMethodExecutionDataStruct`](RuntimeMethodExecutionDataStruct.md) -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L129) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L129) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md index 3c465f6..6a11a86 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md @@ -10,7 +10,7 @@ title: RuntimeMethodExecutionDataStruct # Class: RuntimeMethodExecutionDataStruct -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L41) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L41) ## Extends @@ -54,7 +54,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L44) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L44) #### Implementation of @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L43) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L43) #### Implementation of diff --git a/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md b/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md index 574fc84..2360f73 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md @@ -10,7 +10,7 @@ title: RuntimeProvableMethodExecutionResult # Class: RuntimeProvableMethodExecutionResult -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L19) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L19) ## Extends @@ -48,7 +48,7 @@ Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d > **events**: `object`[] = `[]` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L28) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L28) #### condition @@ -112,7 +112,7 @@ Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d > `optional` **stackTrace**: `string` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L26) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L26) *** @@ -120,7 +120,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **stateTransitions**: [`StateTransition`](StateTransition.md)\<`any`\>[] = `[]` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L20) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L20) *** @@ -128,7 +128,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **status**: `Bool` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L22) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L22) *** @@ -136,7 +136,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > `optional` **statusMessage**: `string` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L24) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L24) ## Methods diff --git a/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md b/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md index 725ef05..0255a5c 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md @@ -10,7 +10,7 @@ title: RuntimeTransaction # Class: RuntimeTransaction -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L11) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L11) This struct is used to expose transaction information to the runtime method execution. This class has not all data included in transactions on purpose. @@ -62,7 +62,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **argsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L13) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L13) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:13](h > **methodId**: `Field` = `Field` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L12) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L12) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:12](h > **nonce**: [`UInt64Option`](UInt64Option.md) = `UInt64Option` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L14) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L14) #### Inherited from @@ -98,7 +98,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:14](h > **sender**: [`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L15) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L15) #### Inherited from @@ -600,7 +600,7 @@ Convert provable type to a normal JS type. > **assertTransactionType**(`isMessage`): `void` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L61) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L61) #### Parameters @@ -618,7 +618,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:61](h > **hash**(): `Field` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:102](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L102) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:102](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L102) #### Returns @@ -630,7 +630,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:102]( > **hashData**(): `Field`[] -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L76) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L76) #### Returns @@ -642,7 +642,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:76](h > `static` **dummyTransaction**(): [`RuntimeTransaction`](RuntimeTransaction.md) -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L46) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L46) #### Returns @@ -654,7 +654,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:46](h > `static` **fromHashData**(`fields`): [`RuntimeTransaction`](RuntimeTransaction.md) -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L85) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L85) #### Parameters @@ -672,7 +672,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:85](h > `static` **fromMessage**(`__namedParameters`): [`RuntimeTransaction`](RuntimeTransaction.md) -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L31) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L31) #### Parameters @@ -696,7 +696,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:31](h > `static` **fromTransaction**(`input`): [`RuntimeTransaction`](RuntimeTransaction.md) -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L17) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L17) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md index 0af0f82..5e74f4e 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md @@ -10,7 +10,7 @@ title: RuntimeVerificationKeyAttestation # Class: RuntimeVerificationKeyAttestation -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L8) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L8) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **verificationKey**: `VerificationKey` = `VerificationKey` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L9) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L9) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificatio > **witness**: [`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L10) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L10) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md index a56158d..9e2c6b3 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md @@ -10,7 +10,7 @@ title: RuntimeVerificationKeyRootService # Class: RuntimeVerificationKeyRootService -Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L7) +Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L7) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyR > **getRoot**(): `bigint` -Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L14) +Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L14) #### Returns @@ -48,7 +48,7 @@ Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyR > **setRoot**(`root`): `void` -Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L10) +Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/SettlementContractModule.md b/src/pages/docs/reference/protocol/classes/SettlementContractModule.md index f8baf5f..761bd35 100644 --- a/src/pages/docs/reference/protocol/classes/SettlementContractModule.md +++ b/src/pages/docs/reference/protocol/classes/SettlementContractModule.md @@ -10,7 +10,7 @@ title: SettlementContractModule # Class: SettlementContractModule\ -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L46) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L46) Used by various module sub-types that may need to be configured @@ -32,7 +32,7 @@ Used by various module sub-types that may need to be configured > **new SettlementContractModule**\<`SettlementModules`\>(`definition`): [`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L53) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L53) #### Parameters @@ -87,7 +87,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L94) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L94) #### Implementation of @@ -101,7 +101,7 @@ Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:94](ht > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:96](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L96) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:96](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L96) ##### Returns @@ -309,7 +309,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:101](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L101) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:101](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L101) This is a placeholder for individual modules to override. This method will be called whenever the underlying container fully @@ -339,7 +339,7 @@ initialized > **createBridgeContract**(`address`, `tokenId`?): [`BridgeContractType`](../type-aliases/BridgeContractType.md) & `SmartContract` -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:137](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L137) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:137](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L137) #### Parameters @@ -361,7 +361,7 @@ Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:137](h > **createContracts**(`addresses`): `object` -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:119](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L119) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:119](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L119) #### Parameters @@ -422,7 +422,7 @@ features or module checks > **getContractClasses**(): `GetContracts`\<`SettlementModules`\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L109) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L109) #### Returns @@ -673,7 +673,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L105) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L105) #### Returns @@ -718,7 +718,7 @@ such as only injecting other known modules. > `static` **from**\<`SettlementModules`\>(`modules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\>\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L57) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L57) #### Type Parameters @@ -740,7 +740,7 @@ Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:57](ht > `static` **fromDefaults**(): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<\{ `BridgeContract`: *typeof* [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md); `DispatchContract`: *typeof* [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md); `SettlementContract`: *typeof* [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md); \}\>\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L78) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L78) #### Returns @@ -752,7 +752,7 @@ Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:78](ht > `static` **mandatoryModules**(): `object` -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L70) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L70) #### Returns @@ -776,7 +776,7 @@ Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:70](ht > `static` **with**\<`AdditionalModules`\>(`additionalModules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`object` & `AdditionalModules`\>\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L84) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L84) #### Type Parameters diff --git a/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md index 0704ca2..8738c87 100644 --- a/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md +++ b/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md @@ -10,7 +10,7 @@ title: SettlementContractProtocolModule # Class: SettlementContractProtocolModule -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L34) +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L34) This module type is used to define a contract module that can be used to construct and inject smart contract instances. @@ -29,7 +29,7 @@ ContractType generic. > **new SettlementContractProtocolModule**(`hooks`, `blockProver`, `dispatchContractModule`, `bridgeContractModule`, `childVerificationKeyService`): [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md) -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L38) +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L38) #### Parameters @@ -116,7 +116,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compile**(`registry`): `Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L82) +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L82) #### Parameters @@ -138,7 +138,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtoc > **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L52) +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L52) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md b/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md index f0b6f1f..3b98a14 100644 --- a/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md +++ b/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md @@ -10,7 +10,7 @@ title: SettlementSmartContract # Class: SettlementSmartContract -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:433](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L433) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:433](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L433) ## Extends @@ -64,7 +64,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 > **authorizationField**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:446](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L446) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:446](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L446) #### Implementation of @@ -80,7 +80,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **blockHashRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:442](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L442) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:442](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L442) #### Overrides @@ -92,7 +92,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **dispatchContractAddressX**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:444](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L444) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:444](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L444) #### Overrides @@ -104,7 +104,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **events**: `object` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) A list of event types that can be emitted using this.emitEvent()`. @@ -122,7 +122,7 @@ A list of event types that can be emitted using this.emitEvent()`. > **lastSettlementL1BlockHeight**: `State`\<`UInt32`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:438](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L438) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:438](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L438) #### Overrides @@ -134,7 +134,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **networkStateHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:441](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L441) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:441](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L441) #### Overrides @@ -211,7 +211,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > **sequencerKey**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:437](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L437) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:437](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L437) #### Overrides @@ -223,7 +223,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **stateRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:440](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L440) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:440](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L440) #### Overrides @@ -315,7 +315,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) #### BridgeContract @@ -578,7 +578,7 @@ Returns the current AccountUpdate associated to this SmartContract. > **addTokenBridge**(`tokenId`, `address`, `dispatchContract`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:468](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L468) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:468](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L468) #### Parameters @@ -698,7 +698,7 @@ Approve a list of account updates (with arbitrarily many children). > **approveBase**(`forest`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:448](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L448) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:448](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L448) #### Parameters @@ -720,7 +720,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **assertStateRoot**(`root`): `AccountUpdate` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) #### Parameters @@ -814,7 +814,7 @@ async deploy() { > `protected` **deployTokenBridge**(`tokenId`, `address`, `dispatchContractAddress`, `dispatchContractPreconditionEnforced`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) #### Parameters @@ -1043,7 +1043,7 @@ class MyContract extends SmartContract { > **initialize**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:453](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L453) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:453](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L453) #### Parameters @@ -1077,7 +1077,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `protected` **initializeBase**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) #### Parameters @@ -1189,7 +1189,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 > **settle**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:477](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L477) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:477](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L477) #### Parameters @@ -1235,7 +1235,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `protected` **settleBase**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md b/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md index 0e403d3..ce4222b 100644 --- a/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md +++ b/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md @@ -10,7 +10,7 @@ title: SettlementSmartContractBase # Class: `abstract` SettlementSmartContractBase -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L108) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L108) ## Extends @@ -64,7 +64,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 > `abstract` **authorizationField**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:135](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L135) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:135](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L135) *** @@ -72,7 +72,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `abstract` **blockHashRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L132) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L132) *** @@ -80,7 +80,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `abstract` **dispatchContractAddressX**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:133](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L133) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:133](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L133) *** @@ -88,7 +88,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **events**: `object` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) A list of event types that can be emitted using this.emitEvent()`. @@ -106,7 +106,7 @@ A list of event types that can be emitted using this.emitEvent()`. > `abstract` **lastSettlementL1BlockHeight**: `State`\<`UInt32`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L129) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L129) *** @@ -114,7 +114,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `abstract` **networkStateHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:131](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L131) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:131](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L131) *** @@ -187,7 +187,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > `abstract` **sequencerKey**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:128](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L128) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:128](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L128) *** @@ -195,7 +195,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `abstract` **stateRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L130) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L130) *** @@ -283,7 +283,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) #### BridgeContract @@ -654,7 +654,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:62 > **assertStateRoot**(`root`): `AccountUpdate` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) #### Parameters @@ -740,7 +740,7 @@ async deploy() { > `protected` **deployTokenBridge**(`tokenId`, `address`, `dispatchContractAddress`, `dispatchContractPreconditionEnforced`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) #### Parameters @@ -965,7 +965,7 @@ class MyContract extends SmartContract { > `protected` **initializeBase**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) #### Parameters @@ -1073,7 +1073,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 > `protected` **settleBase**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/SignedTransaction.md b/src/pages/docs/reference/protocol/classes/SignedTransaction.md index a66dce7..1046abd 100644 --- a/src/pages/docs/reference/protocol/classes/SignedTransaction.md +++ b/src/pages/docs/reference/protocol/classes/SignedTransaction.md @@ -10,7 +10,7 @@ title: SignedTransaction # Class: SignedTransaction -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L5) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L5) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **signature**: `Signature` = `Signature` -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L7) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L7) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:7](htt > **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L6) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L6) #### Inherited from @@ -516,7 +516,7 @@ Convert provable type to a normal JS type. > **getSignatureData**(): `Field`[] -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L32) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L32) #### Returns @@ -528,7 +528,7 @@ Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:32](ht > **hash**(): `Field` -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L28) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L28) #### Returns @@ -540,7 +540,7 @@ Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:28](ht > **validateSignature**(): `Bool` -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L41) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L41) #### Returns @@ -552,7 +552,7 @@ Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:41](ht > `static` **dummy**(): [`SignedTransaction`](SignedTransaction.md) -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L17) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L17) #### Returns @@ -564,7 +564,7 @@ Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:17](ht > `static` **getSignatureData**(`args`): `Field`[] -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/SignedTransaction.ts#L9) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L9) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/State.md b/src/pages/docs/reference/protocol/classes/State.md index e40f65e..19f0df2 100644 --- a/src/pages/docs/reference/protocol/classes/State.md +++ b/src/pages/docs/reference/protocol/classes/State.md @@ -10,7 +10,7 @@ title: State # Class: State\ -Defined in: [packages/protocol/src/state/State.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L42) +Defined in: [packages/protocol/src/state/State.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L42) Utilities for runtime module state, such as get/set @@ -28,7 +28,7 @@ Utilities for runtime module state, such as get/set > **new State**\<`Value`\>(`valueType`): [`State`](State.md)\<`Value`\> -Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L53) +Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L53) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-k > `optional` **path**: `Field` -Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L14) +Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L14) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-k > `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) -Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L26) +Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L26) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-k > **valueType**: `FlexibleProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L53) +Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L53) ## Methods @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-k > **get**(): `Promise`\<[`Option`](Option.md)\<`Value`\>\> -Defined in: [packages/protocol/src/state/State.ts:133](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L133) +Defined in: [packages/protocol/src/state/State.ts:133](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L133) Retrieves the current state and creates a state transition anchoring the use of the current state value in the circuit. @@ -99,7 +99,7 @@ Option representation of the current state. > **hasPathOrFail**(): `asserts this is { path: Path }` -Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L16) +Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L16) #### Returns @@ -115,7 +115,7 @@ Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-k > **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` -Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L28) +Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L28) #### Returns @@ -131,7 +131,7 @@ Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-k > **set**(`value`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/state/State.ts:158](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L158) +Defined in: [packages/protocol/src/state/State.ts:158](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L158) Sets a new state value by creating a state transition from the current value to the newly set value. @@ -159,7 +159,7 @@ Value to be set as the current state > `static` **from**\<`Value`\>(`valueType`): [`State`](State.md)\<`Value`\> -Defined in: [packages/protocol/src/state/State.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L49) +Defined in: [packages/protocol/src/state/State.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L49) Creates a new state wrapper for the provided value type. diff --git a/src/pages/docs/reference/protocol/classes/StateMap.md b/src/pages/docs/reference/protocol/classes/StateMap.md index bb91a26..08179c2 100644 --- a/src/pages/docs/reference/protocol/classes/StateMap.md +++ b/src/pages/docs/reference/protocol/classes/StateMap.md @@ -10,7 +10,7 @@ title: StateMap # Class: StateMap\ -Defined in: [packages/protocol/src/state/StateMap.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L12) +Defined in: [packages/protocol/src/state/StateMap.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L12) Map-like wrapper for state @@ -30,7 +30,7 @@ Map-like wrapper for state > **new StateMap**\<`KeyType`, `ValueType`\>(`keyType`, `valueType`): [`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> -Defined in: [packages/protocol/src/state/StateMap.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L30) +Defined in: [packages/protocol/src/state/StateMap.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L30) #### Parameters @@ -56,7 +56,7 @@ Defined in: [packages/protocol/src/state/StateMap.ts:30](https://github.com/prot > **keyType**: `FlexibleProvablePure`\<`KeyType`\> -Defined in: [packages/protocol/src/state/StateMap.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L31) +Defined in: [packages/protocol/src/state/StateMap.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L31) *** @@ -64,7 +64,7 @@ Defined in: [packages/protocol/src/state/StateMap.ts:31](https://github.com/prot > `optional` **path**: `Field` -Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L14) +Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L14) #### Inherited from @@ -76,7 +76,7 @@ Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-k > `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) -Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L26) +Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L26) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-k > **valueType**: `FlexibleProvablePure`\<`ValueType`\> -Defined in: [packages/protocol/src/state/StateMap.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L32) +Defined in: [packages/protocol/src/state/StateMap.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L32) ## Methods @@ -96,7 +96,7 @@ Defined in: [packages/protocol/src/state/StateMap.ts:32](https://github.com/prot > **get**(`key`): `Promise`\<[`Option`](Option.md)\<`ValueType`\>\> -Defined in: [packages/protocol/src/state/StateMap.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L48) +Defined in: [packages/protocol/src/state/StateMap.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L48) Obtains a value for the provided key in the current state map. @@ -120,7 +120,7 @@ Value for the provided key. > **getPath**(`key`): `Field` -Defined in: [packages/protocol/src/state/StateMap.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L37) +Defined in: [packages/protocol/src/state/StateMap.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L37) #### Parameters @@ -138,7 +138,7 @@ Defined in: [packages/protocol/src/state/StateMap.ts:37](https://github.com/prot > **hasPathOrFail**(): `asserts this is { path: Path }` -Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L16) +Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L16) #### Returns @@ -154,7 +154,7 @@ Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-k > **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` -Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L28) +Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L28) #### Returns @@ -170,7 +170,7 @@ Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-k > **set**(`key`, `value`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/state/StateMap.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L64) +Defined in: [packages/protocol/src/state/StateMap.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L64) Sets a value for the given key in the current state map. @@ -198,7 +198,7 @@ Value to be stored under the given key > `static` **from**\<`KeyType`, `ValueType`\>(`keyType`, `valueType`): [`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> -Defined in: [packages/protocol/src/state/StateMap.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateMap.ts#L23) +Defined in: [packages/protocol/src/state/StateMap.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L23) Create a new state map with the given key and value types diff --git a/src/pages/docs/reference/protocol/classes/StateServiceProvider.md b/src/pages/docs/reference/protocol/classes/StateServiceProvider.md index 4b80496..794a280 100644 --- a/src/pages/docs/reference/protocol/classes/StateServiceProvider.md +++ b/src/pages/docs/reference/protocol/classes/StateServiceProvider.md @@ -10,7 +10,7 @@ title: StateServiceProvider # Class: StateServiceProvider -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateServiceProvider.ts#L14) +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateServiceProvider.ts#L14) ## Constructors @@ -30,7 +30,7 @@ Defined in: [packages/protocol/src/state/StateServiceProvider.ts:14](https://git > **get** **stateService**(): [`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateServiceProvider.ts#L17) +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateServiceProvider.ts#L17) ##### Returns @@ -42,7 +42,7 @@ Defined in: [packages/protocol/src/state/StateServiceProvider.ts:17](https://git > **popCurrentStateService**(): `void` -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateServiceProvider.ts#L30) +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateServiceProvider.ts#L30) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/protocol/src/state/StateServiceProvider.ts:30](https://git > **setCurrentStateService**(`service`): `void` -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateServiceProvider.ts#L26) +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateServiceProvider.ts#L26) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/StateTransition.md b/src/pages/docs/reference/protocol/classes/StateTransition.md index 965f8e8..3aae030 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransition.md +++ b/src/pages/docs/reference/protocol/classes/StateTransition.md @@ -10,7 +10,7 @@ title: StateTransition # Class: StateTransition\ -Defined in: [packages/protocol/src/model/StateTransition.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L32) +Defined in: [packages/protocol/src/model/StateTransition.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L32) Generic state transition that constraints the current method circuit to external state, by providing a state anchor. @@ -25,7 +25,7 @@ to external state, by providing a state anchor. > **new StateTransition**\<`Value`\>(`path`, `fromValue`, `toValue`): [`StateTransition`](StateTransition.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L45) +Defined in: [packages/protocol/src/model/StateTransition.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L45) #### Parameters @@ -51,7 +51,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:45](https://github.c > **fromValue**: [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L47) +Defined in: [packages/protocol/src/model/StateTransition.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L47) *** @@ -59,7 +59,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:47](https://github.c > **path**: `Field` -Defined in: [packages/protocol/src/model/StateTransition.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L46) +Defined in: [packages/protocol/src/model/StateTransition.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L46) *** @@ -67,7 +67,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:46](https://github.c > **toValue**: [`Option`](Option.md)\<`Field`\> \| [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L48) +Defined in: [packages/protocol/src/model/StateTransition.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L48) ## Accessors @@ -77,7 +77,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:48](https://github.c > **get** **from**(): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L51) +Defined in: [packages/protocol/src/model/StateTransition.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L51) ##### Returns @@ -91,7 +91,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:51](https://github.c > **get** **to**(): [`Option`](Option.md)\<`Field`\> \| [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L57) +Defined in: [packages/protocol/src/model/StateTransition.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L57) ##### Returns @@ -103,7 +103,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:57](https://github.c > **toConstant**(): [`StateTransition`](StateTransition.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L81) +Defined in: [packages/protocol/src/model/StateTransition.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L81) #### Returns @@ -115,7 +115,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:81](https://github.c > **toJSON**(): `object` -Defined in: [packages/protocol/src/model/StateTransition.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L73) +Defined in: [packages/protocol/src/model/StateTransition.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L73) #### Returns @@ -163,7 +163,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:73](https://github.c > **toProvable**(): [`ProvableStateTransition`](ProvableStateTransition.md) -Defined in: [packages/protocol/src/model/StateTransition.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L65) +Defined in: [packages/protocol/src/model/StateTransition.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L65) Converts a StateTransition to a ProvableStateTransition, while enforcing the 'from' property to be 'Some' in all cases. @@ -178,7 +178,7 @@ while enforcing the 'from' property to be 'Some' in all cases. > `static` **from**\<`Value`\>(`path`, `fromValue`): [`StateTransition`](StateTransition.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L33) +Defined in: [packages/protocol/src/model/StateTransition.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L33) #### Type Parameters @@ -204,7 +204,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:33](https://github.c > `static` **fromTo**\<`Value`\>(`path`, `fromValue`, `toValue`): [`StateTransition`](StateTransition.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransition.ts#L37) +Defined in: [packages/protocol/src/model/StateTransition.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L37) #### Type Parameters diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md b/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md index 8b2a4fd..ff3f35d 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md @@ -10,7 +10,7 @@ title: StateTransitionProvableBatch # Class: StateTransitionProvableBatch -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L58) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L58) A Batch of StateTransitions to be consumed by the StateTransitionProver to prove multiple STs at once @@ -28,7 +28,7 @@ true == normal ST, false == protocol ST > **batch**: [`ProvableStateTransition`](ProvableStateTransition.md)[] -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L59) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L59) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:59](htt > **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L69) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L69) #### Inherited from @@ -52,7 +52,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:69](htt > **transitionTypes**: [`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L64) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L64) #### Inherited from @@ -444,7 +444,7 @@ Convert provable type to a normal JS type. > `static` **fromMappings**(`transitions`, `merkleWitnesses`): [`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L74) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L74) #### Parameters @@ -466,7 +466,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:74](htt > `static` **fromTransitions**(`transitions`, `protocolTransitions`, `merkleWitnesses`): [`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:111](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L111) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:111](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L111) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProver.md b/src/pages/docs/reference/protocol/classes/StateTransitionProver.md index 55f9cb0..02d0da9 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProver.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProver.md @@ -10,7 +10,7 @@ title: StateTransitionProver # Class: StateTransitionProver -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:343](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L343) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:343](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L343) Used by various module sub-types that may need to be configured @@ -30,7 +30,7 @@ Used by various module sub-types that may need to be configured > **new StateTransitionProver**(): [`StateTransitionProver`](StateTransitionProver.md) -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:352](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L352) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:352](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L352) #### Returns @@ -65,7 +65,7 @@ checks when retrieving it via the getter > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Implementation of @@ -81,7 +81,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **zkProgrammable**: [`StateTransitionProverProgrammable`](StateTransitionProverProgrammable.md) -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:350](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L350) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:350](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L350) #### Implementation of @@ -95,7 +95,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -153,7 +153,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:357](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L357) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:357](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L357) #### Parameters @@ -175,7 +175,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -201,7 +201,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:370](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L370) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:370](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L370) #### Parameters @@ -231,7 +231,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **runBatch**(`publicInput`, `batch`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:363](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L363) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:363](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L363) #### Parameters @@ -257,7 +257,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md index a0bb2b2..774d879 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md @@ -10,7 +10,7 @@ title: StateTransitionProverProgrammable # Class: StateTransitionProverProgrammable -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L74) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L74) StateTransitionProver is the prover that proves the application of some state transitions and checks and updates their merkle-tree entries @@ -25,7 +25,7 @@ transitions and checks and updates their merkle-tree entries > **new StateTransitionProverProgrammable**(`stateTransitionProver`): [`StateTransitionProverProgrammable`](StateTransitionProverProgrammable.md) -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L78) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L78) #### Parameters @@ -49,7 +49,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L84) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L84) ##### Returns @@ -83,7 +83,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:34 > **applyTransition**(`state`, `transition`, `type`, `merkleWitness`, `index`): `void` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:197](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L197) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:197](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L197) Applies a single state transition to the given state and mutates it in place @@ -120,7 +120,7 @@ and mutates it in place > **applyTransitions**(`stateRoot`, `protocolStateRoot`, `stateTransitionCommitmentFrom`, `protocolTransitionCommitmentFrom`, `transitionBatch`): `StateTransitionProverExecutionState` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:151](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L151) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:151](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L151) Applies the state transitions to the current stateRoot and returns the new prover state @@ -179,7 +179,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:35 > **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:267](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L267) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:267](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L267) #### Parameters @@ -205,7 +205,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **runBatch**(`publicInput`, `batch`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:246](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L246) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:246](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L246) Applies a whole batch of StateTransitions at once @@ -229,7 +229,7 @@ Applies a whole batch of StateTransitions at once > **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\>[] -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L88) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L88) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md index 46fcae9..9235731 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md @@ -10,7 +10,7 @@ title: StateTransitionProverPublicInput # Class: StateTransitionProverPublicInput -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L6) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L6) ## Extends @@ -58,7 +58,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **protocolStateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L10) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L10) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **protocolTransitionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L8) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L8) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **stateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L9) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L9) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **stateTransitionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L7) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L7) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md index 3e361bc..7a677ff 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md @@ -10,7 +10,7 @@ title: StateTransitionProverPublicOutput # Class: StateTransitionProverPublicOutput -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L13) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L13) ## Extends @@ -58,7 +58,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **protocolStateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L17) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L17) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **protocolTransitionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L15) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L15) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **stateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L16) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L16) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **stateTransitionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L14) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L14) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md b/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md index 570a1f6..cf0d88c 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md @@ -10,7 +10,7 @@ title: StateTransitionReductionList # Class: StateTransitionReductionList -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/StateTransitionReductionList.ts#L11) +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/StateTransitionReductionList.ts#L11) Utilities for creating a hash list from a given value type. @@ -24,7 +24,7 @@ Utilities for creating a hash list from a given value type. > **new StateTransitionReductionList**(`valueType`, `commitment`): [`StateTransitionReductionList`](StateTransitionReductionList.md) -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L7) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L7) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.c > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > **unconstrainedList**: [`ProvableStateTransition`](ProvableStateTransition.md)[] = `[]` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https:/ > `protected` `readonly` **valueType**: `ProvablePure`\<[`ProvableStateTransition`](ProvableStateTransition.md)\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) #### Parameters @@ -108,7 +108,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https: > **push**(`value`): [`StateTransitionReductionList`](StateTransitionReductionList.md) -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/StateTransitionReductionList.ts#L12) +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/StateTransitionReductionList.ts#L12) Converts the provided value to Field[] and appends it to the current hashlist. @@ -137,7 +137,7 @@ Current hash list. > **pushAndReduce**(`value`, `reduce`): `object` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) #### Parameters @@ -171,7 +171,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https: > **pushIf**(`value`, `condition`): [`StateTransitionReductionList`](StateTransitionReductionList.md) -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) #### Parameters @@ -197,7 +197,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https: > **pushWithMetadata**(`value`): `object` -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/StateTransitionReductionList.ts#L18) +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/StateTransitionReductionList.ts#L18) #### Parameters @@ -223,7 +223,7 @@ Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:18](htt > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionType.md b/src/pages/docs/reference/protocol/classes/StateTransitionType.md index 5f2cfe5..cf40f13 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionType.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionType.md @@ -10,7 +10,7 @@ title: StateTransitionType # Class: StateTransitionType -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L13) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L13) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:13](htt > `readonly` `static` **normal**: `true` = `true` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L14) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L14) *** @@ -36,7 +36,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:14](htt > `readonly` `static` **protocol**: `false` = `false` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L16) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L16) ## Methods @@ -44,7 +44,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:16](htt > `static` **isNormal**(`type`): `boolean` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L18) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L18) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:18](htt > `static` **isProtocol**(`type`): `boolean` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/StateTransitionProvableBatch.ts#L22) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L22) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md b/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md index 5c9120a..36fa50c 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md @@ -10,7 +10,7 @@ title: TokenBridgeAttestation # Class: TokenBridgeAttestation -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L65) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L65) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **index**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:67](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L67) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L67) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:67](h > **witness**: [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L66) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L66) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md b/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md index 3d9e373..c1e188e 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md @@ -10,7 +10,7 @@ title: TokenBridgeDeploymentAuth # Class: TokenBridgeDeploymentAuth -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L5) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L5) Interface for cross-contract call authorization See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 @@ -61,7 +61,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **address**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L9) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L9) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBrid > **target**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L7) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L7) #### Implementation of @@ -89,7 +89,7 @@ Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBrid > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L8) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L8) #### Inherited from @@ -497,7 +497,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L13) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L13) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md b/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md index 58fb2a6..848df15 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md @@ -10,7 +10,7 @@ title: TokenBridgeEntry # Class: TokenBridgeEntry -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L56) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L56) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **address**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L57) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L57) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:57](h > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L58) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L58) #### Inherited from @@ -414,7 +414,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L60) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L60) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md index b5c97b5..9c127fa 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md @@ -10,7 +10,7 @@ title: TokenBridgeTree # Class: TokenBridgeTree -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L15) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L15) Merkle tree that contains all the deployed token bridges as a mapping of tokenId => PublicKey @@ -50,7 +50,7 @@ Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:113 > **indizes**: `Record`\<`string`, `bigint`\> = `{}` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L16) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L16) *** @@ -194,7 +194,7 @@ Values to fill the leaves with. > **getIndex**(`tokenId`): `bigint` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L49) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L49) #### Parameters @@ -328,7 +328,7 @@ New value. > `static` **buildTreeFromEvents**(`contract`): `Promise`\<[`TokenBridgeTree`](TokenBridgeTree.md)\> -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L22) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L22) Initializes and fills the tree based on all on-chain events that have been emitted by every emit diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md index ce76135..e4af8b4 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md @@ -10,7 +10,7 @@ title: TokenBridgeTreeAddition # Class: TokenBridgeTreeAddition -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L70) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L70) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **index**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L71) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L71) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:71](h > **value**: [`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L72) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L72) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md index f5a67dc..13f34c2 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md @@ -10,7 +10,7 @@ title: TokenBridgeTreeWitness # Class: TokenBridgeTreeWitness -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L54) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L54) ## Extends diff --git a/src/pages/docs/reference/protocol/classes/TokenMapping.md b/src/pages/docs/reference/protocol/classes/TokenMapping.md index 4e5f6a2..d09c6b4 100644 --- a/src/pages/docs/reference/protocol/classes/TokenMapping.md +++ b/src/pages/docs/reference/protocol/classes/TokenMapping.md @@ -10,7 +10,7 @@ title: TokenMapping # Class: TokenMapping -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L60) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L60) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **publicKey**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L62) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L62) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L61) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L61) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md b/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md index 1a56235..f1d5d2d 100644 --- a/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md +++ b/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md @@ -10,7 +10,7 @@ title: TransitionMethodExecutionResult # Class: TransitionMethodExecutionResult -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L3) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L3) ## Constructors @@ -28,4 +28,4 @@ Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContex > **stateTransitions**: [`StateTransition`](StateTransition.md)\<`any`\>[] = `[]` -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L4) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L4) diff --git a/src/pages/docs/reference/protocol/classes/UInt64Option.md b/src/pages/docs/reference/protocol/classes/UInt64Option.md index 24b68d6..50c1cdc 100644 --- a/src/pages/docs/reference/protocol/classes/UInt64Option.md +++ b/src/pages/docs/reference/protocol/classes/UInt64Option.md @@ -10,7 +10,7 @@ title: UInt64Option # Class: UInt64Option -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L24) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L24) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **isSome**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L5) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L5) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://g > **value**: `UInt64` = `valueType` -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L6) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L6) #### Inherited from @@ -420,7 +420,7 @@ Convert provable type to a normal JS type. > `static` **fromSome**(`value`): `Generic`\<`UInt64`\> -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L8) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L8) #### Parameters @@ -442,7 +442,7 @@ Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://g > `static` **none**(`value`): `Generic`\<`UInt64`\> -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/transaction/ValueOption.ts#L15) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L15) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md b/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md index 894c859..531f5f6 100644 --- a/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md +++ b/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md @@ -10,7 +10,7 @@ title: UpdateMessagesHashAuth # Class: UpdateMessagesHashAuth -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L5) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L5) Interface for cross-contract call authorization See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 @@ -61,7 +61,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **executedMessagesHash**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L8) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L8) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMes > **newPromisedMessagesHash**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L9) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L9) #### Inherited from @@ -85,7 +85,7 @@ Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMes > **target**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L7) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L7) #### Implementation of @@ -489,7 +489,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L13) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L13) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/VKTree.md b/src/pages/docs/reference/protocol/classes/VKTree.md index 9a45c0a..c7f14ce 100644 --- a/src/pages/docs/reference/protocol/classes/VKTree.md +++ b/src/pages/docs/reference/protocol/classes/VKTree.md @@ -10,7 +10,7 @@ title: VKTree # Class: VKTree -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L5) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L5) ## Extends diff --git a/src/pages/docs/reference/protocol/classes/VKTreeWitness.md b/src/pages/docs/reference/protocol/classes/VKTreeWitness.md index 2196cc9..f5577dd 100644 --- a/src/pages/docs/reference/protocol/classes/VKTreeWitness.md +++ b/src/pages/docs/reference/protocol/classes/VKTreeWitness.md @@ -10,7 +10,7 @@ title: VKTreeWitness # Class: VKTreeWitness -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L6) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L6) ## Extends diff --git a/src/pages/docs/reference/protocol/classes/WithPath.md b/src/pages/docs/reference/protocol/classes/WithPath.md index fb34930..fb102df 100644 --- a/src/pages/docs/reference/protocol/classes/WithPath.md +++ b/src/pages/docs/reference/protocol/classes/WithPath.md @@ -10,7 +10,7 @@ title: WithPath # Class: WithPath -Defined in: [packages/protocol/src/state/State.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L13) +Defined in: [packages/protocol/src/state/State.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L13) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/protocol/src/state/State.ts:13](https://github.com/proto-k > `optional` **path**: `Field` -Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L14) +Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L14) ## Methods @@ -36,7 +36,7 @@ Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-k > **hasPathOrFail**(): `asserts this is { path: Path }` -Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L16) +Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L16) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md b/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md index cf8fa29..248c142 100644 --- a/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md +++ b/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md @@ -10,7 +10,7 @@ title: WithStateServiceProvider # Class: WithStateServiceProvider -Defined in: [packages/protocol/src/state/State.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L25) +Defined in: [packages/protocol/src/state/State.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L25) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/protocol/src/state/State.ts:25](https://github.com/proto-k > `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) -Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L26) +Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L26) ## Methods @@ -36,7 +36,7 @@ Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-k > **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` -Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/State.ts#L28) +Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L28) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/Withdrawal.md b/src/pages/docs/reference/protocol/classes/Withdrawal.md index 6876043..5715695 100644 --- a/src/pages/docs/reference/protocol/classes/Withdrawal.md +++ b/src/pages/docs/reference/protocol/classes/Withdrawal.md @@ -10,7 +10,7 @@ title: Withdrawal # Class: Withdrawal -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Withdrawal.ts#L4) +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Withdrawal.ts#L4) ## Extends @@ -54,7 +54,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **address**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Withdrawal.ts#L6) +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Withdrawal.ts#L6) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:6](https:// > **amount**: `UInt64` = `UInt64` -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Withdrawal.ts#L7) +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Withdrawal.ts#L7) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:7](https:// > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Withdrawal.ts#L5) +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Withdrawal.ts#L5) #### Inherited from @@ -478,7 +478,7 @@ Convert provable type to a normal JS type. > `static` **dummy**(): [`Withdrawal`](Withdrawal.md) -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/Withdrawal.ts#L9) +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Withdrawal.ts#L9) #### Returns diff --git a/src/pages/docs/reference/protocol/functions/assert.md b/src/pages/docs/reference/protocol/functions/assert.md index ae4362d..ad83ea0 100644 --- a/src/pages/docs/reference/protocol/functions/assert.md +++ b/src/pages/docs/reference/protocol/functions/assert.md @@ -12,7 +12,7 @@ title: assert > **assert**(`condition`, `message`?): `void` -Defined in: [packages/protocol/src/state/assert/assert.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/assert/assert.ts#L16) +Defined in: [packages/protocol/src/state/assert/assert.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/assert/assert.ts#L16) Maintains an execution status of the current runtime module method, while prioritizing one-time failures. The assertion won't change the diff --git a/src/pages/docs/reference/protocol/functions/emptyActions.md b/src/pages/docs/reference/protocol/functions/emptyActions.md index fe817d7..fac75bf 100644 --- a/src/pages/docs/reference/protocol/functions/emptyActions.md +++ b/src/pages/docs/reference/protocol/functions/emptyActions.md @@ -12,7 +12,7 @@ title: emptyActions > **emptyActions**(): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L20) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L20) ## Returns diff --git a/src/pages/docs/reference/protocol/functions/emptyEvents.md b/src/pages/docs/reference/protocol/functions/emptyEvents.md index 3ca9cd7..3ce3340 100644 --- a/src/pages/docs/reference/protocol/functions/emptyEvents.md +++ b/src/pages/docs/reference/protocol/functions/emptyEvents.md @@ -12,7 +12,7 @@ title: emptyEvents > **emptyEvents**(): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L24) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L24) ## Returns diff --git a/src/pages/docs/reference/protocol/functions/notInCircuit.md b/src/pages/docs/reference/protocol/functions/notInCircuit.md index 2caf9fd..2b494f3 100644 --- a/src/pages/docs/reference/protocol/functions/notInCircuit.md +++ b/src/pages/docs/reference/protocol/functions/notInCircuit.md @@ -12,7 +12,7 @@ title: notInCircuit > **notInCircuit**(): `MethodDecorator` -Defined in: [packages/protocol/src/utils/utils.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/utils.ts#L16) +Defined in: [packages/protocol/src/utils/utils.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/utils.ts#L16) ## Returns diff --git a/src/pages/docs/reference/protocol/functions/protocolState.md b/src/pages/docs/reference/protocol/functions/protocolState.md index 3a30d96..f95aaaf 100644 --- a/src/pages/docs/reference/protocol/functions/protocolState.md +++ b/src/pages/docs/reference/protocol/functions/protocolState.md @@ -12,7 +12,7 @@ title: protocolState > **protocolState**(): \<`TargetTransitioningModule`\>(`target`, `propertyKey`) => `void` -Defined in: [packages/protocol/src/state/protocol/ProtocolState.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/protocol/ProtocolState.ts#L23) +Defined in: [packages/protocol/src/state/protocol/ProtocolState.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/protocol/ProtocolState.ts#L23) Decorates a runtime module property as state, passing down some underlying values to improve developer experience. diff --git a/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md b/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md index 77125de..aed8377 100644 --- a/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md +++ b/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md @@ -12,7 +12,7 @@ title: reduceStateTransitions > **reduceStateTransitions**(`transitions`): [`StateTransition`](../classes/StateTransition.md)\<`unknown`\>[] -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/StateTransitionReductionList.ts#L61) +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/StateTransitionReductionList.ts#L61) ## Parameters diff --git a/src/pages/docs/reference/protocol/functions/singleFieldToString.md b/src/pages/docs/reference/protocol/functions/singleFieldToString.md index ad0cd75..2894de3 100644 --- a/src/pages/docs/reference/protocol/functions/singleFieldToString.md +++ b/src/pages/docs/reference/protocol/functions/singleFieldToString.md @@ -12,7 +12,7 @@ title: singleFieldToString > **singleFieldToString**(`value`): `string` -Defined in: [packages/protocol/src/utils/utils.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/utils.ts#L69) +Defined in: [packages/protocol/src/utils/utils.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/utils.ts#L69) ## Parameters diff --git a/src/pages/docs/reference/protocol/functions/stringToField.md b/src/pages/docs/reference/protocol/functions/stringToField.md index 4842a9e..8e9950a 100644 --- a/src/pages/docs/reference/protocol/functions/stringToField.md +++ b/src/pages/docs/reference/protocol/functions/stringToField.md @@ -12,7 +12,7 @@ title: stringToField > **stringToField**(`value`): `Field` -Defined in: [packages/protocol/src/utils/utils.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/utils.ts#L36) +Defined in: [packages/protocol/src/utils/utils.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/utils.ts#L36) ## Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProvable.md b/src/pages/docs/reference/protocol/interfaces/BlockProvable.md index f8f9447..4adad24 100644 --- a/src/pages/docs/reference/protocol/interfaces/BlockProvable.md +++ b/src/pages/docs/reference/protocol/interfaces/BlockProvable.md @@ -10,7 +10,7 @@ title: BlockProvable # Interface: BlockProvable -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L75) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L75) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:75](https://git > **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L94) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L94) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://git > **proveBlock**: (`publicInput`, `networkState`, `blockWitness`, `transactionProof`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L86) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L86) #### Parameters @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://git > **proveTransaction**: (`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L78) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L78) #### Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProverState.md b/src/pages/docs/reference/protocol/interfaces/BlockProverState.md index 70b5faf..eddc1fe 100644 --- a/src/pages/docs/reference/protocol/interfaces/BlockProverState.md +++ b/src/pages/docs/reference/protocol/interfaces/BlockProverState.md @@ -10,7 +10,7 @@ title: BlockProverState # Interface: BlockProverState -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L98) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L98) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:98](https://githu > **blockHashRoot**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:120](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L120) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:120](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L120) The root of the merkle tree encoding all block hashes, see `BlockHashMerkleTree` @@ -29,7 +29,7 @@ see `BlockHashMerkleTree` > **eternalTransactionsHash**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:127](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L127) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:127](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L127) A variant of the transactionsHash that is never reset. Thought for usage in the sequence state mempool. @@ -41,7 +41,7 @@ In comparison, transactionsHash restarts at 0 for every new block > **incomingMessagesHash**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L129) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L129) *** @@ -49,7 +49,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:129](https://gith > **networkStateHash**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L114) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L114) The network state which gives access to values such as blockHeight This value is the same for the whole batch (L2 block) @@ -60,7 +60,7 @@ This value is the same for the whole batch (L2 block) > **stateRoot**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:102](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L102) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:102](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L102) The current state root of the block prover @@ -70,7 +70,7 @@ The current state root of the block prover > **transactionsHash**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L108) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L108) The current commitment of the transaction-list which will at the end equal the bundle hash diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProverType.md b/src/pages/docs/reference/protocol/interfaces/BlockProverType.md index 98aa2d1..a6af316 100644 --- a/src/pages/docs/reference/protocol/interfaces/BlockProverType.md +++ b/src/pages/docs/reference/protocol/interfaces/BlockProverType.md @@ -10,7 +10,7 @@ title: BlockProverType # Interface: BlockProverType -Defined in: [packages/protocol/src/protocol/Protocol.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L41) +Defined in: [packages/protocol/src/protocol/Protocol.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L41) Used by various module sub-types that may need to be configured @@ -39,7 +39,7 @@ checks when retrieving it via the getter > **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L94) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L94) #### Parameters @@ -69,7 +69,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://git > `optional` **protocol**: [`ProtocolEnvironment`](ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **proveBlock**: (`publicInput`, `networkState`, `blockWitness`, `transactionProof`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L86) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L86) #### Parameters @@ -115,7 +115,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://git > **proveTransaction**: (`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L78) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L78) #### Parameters @@ -167,7 +167,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -239,7 +239,7 @@ Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -261,7 +261,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md b/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md index 046f13c..f67feb9 100644 --- a/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md +++ b/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md @@ -10,7 +10,7 @@ title: ContractAuthorization # Interface: ContractAuthorization -Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L7) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L7) Interface for cross-contract call authorization See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 @@ -21,7 +21,7 @@ See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 > **hash**: () => `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L10) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L10) #### Returns @@ -33,4 +33,4 @@ Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractA > **target**: `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L8) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L8) diff --git a/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md b/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md index 4804417..6ae0ee0 100644 --- a/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md +++ b/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md @@ -10,7 +10,7 @@ title: DispatchContractType # Interface: DispatchContractType -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L40) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L40) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **enableTokenDeposits**: (`tokenId`, `bridgeContractAddress`, `settlementContractAddress`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L46) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L46) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **initialize**: (`settlementContract`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L45) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L45) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **promisedMessagesHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L52) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L52) *** @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **updateMessagesHash**: (`executedMessagesHash`, `newPromisedMessagesHash`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L41) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L41) #### Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md b/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md index e63f21f..0082c7e 100644 --- a/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md +++ b/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md @@ -10,7 +10,7 @@ title: MinimalVKTreeService # Interface: MinimalVKTreeService -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L22) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L22) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificatio > **getRoot**: () => `bigint` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L23) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L23) #### Returns diff --git a/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md b/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md index 3fa689e..cabbd0f 100644 --- a/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md +++ b/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md @@ -10,7 +10,7 @@ title: ProtocolDefinition # Interface: ProtocolDefinition\ -Defined in: [packages/protocol/src/protocol/Protocol.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L55) +Defined in: [packages/protocol/src/protocol/Protocol.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L55) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [packages/protocol/src/protocol/Protocol.ts:55](https://github.com/p > `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L57) +Defined in: [packages/protocol/src/protocol/Protocol.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L57) *** @@ -30,4 +30,4 @@ Defined in: [packages/protocol/src/protocol/Protocol.ts:57](https://github.com/p > **modules**: `Modules` -Defined in: [packages/protocol/src/protocol/Protocol.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L56) +Defined in: [packages/protocol/src/protocol/Protocol.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L56) diff --git a/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md b/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md index 8a651fe..938a576 100644 --- a/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md +++ b/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md @@ -10,7 +10,7 @@ title: ProtocolEnvironment # Interface: ProtocolEnvironment -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolEnvironment.ts#L6) +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolEnvironment.ts#L6) ## Accessors @@ -20,7 +20,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:6](https://gi > **get** **stateService**(): [`SimpleAsyncStateService`](SimpleAsyncStateService.md) -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolEnvironment.ts#L7) +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolEnvironment.ts#L7) ##### Returns @@ -34,7 +34,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:7](https://gi > **get** **stateServiceProvider**(): [`StateServiceProvider`](../classes/StateServiceProvider.md) -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolEnvironment.ts#L8) +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolEnvironment.ts#L8) ##### Returns @@ -46,7 +46,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:8](https://gi > **getAreProofsEnabled**(): [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolEnvironment.ts#L9) +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolEnvironment.ts#L9) #### Returns diff --git a/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md b/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md index efa3750..1610467 100644 --- a/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md +++ b/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md @@ -10,7 +10,7 @@ title: RuntimeLike # Interface: RuntimeLike -Defined in: [packages/protocol/src/model/RuntimeLike.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/RuntimeLike.ts#L8) +Defined in: [packages/protocol/src/model/RuntimeLike.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/RuntimeLike.ts#L8) ## Accessors @@ -20,7 +20,7 @@ Defined in: [packages/protocol/src/model/RuntimeLike.ts:8](https://github.com/pr > **get** **methodIdResolver**(): `object` -Defined in: [packages/protocol/src/model/RuntimeLike.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/RuntimeLike.ts#L9) +Defined in: [packages/protocol/src/model/RuntimeLike.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/RuntimeLike.ts#L9) ##### Returns diff --git a/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md b/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md index 5147aec..70d048b 100644 --- a/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md +++ b/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md @@ -10,7 +10,7 @@ title: RuntimeMethodExecutionData # Interface: RuntimeMethodExecutionData -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L36) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L36) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **networkState**: [`NetworkState`](../classes/NetworkState.md) -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L38) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L38) *** @@ -26,4 +26,4 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **transaction**: [`RuntimeTransaction`](../classes/RuntimeTransaction.md) -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L37) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L37) diff --git a/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md b/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md index 33391cf..ef01657 100644 --- a/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md +++ b/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md @@ -10,7 +10,7 @@ title: SettlementContractType # Interface: SettlementContractType -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L65) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L65) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **addTokenBridge**: (`tokenId`, `address`, `dispatchContract`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L84) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L84) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **assertStateRoot**: (`root`) => `AccountUpdate` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L74) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L74) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **authorizationField**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L66) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L66) *** @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **initialize**: (`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L68) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L68) #### Parameters @@ -100,7 +100,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **settle**: (`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L75) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L75) #### Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md b/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md index 01f60c0..0dd1337 100644 --- a/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md +++ b/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md @@ -10,7 +10,7 @@ title: SimpleAsyncStateService # Interface: SimpleAsyncStateService -Defined in: [packages/protocol/src/state/StateService.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateService.ts#L3) +Defined in: [packages/protocol/src/state/StateService.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateService.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/state/StateService.ts:3](https://github.com/p > **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/protocol/src/state/StateService.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateService.ts#L4) +Defined in: [packages/protocol/src/state/StateService.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateService.ts#L4) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/protocol/src/state/StateService.ts:4](https://github.com/p > **set**: (`key`, `value`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/state/StateService.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/StateService.ts#L5) +Defined in: [packages/protocol/src/state/StateService.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateService.ts#L5) #### Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md b/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md index bdac9be..894b5bf 100644 --- a/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md +++ b/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md @@ -10,7 +10,7 @@ title: StateTransitionProvable # Interface: StateTransitionProvable -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L25) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L25) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **runBatch**: (`publicInput`, `batch`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) #### Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md b/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md index f43464a..6cf7060 100644 --- a/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md +++ b/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md @@ -10,7 +10,7 @@ title: StateTransitionProverType # Interface: StateTransitionProverType -Defined in: [packages/protocol/src/protocol/Protocol.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L43) +Defined in: [packages/protocol/src/protocol/Protocol.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L43) Used by various module sub-types that may need to be configured @@ -39,7 +39,7 @@ checks when retrieving it via the getter > **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) #### Parameters @@ -69,7 +69,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > `optional` **protocol**: [`ProtocolEnvironment`](ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **runBatch**: (`publicInput`, `batch`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) #### Parameters @@ -121,7 +121,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -193,7 +193,7 @@ Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -215,7 +215,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md b/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md index 19783dc..0e73c5c 100644 --- a/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md +++ b/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md @@ -10,7 +10,7 @@ title: TransitionMethodExecutionContext # Interface: TransitionMethodExecutionContext -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L7) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L7) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContex > **addStateTransition**: \<`Value`\>(`stateTransition`) => `void` -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L12) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L12) Adds an in-method generated state transition to the current context @@ -44,7 +44,7 @@ State transition to add to the context > **clear**: () => `void` -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L17) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L17) Manually clears/resets the execution context @@ -58,7 +58,7 @@ Manually clears/resets the execution context > **current**: () => `object` -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L23) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L23) Had to override current() otherwise it would not infer the type of result correctly (parent type would be reused) diff --git a/src/pages/docs/reference/protocol/type-aliases/BlockProof.md b/src/pages/docs/reference/protocol/type-aliases/BlockProof.md index f5f8b3f..f346786 100644 --- a/src/pages/docs/reference/protocol/type-aliases/BlockProof.md +++ b/src/pages/docs/reference/protocol/type-aliases/BlockProof.md @@ -12,4 +12,4 @@ title: BlockProof > **BlockProof**: `Proof`\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L132) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L132) diff --git a/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md b/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md index 282cc65..4f1287b 100644 --- a/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md +++ b/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md @@ -12,4 +12,4 @@ title: BlockProverProof > **BlockProverProof**: `Proof`\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProvable.ts#L52) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L52) diff --git a/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md index cbd075a..85be19d 100644 --- a/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md +++ b/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md @@ -12,7 +12,7 @@ title: BridgeContractConfig > **BridgeContractConfig**: `object` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L12) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L12) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md b/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md index 561325f..4bde5c8 100644 --- a/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md +++ b/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md @@ -12,7 +12,7 @@ title: BridgeContractType > **BridgeContractType**: `object` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/BridgeContract.ts#L29) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L29) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md index 12550f7..a2a3121 100644 --- a/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md +++ b/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md @@ -12,7 +12,7 @@ title: DispatchContractConfig > **DispatchContractConfig**: `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L17) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L17) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md b/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md index 78a062b..5afad99 100644 --- a/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md +++ b/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md @@ -12,4 +12,4 @@ title: InputBlockProof > **InputBlockProof**: [`InferProofBase`](../../common/type-aliases/InferProofBase.md)\<[`BlockProof`](BlockProof.md)\> -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L9) +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L9) diff --git a/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md index 543613c..82db990 100644 --- a/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md +++ b/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md @@ -12,7 +12,7 @@ title: MandatoryProtocolModulesRecord > **MandatoryProtocolModulesRecord**: `object` -Defined in: [packages/protocol/src/protocol/Protocol.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L47) +Defined in: [packages/protocol/src/protocol/Protocol.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L47) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md index 4983c47..6e5a4da 100644 --- a/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md +++ b/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md @@ -12,7 +12,7 @@ title: MandatorySettlementModulesRecord > **MandatorySettlementModulesRecord**: `object` -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L35) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L35) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md index d68c342..bb8debd 100644 --- a/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md +++ b/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md @@ -12,4 +12,4 @@ title: ProtocolModulesRecord > **ProtocolModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ProtocolModule`](../classes/ProtocolModule.md)\<`unknown`\>\>\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/protocol/Protocol.ts#L37) +Defined in: [packages/protocol/src/protocol/Protocol.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L37) diff --git a/src/pages/docs/reference/protocol/type-aliases/ReturnType.md b/src/pages/docs/reference/protocol/type-aliases/ReturnType.md index 005e937..279e1e5 100644 --- a/src/pages/docs/reference/protocol/type-aliases/ReturnType.md +++ b/src/pages/docs/reference/protocol/type-aliases/ReturnType.md @@ -12,7 +12,7 @@ title: ReturnType > **ReturnType**\<`FunctionType`\>: `FunctionType` *extends* (...`args`) => infer Return ? `Return` : `any` -Defined in: [packages/protocol/src/utils/utils.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/utils.ts#L4) +Defined in: [packages/protocol/src/utils/utils.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/utils.ts#L4) ## Type Parameters diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md index e9597fb..b0ba400 100644 --- a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md +++ b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md @@ -12,4 +12,4 @@ title: RuntimeMethodIdMapping > **RuntimeMethodIdMapping**: `Record`\<`` `${string}.${string}` ``, \{ `methodId`: `bigint`; `type`: [`RuntimeMethodInvocationType`](RuntimeMethodInvocationType.md); \}\> -Defined in: [packages/protocol/src/model/RuntimeLike.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/RuntimeLike.ts#L3) +Defined in: [packages/protocol/src/model/RuntimeLike.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/RuntimeLike.ts#L3) diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md index 8f2c0e2..9c0207d 100644 --- a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md +++ b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md @@ -12,4 +12,4 @@ title: RuntimeMethodInvocationType > **RuntimeMethodInvocationType**: `"INCOMING_MESSAGE"` \| `"SIGNATURE"` -Defined in: [packages/protocol/src/model/RuntimeLike.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/model/RuntimeLike.ts#L1) +Defined in: [packages/protocol/src/model/RuntimeLike.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/RuntimeLike.ts#L1) diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md index 1fe6484..002ac5e 100644 --- a/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md +++ b/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md @@ -12,4 +12,4 @@ title: RuntimeProof > **RuntimeProof**: `Proof`\<`void`, [`MethodPublicOutput`](../classes/MethodPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:133](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/BlockProver.ts#L133) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:133](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L133) diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md index dd14728..e9cfd2e 100644 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md @@ -12,7 +12,7 @@ title: SettlementContractConfig > **SettlementContractConfig**: `object` -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L26) +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L26) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md b/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md index 65630b3..d7d7591 100644 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md @@ -12,7 +12,7 @@ title: SettlementHookInputs > **SettlementHookInputs**: `object` -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L20) +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L20) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md index 40bcfc0..baaf4b8 100644 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md @@ -12,4 +12,4 @@ title: SettlementModulesRecord > **SettlementModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ContractModule`](../classes/ContractModule.md)\<`unknown`, `unknown`\>\>\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/SettlementContractModule.ts#L31) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L31) diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md b/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md index 29762c9..62f5326 100644 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md @@ -12,7 +12,7 @@ title: SettlementStateRecord > **SettlementStateRecord**: `object` -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L11) +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L11) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md b/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md index fbe546d..5ff9cb8 100644 --- a/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md +++ b/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md @@ -12,7 +12,7 @@ title: SmartContractClassFromInterface > **SmartContractClassFromInterface**\<`Type`\>: *typeof* `SmartContract` & [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`Type`\> -Defined in: [packages/protocol/src/settlement/ContractModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/ContractModule.ts#L11) +Defined in: [packages/protocol/src/settlement/ContractModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/ContractModule.ts#L11) ## Type Parameters diff --git a/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md b/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md index f0b675f..4cd719c 100644 --- a/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md +++ b/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md @@ -12,4 +12,4 @@ title: StateTransitionProof > **StateTransitionProof**: `Proof`\<[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L20) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L20) diff --git a/src/pages/docs/reference/protocol/type-aliases/Subclass.md b/src/pages/docs/reference/protocol/type-aliases/Subclass.md index bc2ef70..260cf14 100644 --- a/src/pages/docs/reference/protocol/type-aliases/Subclass.md +++ b/src/pages/docs/reference/protocol/type-aliases/Subclass.md @@ -12,7 +12,7 @@ title: Subclass > **Subclass**\<`Class`\>: (...`args`) => `InstanceType`\<`Class`\> & `{ [Key in keyof Class]: Class[Key] }` & `object` -Defined in: [packages/protocol/src/utils/utils.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/utils.ts#L10) +Defined in: [packages/protocol/src/utils/utils.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/utils.ts#L10) ## Type declaration diff --git a/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md b/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md index 0b98716..29d4f10 100644 --- a/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md +++ b/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md @@ -12,4 +12,4 @@ title: ACTIONS_EMPTY_HASH > `const` **ACTIONS\_EMPTY\_HASH**: `Field` = `Reducer.initialActionState` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L38) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L38) diff --git a/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md b/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md index b9e82d8..6b04566 100644 --- a/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md +++ b/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md @@ -12,4 +12,4 @@ title: BATCH_SIGNATURE_PREFIX > `const` **BATCH\_SIGNATURE\_PREFIX**: `Field` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L92) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L92) diff --git a/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md b/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md index c480708..eabe3ca 100644 --- a/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md +++ b/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md @@ -12,7 +12,7 @@ title: MINA_EVENT_PREFIXES > `const` **MINA\_EVENT\_PREFIXES**: `object` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L14) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L14) ## Type declaration diff --git a/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md b/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md index bd54ab8..0fc522e 100644 --- a/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md +++ b/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md @@ -12,4 +12,4 @@ title: OUTGOING_MESSAGE_BATCH_SIZE > `const` **OUTGOING\_MESSAGE\_BATCH\_SIZE**: `1` = `1` -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L6) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L6) diff --git a/src/pages/docs/reference/protocol/variables/ProtocolConstants.md b/src/pages/docs/reference/protocol/variables/ProtocolConstants.md index 1b5f459..e1e8ea0 100644 --- a/src/pages/docs/reference/protocol/variables/ProtocolConstants.md +++ b/src/pages/docs/reference/protocol/variables/ProtocolConstants.md @@ -12,7 +12,7 @@ title: ProtocolConstants > `const` **ProtocolConstants**: `object` -Defined in: [packages/protocol/src/Constants.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/Constants.ts#L1) +Defined in: [packages/protocol/src/Constants.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/Constants.ts#L1) ## Type declaration diff --git a/src/pages/docs/reference/protocol/variables/treeFeeHeight.md b/src/pages/docs/reference/protocol/variables/treeFeeHeight.md index 28fc9b6..d2778bf 100644 --- a/src/pages/docs/reference/protocol/variables/treeFeeHeight.md +++ b/src/pages/docs/reference/protocol/variables/treeFeeHeight.md @@ -12,4 +12,4 @@ title: treeFeeHeight > `const` **treeFeeHeight**: `10` = `10` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L4) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L4) diff --git a/src/pages/docs/reference/sdk/classes/AppChain.md b/src/pages/docs/reference/sdk/classes/AppChain.md index 3b0e304..9e6f797 100644 --- a/src/pages/docs/reference/sdk/classes/AppChain.md +++ b/src/pages/docs/reference/sdk/classes/AppChain.md @@ -10,7 +10,7 @@ title: AppChain # Class: AppChain\ -Defined in: [sdk/src/appChain/AppChain.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L112) +Defined in: [sdk/src/appChain/AppChain.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L112) AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer @@ -39,7 +39,7 @@ AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer > **new AppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L151) +Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L151) #### Parameters @@ -76,7 +76,7 @@ checks when retrieving it via the getter > **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L144) +Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L144) #### Overrides @@ -180,7 +180,7 @@ list of module names > **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L215) +Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L215) ##### Returns @@ -194,7 +194,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/fram > **get** **query**(): `object` -Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L176) +Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L176) ##### Returns @@ -220,7 +220,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/fram > **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L207) +Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L207) ##### Returns @@ -234,7 +234,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/fram > **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L211) +Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L211) ##### Returns @@ -294,7 +294,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L352) +Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L352) #### Returns @@ -650,7 +650,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:129 > **start**(`proofsEnabled`, `dependencyContainer`): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L309) +Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L309) Starts the appchain and cross-registers runtime to sequencer @@ -674,7 +674,7 @@ Starts the appchain and cross-registers runtime to sequencer > **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> -Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L219) +Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L219) #### Parameters @@ -731,7 +731,7 @@ such as only injecting other known modules. > `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L127) +Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L127) #### Type Parameters diff --git a/src/pages/docs/reference/sdk/classes/AppChainModule.md b/src/pages/docs/reference/sdk/classes/AppChainModule.md index bebdbbf..4137d38 100644 --- a/src/pages/docs/reference/sdk/classes/AppChainModule.md +++ b/src/pages/docs/reference/sdk/classes/AppChainModule.md @@ -10,7 +10,7 @@ title: AppChainModule # Class: AppChainModule\ -Defined in: [sdk/src/appChain/AppChainModule.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L13) +Defined in: [sdk/src/appChain/AppChainModule.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L13) Used by various module sub-types that may need to be configured @@ -55,7 +55,7 @@ Used by various module sub-types that may need to be configured > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) *** @@ -78,7 +78,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) ## Accessors diff --git a/src/pages/docs/reference/sdk/classes/AppChainTransaction.md b/src/pages/docs/reference/sdk/classes/AppChainTransaction.md index d9bc930..adce8ad 100644 --- a/src/pages/docs/reference/sdk/classes/AppChainTransaction.md +++ b/src/pages/docs/reference/sdk/classes/AppChainTransaction.md @@ -10,7 +10,7 @@ title: AppChainTransaction # Class: AppChainTransaction -Defined in: [sdk/src/transaction/AppChainTransaction.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L6) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L6) ## Constructors @@ -18,7 +18,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:6](https://github.com/pr > **new AppChainTransaction**(`signer`, `transactionSender`): [`AppChainTransaction`](AppChainTransaction.md) -Defined in: [sdk/src/transaction/AppChainTransaction.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L9) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L9) #### Parameters @@ -40,7 +40,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:9](https://github.com/pr > **signer**: [`Signer`](../interfaces/Signer.md) -Defined in: [sdk/src/transaction/AppChainTransaction.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L10) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L10) *** @@ -48,7 +48,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:10](https://github.com/p > `optional` **transaction**: [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) \| [`UnsignedTransaction`](../../sequencer/classes/UnsignedTransaction.md) -Defined in: [sdk/src/transaction/AppChainTransaction.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L7) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L7) *** @@ -56,7 +56,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:7](https://github.com/pr > **transactionSender**: [`TransactionSender`](../interfaces/TransactionSender.md) -Defined in: [sdk/src/transaction/AppChainTransaction.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L11) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L11) ## Methods @@ -64,7 +64,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:11](https://github.com/p > **hasPendingTransaction**(`transaction`?): `asserts transaction is PendingTransaction` -Defined in: [sdk/src/transaction/AppChainTransaction.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L27) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L27) #### Parameters @@ -82,7 +82,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:27](https://github.com/p > **hasUnsignedTransaction**(`transaction`?): `asserts transaction is UnsignedTransaction` -Defined in: [sdk/src/transaction/AppChainTransaction.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L18) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L18) #### Parameters @@ -100,7 +100,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:18](https://github.com/p > **send**(): `Promise`\<`void`\> -Defined in: [sdk/src/transaction/AppChainTransaction.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L48) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L48) #### Returns @@ -112,7 +112,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:48](https://github.com/p > **sign**(): `Promise`\<`void`\> -Defined in: [sdk/src/transaction/AppChainTransaction.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L36) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L36) #### Returns @@ -124,7 +124,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:36](https://github.com/p > **withUnsignedTransaction**(`unsignedTransaction`): `void` -Defined in: [sdk/src/transaction/AppChainTransaction.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AppChainTransaction.ts#L14) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L14) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md b/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md index 1895f70..37e1a54 100644 --- a/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md +++ b/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md @@ -10,7 +10,7 @@ title: AreProofsEnabledFactory # Class: AreProofsEnabledFactory -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L21) +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L21) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -43,7 +43,7 @@ deps that are necessary for the sequencer to work. > **dependencies**(): `object` -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L22) +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L22) #### Returns diff --git a/src/pages/docs/reference/sdk/classes/AuroSigner.md b/src/pages/docs/reference/sdk/classes/AuroSigner.md index 6d087f5..3460a8b 100644 --- a/src/pages/docs/reference/sdk/classes/AuroSigner.md +++ b/src/pages/docs/reference/sdk/classes/AuroSigner.md @@ -10,7 +10,7 @@ title: AuroSigner # Class: AuroSigner -Defined in: [sdk/src/transaction/AuroSigner.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AuroSigner.ts#L9) +Defined in: [sdk/src/transaction/AuroSigner.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AuroSigner.ts#L9) Used by various module sub-types that may need to be configured @@ -42,7 +42,7 @@ Used by various module sub-types that may need to be configured > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -69,7 +69,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -137,7 +137,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **sign**(`message`): `Promise`\<`Signature`\> -Defined in: [sdk/src/transaction/AuroSigner.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/AuroSigner.ts#L10) +Defined in: [sdk/src/transaction/AuroSigner.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AuroSigner.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md b/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md index 598bb7e..f4f84a5 100644 --- a/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md +++ b/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md @@ -10,7 +10,7 @@ title: BlockStorageNetworkStateModule # Class: BlockStorageNetworkStateModule -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L17) +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L17) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new BlockStorageNetworkStateModule**(`sequencer`): [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md) -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L21) +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L21) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:21](https://github. > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -77,7 +77,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -145,7 +145,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **getProvenNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L58) +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L58) #### Returns @@ -161,7 +161,7 @@ Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:58](https://github. > **getStagedNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L53) +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L53) Staged network state is the networkstate after the latest unproven block with afterBundle() hooks executed @@ -180,7 +180,7 @@ with afterBundle() hooks executed > **getUnprovenNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L44) +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L44) #### Returns diff --git a/src/pages/docs/reference/sdk/classes/ClientAppChain.md b/src/pages/docs/reference/sdk/classes/ClientAppChain.md index b7aa61b..971368d 100644 --- a/src/pages/docs/reference/sdk/classes/ClientAppChain.md +++ b/src/pages/docs/reference/sdk/classes/ClientAppChain.md @@ -10,7 +10,7 @@ title: ClientAppChain # Class: ClientAppChain\ -Defined in: [sdk/src/appChain/ClientAppChain.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/ClientAppChain.ts#L30) +Defined in: [sdk/src/appChain/ClientAppChain.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/ClientAppChain.ts#L30) AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer @@ -34,7 +34,7 @@ AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer > **new ClientAppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`ClientAppChain`](ClientAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L151) +Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L151) #### Parameters @@ -71,7 +71,7 @@ checks when retrieving it via the getter > **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L144) +Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L144) #### Inherited from @@ -175,7 +175,7 @@ list of module names > **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L215) +Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L215) ##### Returns @@ -193,7 +193,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/fram > **get** **query**(): `object` -Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L176) +Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L176) ##### Returns @@ -223,7 +223,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/fram > **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L207) +Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L207) ##### Returns @@ -241,7 +241,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/fram > **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L211) +Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L211) ##### Returns @@ -305,7 +305,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L352) +Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L352) #### Returns @@ -665,7 +665,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/ClientAppChain.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/ClientAppChain.ts#L108) +Defined in: [sdk/src/appChain/ClientAppChain.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/ClientAppChain.ts#L108) Starts the appchain and cross-registers runtime to sequencer @@ -683,7 +683,7 @@ Starts the appchain and cross-registers runtime to sequencer > **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> -Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L219) +Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L219) #### Parameters @@ -744,7 +744,7 @@ such as only injecting other known modules. > `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L127) +Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L127) #### Type Parameters @@ -776,7 +776,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/fram > `static` **fromRuntime**\<`RuntimeModules`, `SignerType`\>(`runtimeModules`, `signer`): [`ClientAppChain`](ClientAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{\}, \{ `GraphqlClient`: *typeof* [`GraphqlClient`](GraphqlClient.md); `NetworkStateTransportModule`: *typeof* [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md); `QueryTransportModule`: *typeof* [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md); `Signer`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`SignerType`\>; `TransactionSender`: *typeof* [`GraphqlTransactionSender`](GraphqlTransactionSender.md); \}\> -Defined in: [sdk/src/appChain/ClientAppChain.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/ClientAppChain.ts#L42) +Defined in: [sdk/src/appChain/ClientAppChain.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/ClientAppChain.ts#L42) #### Type Parameters diff --git a/src/pages/docs/reference/sdk/classes/GraphqlClient.md b/src/pages/docs/reference/sdk/classes/GraphqlClient.md index 7b967ea..bb69255 100644 --- a/src/pages/docs/reference/sdk/classes/GraphqlClient.md +++ b/src/pages/docs/reference/sdk/classes/GraphqlClient.md @@ -10,7 +10,7 @@ title: GraphqlClient # Class: GraphqlClient -Defined in: [sdk/src/graphql/GraphqlClient.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlClient.ts#L9) +Defined in: [sdk/src/graphql/GraphqlClient.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlClient.ts#L9) Used by various module sub-types that may need to be configured @@ -38,7 +38,7 @@ Used by various module sub-types that may need to be configured > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -65,7 +65,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit > **get** **client**(): `Client` -Defined in: [sdk/src/graphql/GraphqlClient.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlClient.ts#L20) +Defined in: [sdk/src/graphql/GraphqlClient.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlClient.ts#L20) ##### Returns diff --git a/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md b/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md index 60165f6..36e5e73 100644 --- a/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md +++ b/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md @@ -10,7 +10,7 @@ title: GraphqlNetworkStateTransportModule # Class: GraphqlNetworkStateTransportModule -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L20) +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L20) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new GraphqlNetworkStateTransportModule**(`graphqlClient`): [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md) -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L24) +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L24) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:24](https://g > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -77,7 +77,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -145,7 +145,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **getProvenNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L71) +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L71) #### Returns @@ -161,7 +161,7 @@ Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:71](https://g > **getStagedNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L75) +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L75) #### Returns @@ -177,7 +177,7 @@ Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:75](https://g > **getUnprovenNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L79) +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L79) #### Returns diff --git a/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md b/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md index f04f83e..fd78fef 100644 --- a/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md +++ b/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md @@ -10,7 +10,7 @@ title: GraphqlQueryTransportModule # Class: GraphqlQueryTransportModule -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L30) +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L30) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new GraphqlQueryTransportModule**(`graphqlClient`): [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md) -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L34) +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L34) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:34](https://github.c > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -77,7 +77,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -145,7 +145,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L40) +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L40) #### Parameters @@ -167,7 +167,7 @@ Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:40](https://github.c > **merkleWitness**(`key`): `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L65) +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L65) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md b/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md index bbd9a1f..03213bc 100644 --- a/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md +++ b/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md @@ -10,7 +10,7 @@ title: GraphqlTransactionSender # Class: GraphqlTransactionSender -Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L11) +Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L11) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new GraphqlTransactionSender**(`graphqlClient`): [`GraphqlTransactionSender`](GraphqlTransactionSender.md) -Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L15) +Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L15) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:15](https://github.com/ > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Implementation of @@ -85,7 +85,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -161,7 +161,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **send**(`transaction`): `Promise`\<`void`\> -Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L21) +Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L21) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md b/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md index b4bdd05..09eb30e 100644 --- a/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md +++ b/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md @@ -10,7 +10,7 @@ title: InMemoryAreProofsEnabled # Class: InMemoryAreProofsEnabled -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L9) +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L9) ## Implements @@ -34,7 +34,7 @@ Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:9](https://github.com/p > **get** **areProofsEnabled**(): `boolean` -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L12) +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L12) ##### Returns @@ -50,7 +50,7 @@ Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:12](https://github.com/ > **setProofsEnabled**(`areProofsEnabled`): `void` -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L16) +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/InMemorySigner.md b/src/pages/docs/reference/sdk/classes/InMemorySigner.md index 4fae6c3..04faf54 100644 --- a/src/pages/docs/reference/sdk/classes/InMemorySigner.md +++ b/src/pages/docs/reference/sdk/classes/InMemorySigner.md @@ -10,7 +10,7 @@ title: InMemorySigner # Class: InMemorySigner -Defined in: [sdk/src/transaction/InMemorySigner.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L15) +Defined in: [sdk/src/transaction/InMemorySigner.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L15) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new InMemorySigner**(): [`InMemorySigner`](InMemorySigner.md) -Defined in: [sdk/src/transaction/InMemorySigner.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L19) +Defined in: [sdk/src/transaction/InMemorySigner.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L19) #### Returns @@ -44,7 +44,7 @@ Defined in: [sdk/src/transaction/InMemorySigner.ts:19](https://github.com/proto- > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -71,7 +71,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -139,7 +139,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **sign**(`signatureData`): `Promise`\<`Signature`\> -Defined in: [sdk/src/transaction/InMemorySigner.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L23) +Defined in: [sdk/src/transaction/InMemorySigner.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L23) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md b/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md index 8aef76c..f97bb9c 100644 --- a/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md +++ b/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md @@ -10,7 +10,7 @@ title: InMemoryTransactionSender # Class: InMemoryTransactionSender -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L16) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L16) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new InMemoryTransactionSender**(`sequencer`): [`InMemoryTransactionSender`](InMemoryTransactionSender.md) -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L22) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L22) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:22](https://github > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Implementation of @@ -85,7 +85,7 @@ checks when retrieving it via the getter > **mempool**: [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md) -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L20) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L20) *** @@ -93,7 +93,7 @@ Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:20](https://github > **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L23) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L23) *** @@ -101,7 +101,7 @@ Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:23](https://github > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -177,7 +177,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **send**(`transaction`): `Promise`\<`void`\> -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L30) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L30) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md b/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md index f58568c..c5b5c63 100644 --- a/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md +++ b/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md @@ -10,7 +10,7 @@ title: SharedDependencyFactory # Class: SharedDependencyFactory -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/SharedDependencyFactory.ts#L14) +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/SharedDependencyFactory.ts#L14) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -43,7 +43,7 @@ deps that are necessary for the sequencer to work. > **dependencies**(): [`SharedDependencyRecord`](../interfaces/SharedDependencyRecord.md) -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/SharedDependencyFactory.ts#L15) +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/SharedDependencyFactory.ts#L15) #### Returns diff --git a/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md b/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md index d7a7638..3e1bef2 100644 --- a/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md +++ b/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md @@ -10,7 +10,7 @@ title: StateServiceQueryModule # Class: StateServiceQueryModule -Defined in: [sdk/src/query/StateServiceQueryModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L16) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L16) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new StateServiceQueryModule**(`sequencer`): [`StateServiceQueryModule`](StateServiceQueryModule.md) -Defined in: [sdk/src/query/StateServiceQueryModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L20) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L20) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/query/StateServiceQueryModule.ts:20](https://github.com/pro > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -77,7 +77,7 @@ checks when retrieving it via the getter > **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> -Defined in: [sdk/src/query/StateServiceQueryModule.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L21) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L21) *** @@ -85,7 +85,7 @@ Defined in: [sdk/src/query/StateServiceQueryModule.ts:21](https://github.com/pro > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit > **get** **asyncStateService**(): [`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md) -Defined in: [sdk/src/query/StateServiceQueryModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L26) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L26) ##### Returns @@ -147,7 +147,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **get** **treeStore**(): [`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md) -Defined in: [sdk/src/query/StateServiceQueryModule.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L32) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L32) ##### Returns @@ -181,7 +181,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [sdk/src/query/StateServiceQueryModule.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L36) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L36) #### Parameters @@ -203,7 +203,7 @@ Defined in: [sdk/src/query/StateServiceQueryModule.ts:36](https://github.com/pro > **merkleWitness**(`path`): `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> -Defined in: [sdk/src/query/StateServiceQueryModule.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/query/StateServiceQueryModule.ts#L40) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L40) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/TestingAppChain.md b/src/pages/docs/reference/sdk/classes/TestingAppChain.md index f48515b..e8322d4 100644 --- a/src/pages/docs/reference/sdk/classes/TestingAppChain.md +++ b/src/pages/docs/reference/sdk/classes/TestingAppChain.md @@ -10,7 +10,7 @@ title: TestingAppChain # Class: TestingAppChain\ -Defined in: [sdk/src/appChain/TestingAppChain.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L58) +Defined in: [sdk/src/appChain/TestingAppChain.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L58) AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer @@ -34,7 +34,7 @@ AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer > **new TestingAppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`TestingAppChain`](TestingAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L151) +Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L151) #### Parameters @@ -71,7 +71,7 @@ checks when retrieving it via the getter > **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L144) +Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L144) #### Inherited from @@ -175,7 +175,7 @@ list of module names > **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L215) +Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L215) ##### Returns @@ -193,7 +193,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/fram > **get** **query**(): `object` -Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L176) +Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L176) ##### Returns @@ -223,7 +223,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/fram > **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L207) +Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L207) ##### Returns @@ -241,7 +241,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/fram > **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L211) +Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L211) ##### Returns @@ -305,7 +305,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L352) +Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L352) #### Returns @@ -501,7 +501,7 @@ Handle module resolution, e.g. by decorating resolved modules > **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> -Defined in: [sdk/src/appChain/TestingAppChain.ts:135](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L135) +Defined in: [sdk/src/appChain/TestingAppChain.ts:135](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L135) #### Returns @@ -513,7 +513,7 @@ Defined in: [sdk/src/appChain/TestingAppChain.ts:135](https://github.com/proto-k > **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> -Defined in: [sdk/src/appChain/TestingAppChain.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L144) +Defined in: [sdk/src/appChain/TestingAppChain.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L144) #### Returns @@ -689,7 +689,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:129 > **setSigner**(`signer`): `void` -Defined in: [sdk/src/appChain/TestingAppChain.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L130) +Defined in: [sdk/src/appChain/TestingAppChain.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L130) #### Parameters @@ -707,7 +707,7 @@ Defined in: [sdk/src/appChain/TestingAppChain.ts:130](https://github.com/proto-k > **start**(`proofsEnabled`, `dependencyContainer`): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L309) +Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L309) Starts the appchain and cross-registers runtime to sequencer @@ -735,7 +735,7 @@ Starts the appchain and cross-registers runtime to sequencer > **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> -Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L219) +Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L219) #### Parameters @@ -796,7 +796,7 @@ such as only injecting other known modules. > `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L127) +Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L127) #### Type Parameters @@ -828,7 +828,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/fram > `static` **fromRuntime**\<`RuntimeModules`\>(`runtimeModules`): [`TestingAppChain`](TestingAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](InMemoryTransactionSender.md); \}\> -Defined in: [sdk/src/appChain/TestingAppChain.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L70) +Defined in: [sdk/src/appChain/TestingAppChain.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L70) #### Type Parameters diff --git a/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md b/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md index 801e187..af0b630 100644 --- a/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md +++ b/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md @@ -10,7 +10,7 @@ title: AppChainConfig # Interface: AppChainConfig\ -Defined in: [sdk/src/appChain/AppChain.ts:96](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L96) +Defined in: [sdk/src/appChain/AppChain.ts:96](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L96) Definition of required arguments for AppChain @@ -30,7 +30,7 @@ Definition of required arguments for AppChain > **AppChain**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:106](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L106) +Defined in: [sdk/src/appChain/AppChain.ts:106](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L106) *** @@ -38,7 +38,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:106](https://github.com/proto-kit/fram > **Protocol**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`ProtocolModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:104](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L104) +Defined in: [sdk/src/appChain/AppChain.ts:104](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L104) *** @@ -46,7 +46,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:104](https://github.com/proto-kit/fram > **Runtime**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`RuntimeModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:103](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L103) +Defined in: [sdk/src/appChain/AppChain.ts:103](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L103) *** @@ -54,4 +54,4 @@ Defined in: [sdk/src/appChain/AppChain.ts:103](https://github.com/proto-kit/fram > **Sequencer**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`SequencerModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L105) +Defined in: [sdk/src/appChain/AppChain.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L105) diff --git a/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md b/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md index 17b3cb9..9e7336e 100644 --- a/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md +++ b/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md @@ -10,7 +10,7 @@ title: AppChainDefinition # Interface: AppChainDefinition\ -Defined in: [sdk/src/appChain/AppChain.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L53) +Defined in: [sdk/src/appChain/AppChain.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L53) ## Type Parameters @@ -28,7 +28,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:53](https://github.com/proto-kit/frame > **modules**: `AppChainModules` -Defined in: [sdk/src/appChain/AppChain.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L63) +Defined in: [sdk/src/appChain/AppChain.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L63) *** @@ -36,7 +36,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:63](https://github.com/proto-kit/frame > **Protocol**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\>\> -Defined in: [sdk/src/appChain/AppChain.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L61) +Defined in: [sdk/src/appChain/AppChain.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L61) *** @@ -44,7 +44,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:61](https://github.com/proto-kit/frame > **Runtime**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\>\> -Defined in: [sdk/src/appChain/AppChain.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L60) +Defined in: [sdk/src/appChain/AppChain.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L60) *** @@ -52,4 +52,4 @@ Defined in: [sdk/src/appChain/AppChain.ts:60](https://github.com/proto-kit/frame > **Sequencer**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\>\> -Defined in: [sdk/src/appChain/AppChain.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L62) +Defined in: [sdk/src/appChain/AppChain.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L62) diff --git a/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md b/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md index f25d0af..51b1823 100644 --- a/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md +++ b/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md @@ -10,7 +10,7 @@ title: ExpandAppChainDefinition # Interface: ExpandAppChainDefinition\ -Defined in: [sdk/src/appChain/AppChain.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L78) +Defined in: [sdk/src/appChain/AppChain.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L78) ## Type Parameters @@ -28,4 +28,4 @@ Defined in: [sdk/src/appChain/AppChain.ts:78](https://github.com/proto-kit/frame > **modules**: [`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L85) +Defined in: [sdk/src/appChain/AppChain.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L85) diff --git a/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md b/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md index ceea63d..a5314ab 100644 --- a/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md +++ b/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md @@ -10,7 +10,7 @@ title: GraphqlClientConfig # Interface: GraphqlClientConfig -Defined in: [sdk/src/graphql/GraphqlClient.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlClient.ts#L5) +Defined in: [sdk/src/graphql/GraphqlClient.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlClient.ts#L5) ## Properties @@ -18,4 +18,4 @@ Defined in: [sdk/src/graphql/GraphqlClient.ts:5](https://github.com/proto-kit/fr > **url**: `string` -Defined in: [sdk/src/graphql/GraphqlClient.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/graphql/GraphqlClient.ts#L6) +Defined in: [sdk/src/graphql/GraphqlClient.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlClient.ts#L6) diff --git a/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md b/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md index 0ca779d..17ff04f 100644 --- a/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md +++ b/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md @@ -10,7 +10,7 @@ title: InMemorySignerConfig # Interface: InMemorySignerConfig -Defined in: [sdk/src/transaction/InMemorySigner.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L10) +Defined in: [sdk/src/transaction/InMemorySigner.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L10) ## Properties @@ -18,4 +18,4 @@ Defined in: [sdk/src/transaction/InMemorySigner.ts:10](https://github.com/proto- > **signer**: `PrivateKey` -Defined in: [sdk/src/transaction/InMemorySigner.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L11) +Defined in: [sdk/src/transaction/InMemorySigner.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L11) diff --git a/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md b/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md index 7d00a2f..65b1cab 100644 --- a/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md +++ b/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md @@ -10,7 +10,7 @@ title: SharedDependencyRecord # Interface: SharedDependencyRecord -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/SharedDependencyFactory.ts#L9) +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/SharedDependencyFactory.ts#L9) ## Extends @@ -26,7 +26,7 @@ Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:9](https://github.com/p > **methodIdResolver**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`MethodIdResolver`](../../module/classes/MethodIdResolver.md)\> -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/SharedDependencyFactory.ts#L11) +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/SharedDependencyFactory.ts#L11) *** @@ -34,4 +34,4 @@ Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:11](https://github.com/ > **stateServiceProvider**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md)\> -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/SharedDependencyFactory.ts#L10) +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/SharedDependencyFactory.ts#L10) diff --git a/src/pages/docs/reference/sdk/interfaces/Signer.md b/src/pages/docs/reference/sdk/interfaces/Signer.md index 52e9140..163b3ff 100644 --- a/src/pages/docs/reference/sdk/interfaces/Signer.md +++ b/src/pages/docs/reference/sdk/interfaces/Signer.md @@ -10,7 +10,7 @@ title: Signer # Interface: Signer -Defined in: [sdk/src/transaction/InMemorySigner.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L6) +Defined in: [sdk/src/transaction/InMemorySigner.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L6) ## Properties @@ -18,7 +18,7 @@ Defined in: [sdk/src/transaction/InMemorySigner.ts:6](https://github.com/proto-k > **sign**: (`signatureData`) => `Promise`\<`Signature`\> -Defined in: [sdk/src/transaction/InMemorySigner.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemorySigner.ts#L7) +Defined in: [sdk/src/transaction/InMemorySigner.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L7) #### Parameters diff --git a/src/pages/docs/reference/sdk/interfaces/TransactionSender.md b/src/pages/docs/reference/sdk/interfaces/TransactionSender.md index 71b2b9a..7271771 100644 --- a/src/pages/docs/reference/sdk/interfaces/TransactionSender.md +++ b/src/pages/docs/reference/sdk/interfaces/TransactionSender.md @@ -10,7 +10,7 @@ title: TransactionSender # Interface: TransactionSender -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L11) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L11) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > `optional` **appChain**: [`AppChain`](../classes/AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -51,7 +51,7 @@ checks when retrieving it via the getter > **send**: (`transaction`) => `Promise`\<`void`\> -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L12) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L12) #### Parameters diff --git a/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md index f7941d2..e50ff66 100644 --- a/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md +++ b/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md @@ -12,4 +12,4 @@ title: AppChainModulesRecord > **AppChainModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AppChainModule`](../classes/AppChainModule.md)\<`unknown`\>\>\> -Defined in: [sdk/src/appChain/AppChain.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L49) +Defined in: [sdk/src/appChain/AppChain.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L49) diff --git a/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md b/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md index 1c8f3bd..21b7a67 100644 --- a/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md +++ b/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md @@ -12,7 +12,7 @@ title: ExpandAppChainModules > **ExpandAppChainModules**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>: `AppChainModules` & `object` -Defined in: [sdk/src/appChain/AppChain.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/AppChain.ts#L66) +Defined in: [sdk/src/appChain/AppChain.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L66) ## Type declaration diff --git a/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md index 2b5c0ea..32ea89c 100644 --- a/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md +++ b/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md @@ -12,7 +12,7 @@ title: PartialVanillaRuntimeModulesRecord > **PartialVanillaRuntimeModulesRecord**: `object` -Defined in: [sdk/src/appChain/TestingAppChain.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L52) +Defined in: [sdk/src/appChain/TestingAppChain.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L52) ## Type declaration diff --git a/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md index d173a2d..3d944ee 100644 --- a/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md +++ b/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md @@ -12,7 +12,7 @@ title: TestingSequencerModulesRecord > **TestingSequencerModulesRecord**: `object` -Defined in: [sdk/src/appChain/TestingAppChain.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L37) +Defined in: [sdk/src/appChain/TestingAppChain.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L37) ## Type declaration diff --git a/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md b/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md index bf83192..7d88f92 100644 --- a/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md +++ b/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md @@ -12,4 +12,4 @@ title: randomFeeRecipient > `const` **randomFeeRecipient**: `string` -Defined in: [sdk/src/appChain/TestingAppChain.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sdk/src/appChain/TestingAppChain.ts#L56) +Defined in: [sdk/src/appChain/TestingAppChain.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L56) diff --git a/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md b/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md index e962497..4806eea 100644 --- a/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md +++ b/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md @@ -10,7 +10,7 @@ title: AbstractTaskQueue # Class: `abstract` AbstractTaskQueue\ -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L5) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L5) Lifecycle of a SequencerModule @@ -64,7 +64,7 @@ checks when retrieving it via the getter > `protected` **queues**: `Record`\<`string`, [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> = `{}` -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) *** @@ -72,7 +72,7 @@ Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https:/ > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -118,7 +118,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > `protected` **closeQueues**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) #### Returns @@ -152,7 +152,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `protected` **createOrGetQueue**(`name`, `creator`): [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) #### Parameters @@ -174,7 +174,7 @@ Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https: > `abstract` **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md b/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md index 3d49475..fe1a57b 100644 --- a/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md @@ -10,7 +10,7 @@ title: ArtifactRecordSerializer # Class: ArtifactRecordSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L10) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L10) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Artifa > **fromJSON**(`json`): [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L27) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L27) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Artifa > **toJSON**(`input`): [`SerializedArtifactRecord`](../type-aliases/SerializedArtifactRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L11) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L11) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md b/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md index 867a1a6..d91739a 100644 --- a/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md +++ b/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md @@ -10,7 +10,7 @@ title: BatchProducerModule # Class: BatchProducerModule -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L74) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L74) The BatchProducerModule has the resposiblity to oversee the block production and combine all necessary parts for that to happen. The flow roughly follows @@ -29,7 +29,7 @@ the following steps: > **new BatchProducerModule**(`asyncStateService`, `merkleStore`, `batchStorage`, `blockTreeStore`, `database`, `traceService`, `blockFlowService`, `blockProofSerializer`, `verificationKeyService`): [`BatchProducerModule`](BatchProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:77](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L77) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L77) #### Parameters @@ -98,7 +98,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -166,7 +166,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **createBatch**(`blocks`): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L108) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L108) Main function to call when wanting to create a new block based on the transactions that are present in the mempool. This function should also @@ -188,7 +188,7 @@ be the one called by BlockTriggers > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L132) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L132) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md b/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md index 331852b..6ca85c6 100644 --- a/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md +++ b/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md @@ -10,7 +10,7 @@ title: BlockProducerModule # Class: BlockProducerModule -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L39) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L39) Lifecycle of a SequencerModule @@ -26,7 +26,7 @@ start(): Executed to execute any logic required to start the module > **new BlockProducerModule**(`mempool`, `messageStorage`, `unprovenStateService`, `unprovenMerkleStore`, `blockQueue`, `blockTreeStore`, `productionService`, `resultService`, `methodIdResolver`, `runtime`, `database`): [`BlockProducerModule`](BlockProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L42) #### Parameters @@ -103,7 +103,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -149,7 +149,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **blockResultCompleteCheck**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:236](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L236) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:236](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L236) #### Returns @@ -183,7 +183,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **generateMetadata**(`block`): `Promise`\<[`BlockResult`](../interfaces/BlockResult.md)\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:110](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L110) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:110](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L110) #### Parameters @@ -201,7 +201,7 @@ Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducer > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:251](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L251) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:251](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L251) Start the module and all it's functionality. The returned Promise has to resolve after initialization, @@ -222,7 +222,7 @@ That means that you mustn't await server.start() for example. > **tryProduceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:128](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L128) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:128](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L128) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md b/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md index 64cd94c..c925983 100644 --- a/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md @@ -10,7 +10,7 @@ title: BlockProofSerializer # Class: BlockProofSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L13) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L13) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockP > **new BlockProofSerializer**(`protocol`): [`BlockProofSerializer`](BlockProofSerializer.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L19) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L19) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockP > **getBlockProofSerializer**(): [`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../../protocol/classes/BlockProverPublicOutput.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L24) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L24) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md b/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md index 6162c01..4ef288a 100644 --- a/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md +++ b/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md @@ -10,7 +10,7 @@ title: BlockTaskFlowService # Class: BlockTaskFlowService -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L56) +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L56) We could rename this into BlockCreationStrategy and enable the injection of different creation strategies. @@ -21,7 +21,7 @@ different creation strategies. > **new BlockTaskFlowService**(`taskQueue`, `flowCreator`, `stateTransitionTask`, `stateTransitionReductionTask`, `runtimeProvingTask`, `transactionProvingTask`, `blockProvingTask`, `blockReductionTask`, `protocol`): [`BlockTaskFlowService`](BlockTaskFlowService.md) -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L57) +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L57) #### Parameters @@ -71,7 +71,7 @@ Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts: > **executeFlow**(`blockTraces`, `batchId`): `Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:142](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L142) +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:142](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L142) #### Parameters @@ -93,7 +93,7 @@ Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts: > **pushBlockPairing**(`flow`, `blockReductionTask`, `index`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:93](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L93) +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:93](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L93) #### Parameters @@ -119,7 +119,7 @@ Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts: > **pushPairing**(`flow`, `transactionReductionTask`, `blockIndex`, `transactionIndex`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L70) +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L70) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md b/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md index 570dd47..114eeb6 100644 --- a/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md +++ b/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md @@ -10,7 +10,7 @@ title: BlockTriggerBase # Class: BlockTriggerBase\ -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L35) A BlockTrigger is the primary method to start the production of a block and all associated processes. @@ -41,7 +41,7 @@ all associated processes. > **new BlockTriggerBase**\<`Config`, `Events`\>(`blockProducerModule`, `batchProducerModule`, `settlementModule`, `blockQueue`, `batchQueue`, `settlementStorage`): [`BlockTriggerBase`](BlockTriggerBase.md)\<`Config`, `Events`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L44) #### Parameters @@ -83,7 +83,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) *** @@ -91,7 +91,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) *** @@ -99,7 +99,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) *** @@ -107,7 +107,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) *** @@ -130,7 +130,7 @@ checks when retrieving it via the getter > `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<`Events`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) #### Implementation of @@ -142,7 +142,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) *** @@ -150,7 +150,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) *** @@ -158,7 +158,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -226,7 +226,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `protected` **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) #### Returns @@ -238,7 +238,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) #### Returns @@ -250,7 +250,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) #### Returns @@ -262,7 +262,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) #### Parameters @@ -280,7 +280,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md index 7f0cfb2..2b986ba 100644 --- a/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md +++ b/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md @@ -10,7 +10,7 @@ title: CachedMerkleTreeStore # Class: CachedMerkleTreeStore -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L14) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L14) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:14](ht > **new CachedMerkleTreeStore**(`parent`): [`CachedMerkleTreeStore`](CachedMerkleTreeStore.md) -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L32) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L32) #### Parameters @@ -64,7 +64,7 @@ Defined in: packages/common/dist/trees/InMemoryMerkleTreeStorage.d.ts:3 > **commit**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L28) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L28) #### Returns @@ -80,7 +80,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:28](ht > **getNode**(`key`, `level`): `undefined` \| `bigint` -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L36) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L36) #### Parameters @@ -106,7 +106,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:36](ht > **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:148](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L148) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:148](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L148) #### Parameters @@ -128,7 +128,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:148](h > **getWrittenNodes**(): `object` -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L45) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L45) #### Returns @@ -140,7 +140,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:45](ht > **mergeIntoParent**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L112) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L112) #### Returns @@ -152,7 +152,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:112](h > **openTransaction**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L24) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L24) #### Returns @@ -168,7 +168,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:24](ht > **preloadKey**(`index`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L108) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L108) #### Parameters @@ -186,7 +186,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:108](h > **preloadKeys**(`keys`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L94) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L94) #### Parameters @@ -204,7 +204,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:94](ht > **resetWrittenNodes**(): `void` -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L53) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L53) #### Returns @@ -216,7 +216,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:53](ht > **setNode**(`key`, `level`, `value`): `void` -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L40) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L40) #### Parameters @@ -246,7 +246,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:40](ht > **setNodeAsync**(`key`, `level`, `value`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:140](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L140) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:140](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L140) #### Parameters @@ -272,7 +272,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:140](h > **writeNodes**(`nodes`): `void` -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:176](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L176) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:176](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L176) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/CachedStateService.md b/src/pages/docs/reference/sequencer/classes/CachedStateService.md index ea6834d..ccb42d7 100644 --- a/src/pages/docs/reference/sequencer/classes/CachedStateService.md +++ b/src/pages/docs/reference/sequencer/classes/CachedStateService.md @@ -10,7 +10,7 @@ title: CachedStateService # Class: CachedStateService -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L12) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L12) This Interface should be implemented for services that store the state in an external storage (like a DB). This can be used in conjunction with @@ -31,7 +31,7 @@ CachedStateService to preload keys for In-Circuit usage. > **new CachedStateService**(`parent`): [`CachedStateService`](CachedStateService.md) -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L18) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L18) #### Parameters @@ -68,7 +68,7 @@ This is used by the CachedState service to keep track of deletions > **applyStateTransitions**(`stateTransitions`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:99](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L99) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:99](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L99) #### Parameters @@ -86,7 +86,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:99](https: > **commit**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L42) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L42) #### Returns @@ -102,7 +102,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:42](https: > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:94](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L94) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L94) #### Parameters @@ -128,7 +128,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:94](https: > **getMany**(`keys`): `Promise`\<[`StateEntry`](../interfaces/StateEntry.md)[]\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L75) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L75) #### Parameters @@ -150,7 +150,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:75](https: > **mergeIntoParent**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:118](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L118) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:118](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L118) Merges all caches set() operation into the parent and resets this instance to the parent's state (by clearing the cache and @@ -166,7 +166,7 @@ defaulting to the parent) > **openTransaction**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L48) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L48) #### Returns @@ -182,7 +182,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:48](https: > **preloadKey**(`key`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L52) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L52) #### Parameters @@ -200,7 +200,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:52](https: > **preloadKeys**(`keys`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L56) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L56) #### Parameters @@ -248,7 +248,7 @@ Defined in: packages/module/dist/state/InMemoryStateService.d.ts:13 > **writeStates**(`entries`): `void` -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/CachedStateService.ts#L38) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L38) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/CompressedSignature.md b/src/pages/docs/reference/sequencer/classes/CompressedSignature.md index fdf9a67..6aeb816 100644 --- a/src/pages/docs/reference/sequencer/classes/CompressedSignature.md +++ b/src/pages/docs/reference/sequencer/classes/CompressedSignature.md @@ -10,7 +10,7 @@ title: CompressedSignature # Class: CompressedSignature -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L8) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L8) CompressedSignature compresses the s scalar of a Signature (which is expanded to 256 Fields in snarkyjs) to a single string @@ -21,7 +21,7 @@ CompressedSignature compresses the s scalar of a Signature > **new CompressedSignature**(`r`, `s`): [`CompressedSignature`](CompressedSignature.md) -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L15) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L15) #### Parameters @@ -43,7 +43,7 @@ Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:15](https://g > `readonly` **r**: `Field` -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L16) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L16) *** @@ -51,7 +51,7 @@ Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:16](https://g > `readonly` **s**: `string` -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L17) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L17) ## Methods @@ -59,7 +59,7 @@ Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:17](https://g > **toSignature**(): `Signature` -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L21) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L21) #### Returns @@ -71,7 +71,7 @@ Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:21](https://g > `static` **fromSignature**(`sig`): [`CompressedSignature`](CompressedSignature.md) -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/CompressedSignature.ts#L10) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md b/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md index 8027c3b..f3196a2 100644 --- a/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md +++ b/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md @@ -10,7 +10,7 @@ title: DatabasePruneModule # Class: DatabasePruneModule -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/DatabasePruneModule.ts#L16) +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/DatabasePruneModule.ts#L16) Lifecycle of a SequencerModule @@ -26,7 +26,7 @@ start(): Executed to execute any logic required to start the module > **new DatabasePruneModule**(`database`): [`DatabasePruneModule`](DatabasePruneModule.md) -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/DatabasePruneModule.ts#L17) +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/DatabasePruneModule.ts#L17) #### Parameters @@ -63,7 +63,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -131,7 +131,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/DatabasePruneModule.ts#L21) +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/DatabasePruneModule.ts#L21) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md b/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md index 94998ae..8c858d4 100644 --- a/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md @@ -10,7 +10,7 @@ title: DecodedStateSerializer # Class: DecodedStateSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L6) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L6) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Decode > `static` **fromJSON**(`json`): [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L7) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L7) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Decode > `static` **toJSON**(`input`): [`JSONEncodableState`](../type-aliases/JSONEncodableState.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L16) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/DummyStateService.md b/src/pages/docs/reference/sequencer/classes/DummyStateService.md index 800bc7f..5ccef06 100644 --- a/src/pages/docs/reference/sequencer/classes/DummyStateService.md +++ b/src/pages/docs/reference/sequencer/classes/DummyStateService.md @@ -10,7 +10,7 @@ title: DummyStateService # Class: DummyStateService -Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/DummyStateService.ts#L5) +Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/DummyStateService.ts#L5) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:5](https:// > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/DummyStateService.ts#L6) +Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/DummyStateService.ts#L6) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:6](https:// > **set**(`key`, `value`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/state/DummyStateService.ts#L10) +Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/DummyStateService.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md index 7261cec..13bf15d 100644 --- a/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md @@ -10,7 +10,7 @@ title: DynamicProofTaskSerializer # Class: DynamicProofTaskSerializer\ -Defined in: [packages/sequencer/src/helpers/utils.ts:130](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L130) +Defined in: [packages/sequencer/src/helpers/utils.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L130) ## Extends @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:130](https://github.com/pro > **new DynamicProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`DynamicProofTaskSerializer`](DynamicProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> -Defined in: [packages/sequencer/src/helpers/utils.ts:134](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L134) +Defined in: [packages/sequencer/src/helpers/utils.ts:134](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L134) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:134](https://github.com/pro > **fromJSON**(`json`): `Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> -Defined in: [packages/sequencer/src/helpers/utils.ts:142](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L142) +Defined in: [packages/sequencer/src/helpers/utils.ts:142](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L142) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:142](https://github.com/pro > **fromJSONProof**(`jsonProof`): `Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> -Defined in: [packages/sequencer/src/helpers/utils.ts:149](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L149) +Defined in: [packages/sequencer/src/helpers/utils.ts:149](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L149) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:149](https://github.com/pro > `protected` **getDummy**\<`T`\>(`c`, `jsonProof`): `T` -Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L41) +Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L41) #### Type Parameters @@ -124,7 +124,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/prot > **toJSON**(`proof`): `string` -Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L65) +Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L65) #### Parameters @@ -150,7 +150,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/prot > **toJSONProof**(`proof`): `JsonProof` -Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L73) +Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L73) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/Flow.md b/src/pages/docs/reference/sequencer/classes/Flow.md index e095e93..0c7113a 100644 --- a/src/pages/docs/reference/sequencer/classes/Flow.md +++ b/src/pages/docs/reference/sequencer/classes/Flow.md @@ -10,7 +10,7 @@ title: Flow # Class: Flow\ -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L20) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L20) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:20](https://github.com/p > **new Flow**\<`State`\>(`queueImpl`, `flowId`, `state`): [`Flow`](Flow.md)\<`State`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L42) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L42) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:42](https://github.com/p > `readonly` **flowId**: `string` -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L44) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L44) *** @@ -60,7 +60,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:44](https://github.com/p > **state**: `State` -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L45) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L45) *** @@ -68,7 +68,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:45](https://github.com/p > **tasksInProgress**: `number` = `0` -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L40) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L40) ## Methods @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:40](https://github.com/p > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:166](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L166) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:166](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L166) #### Returns @@ -92,7 +92,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:166](https://github.com/ > **forEach**\<`Type`\>(`inputs`, `fun`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:145](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L145) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:145](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L145) #### Type Parameters @@ -118,7 +118,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:145](https://github.com/ > **pushTask**\<`Input`, `Result`\>(`task`, `input`, `completed`?, `overrides`?): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:102](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L102) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:102](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L102) #### Type Parameters @@ -156,7 +156,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:102](https://github.com/ > **reject**(`error`): `void` -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L75) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L75) #### Parameters @@ -174,7 +174,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:75](https://github.com/p > **resolve**\<`Result`\>(`result`): `void` -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L68) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L68) #### Type Parameters @@ -196,7 +196,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:68](https://github.com/p > **withFlow**\<`Result`\>(`executor`): `Promise`\<`Result`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:153](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L153) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:153](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L153) #### Type Parameters diff --git a/src/pages/docs/reference/sequencer/classes/FlowCreator.md b/src/pages/docs/reference/sequencer/classes/FlowCreator.md index b9514fe..bd51322 100644 --- a/src/pages/docs/reference/sequencer/classes/FlowCreator.md +++ b/src/pages/docs/reference/sequencer/classes/FlowCreator.md @@ -10,7 +10,7 @@ title: FlowCreator # Class: FlowCreator -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:178](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L178) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:178](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L178) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:178](https://github.com/ > **new FlowCreator**(`queueImpl`): [`FlowCreator`](FlowCreator.md) -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:179](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L179) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:179](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L179) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:179](https://github.com/ > **createFlow**\<`State`\>(`flowId`, `state`): [`Flow`](Flow.md)\<`State`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:183](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Flow.ts#L183) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L183) #### Type Parameters diff --git a/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md b/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md index f521dc3..5c0f2c3 100644 --- a/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md +++ b/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md @@ -10,7 +10,7 @@ title: FlowTaskWorker # Class: FlowTaskWorker\ -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L15) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L15) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:15](https:// > **new FlowTaskWorker**\<`Tasks`\>(`mq`, `tasks`): [`FlowTaskWorker`](FlowTaskWorker.md)\<`Tasks`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L22) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L22) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:22](https:// > `optional` **preparePromise**: `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L78) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L78) *** @@ -56,7 +56,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:78](https:// > `optional` **prepareResolve**: () => `void` -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L80) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L80) #### Returns @@ -68,7 +68,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:80](https:// > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:165](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L165) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:165](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L165) #### Returns @@ -84,7 +84,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:165](https:/ > **prepareTasks**(`tasks`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L86) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L86) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:86](https:// > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L112) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L112) #### Returns @@ -114,7 +114,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:112](https:/ > **waitForPrepared**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L82) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L82) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md index d4c0f24..83d2dd4 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md @@ -10,7 +10,7 @@ title: InMemoryAsyncMerkleTreeStore # Class: InMemoryAsyncMerkleTreeStore -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L9) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L9) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStor > **commit**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L18) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L18) #### Returns @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStor > **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L26) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L26) #### Parameters @@ -70,7 +70,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStor > **openTransaction**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L22) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L22) #### Returns @@ -86,7 +86,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStor > **writeNodes**(`nodes`): `void` -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L12) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L12) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md index 37da454..80b7468 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md @@ -10,7 +10,7 @@ title: InMemoryBatchStorage # Class: InMemoryBatchStorage -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L9) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L9) ## Implements @@ -33,7 +33,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:9]( > **getBatchAt**(`height`): `Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L18) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L18) #### Parameters @@ -55,7 +55,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:18] > **getCurrentBatchHeight**(): `Promise`\<`number`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L14) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L14) #### Returns @@ -71,7 +71,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:14] > **getLatestBatch**(): `Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L27) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L27) #### Returns @@ -87,7 +87,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:27] > **pushBatch**(`batch`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L22) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L22) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md index d5e5316..e71980b 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md @@ -10,7 +10,7 @@ title: InMemoryBlockStorage # Class: InMemoryBlockStorage -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L18) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L18) ## Implements @@ -24,7 +24,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:18] > **new InMemoryBlockStorage**(`batchStorage`): [`InMemoryBlockStorage`](InMemoryBlockStorage.md) -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L21) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L21) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:21] > **getBlock**(`hash`): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L112) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L112) #### Parameters @@ -64,7 +64,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:112 > **getBlockAt**(`height`): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L29) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L29) #### Parameters @@ -86,7 +86,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:29] > **getCurrentBlockHeight**(): `Promise`\<`number`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L33) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L33) #### Returns @@ -102,7 +102,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:33] > **getLatestBlock**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L52) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L52) #### Returns @@ -118,7 +118,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:52] > **getLatestBlockAndResult**(): `Promise`\<`undefined` \| [`BlockWithMaybeResult`](../interfaces/BlockWithMaybeResult.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L37) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L37) #### Returns @@ -134,7 +134,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:37] > **getNewBlocks**(): `Promise`\<[`BlockWithPreviousResult`](../interfaces/BlockWithPreviousResult.md)[]\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L68) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L68) #### Returns @@ -150,7 +150,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:68] > **getNewestResult**(): `Promise`\<`undefined` \| [`BlockResult`](../interfaces/BlockResult.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:104](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L104) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:104](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L104) #### Returns @@ -162,7 +162,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:104 > **pushBlock**(`block`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:100](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L100) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:100](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L100) #### Parameters @@ -184,7 +184,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:100 > **pushResult**(`result`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:108](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L108) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L108) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md b/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md index 2841907..b6e9bbb 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md @@ -10,7 +10,7 @@ title: InMemoryDatabase # Class: InMemoryDatabase -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L21) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L21) Lifecycle of a SequencerModule @@ -59,7 +59,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -105,7 +105,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L64) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L64) #### Returns @@ -143,7 +143,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): [`StorageDependencyMinimumDependencies`](../interfaces/StorageDependencyMinimumDependencies.md) -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L22) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L22) #### Returns @@ -159,7 +159,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:22](htt > **executeInTransaction**(`f`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:75](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L75) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L75) #### Parameters @@ -181,7 +181,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:75](htt > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L68) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L68) Prunes all data from the database connection. Note: This function should only be called immediately at startup, @@ -201,7 +201,7 @@ everything else will lead to unexpected behaviour and errors > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L60) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L60) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md index c1133a9..6c30be4 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md @@ -10,7 +10,7 @@ title: InMemoryMessageStorage # Class: InMemoryMessageStorage -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L7) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L7) Interface to store Messages previously fetched by a IncomingMessageadapter @@ -34,7 +34,7 @@ Interface to store Messages previously fetched by a IncomingMessageadapter > **getMessages**(`fromMessagesHash`): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L10) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L10) #### Parameters @@ -56,7 +56,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:1 > **pushMessages**(`fromMessagesHash`, `toMessagesHash`, `messages`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L16) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md b/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md index 0256cb1..e3e2723 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md +++ b/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md @@ -10,7 +10,7 @@ title: InMemorySettlementStorage # Class: InMemorySettlementStorage -Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L7) +Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L7) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.t > **settlements**: [`Settlement`](../interfaces/Settlement.md)[] = `[]` -Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L8) +Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L8) ## Methods @@ -40,7 +40,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.t > **pushSettlement**(`settlement`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L10) +Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md index 77392b3..cb96a54 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md @@ -10,7 +10,7 @@ title: InMemoryTransactionStorage # Class: InMemoryTransactionStorage -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L14) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L14) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage. > **new InMemoryTransactionStorage**(`blockStorage`, `batchStorage`): [`InMemoryTransactionStorage`](InMemoryTransactionStorage.md) -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L19) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L19) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage. > **findTransaction**(`hash`): `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](PendingTransaction.md); \}\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L73) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L73) Finds a transaction by its hash. It returns both pending transaction and already included transactions @@ -71,7 +71,7 @@ and batch number where applicable. > **getPendingUserTransactions**(): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L25) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L25) #### Returns @@ -87,7 +87,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage. > **pushUserTransaction**(`tx`): `Promise`\<`boolean`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L46) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L46) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/ListenerList.md b/src/pages/docs/reference/sequencer/classes/ListenerList.md index 1dbb9a2..bdc0ad7 100644 --- a/src/pages/docs/reference/sequencer/classes/ListenerList.md +++ b/src/pages/docs/reference/sequencer/classes/ListenerList.md @@ -10,7 +10,7 @@ title: ListenerList # Class: ListenerList\ -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/ListenerList.ts#L3) +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/ListenerList.ts#L3) ## Type Parameters @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:3](https://gith > **executeListeners**(`payload`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/ListenerList.ts#L15) +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/ListenerList.ts#L15) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:15](https://git > **getListeners**(): `object`[] -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/ListenerList.ts#L11) +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/ListenerList.ts#L11) #### Returns @@ -62,7 +62,7 @@ Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:11](https://git > **pushListener**(`listener`): `number` -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/ListenerList.ts#L22) +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/ListenerList.ts#L22) #### Parameters @@ -80,7 +80,7 @@ Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:22](https://git > **removeListener**(`listenerId`): `void` -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/ListenerList.ts#L34) +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/ListenerList.ts#L34) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md b/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md index c26a568..20c0c17 100644 --- a/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md +++ b/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md @@ -10,7 +10,7 @@ title: LocalTaskQueue # Class: LocalTaskQueue -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L74) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L74) Definition of a connection-object that can generate queues and workers for a specific connection type (e.g. BullMQ, In-memory) @@ -58,7 +58,7 @@ checks when retrieving it via the getter > `readonly` **listeners**: `object` = `{}` -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L92) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L92) #### Index Signature @@ -70,7 +70,7 @@ Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:92](https://g > **queuedTasks**: `object` = `{}` -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L78) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L78) #### Index Signature @@ -82,7 +82,7 @@ Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:78](https://g > `protected` **queues**: `Record`\<`string`, [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> = `{}` -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https:/ > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -140,7 +140,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > `protected` **closeQueues**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) #### Returns @@ -178,7 +178,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `protected` **createOrGetQueue**(`name`, `creator`): [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) #### Parameters @@ -204,7 +204,7 @@ Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https: > **createWorker**(`queueName`, `executor`, `options`?): [`Closeable`](../interfaces/Closeable.md) -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:146](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L146) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:146](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L146) #### Parameters @@ -240,7 +240,7 @@ Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:146](https:// > **getQueue**(`queueName`): `Promise`\<[`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:186](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L186) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:186](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L186) #### Parameters @@ -262,7 +262,7 @@ Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:186](https:// > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:193](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L193) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:193](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L193) Start the module and all it's functionality. The returned Promise has to resolve after initialization, @@ -283,7 +283,7 @@ That means that you mustn't await server.start() for example. > **workNextTasks**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:98](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L98) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L98) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md b/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md index 6785c70..a8645d6 100644 --- a/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md +++ b/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md @@ -10,7 +10,7 @@ title: LocalTaskWorkerModule # Class: LocalTaskWorkerModule\ -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L56) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L56) This module spins up a worker in the current local node instance. This should only be used for local testing/development and not in a @@ -36,7 +36,7 @@ cloud workers. > **new LocalTaskWorkerModule**\<`Tasks`\>(`modules`): [`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L80) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L80) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:80](h > **containerEvents**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<`LocalTaskWorkerModuleEvents`\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L64) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L64) #### Implementation of @@ -101,7 +101,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L62) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L62) #### Implementation of @@ -255,7 +255,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:124](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L124) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:124](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L124) #### Returns @@ -615,7 +615,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:100](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L100) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:100](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L100) Start the module and all it's functionality. The returned Promise has to resolve after initialization, @@ -665,7 +665,7 @@ such as only injecting other known modules. > `static` **from**\<`Tasks`\>(`modules`): [`TypedClass`](../type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\>\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L70) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L70) #### Type Parameters diff --git a/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md b/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md index 80fed30..984cab1 100644 --- a/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md +++ b/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md @@ -10,7 +10,7 @@ title: ManualBlockTrigger # Class: ManualBlockTrigger -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L17) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L17) A BlockTrigger is the primary method to start the production of a block and all associated processes. @@ -29,7 +29,7 @@ all associated processes. > **new ManualBlockTrigger**(`batchProducerModule`, `blockProducerModule`, `settlementModule`, `blockQueue`, `batchStorage`, `settlementStorage`): [`ManualBlockTrigger`](ManualBlockTrigger.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L21) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L21) #### Parameters @@ -71,7 +71,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigg > `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) #### Inherited from @@ -83,7 +83,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) #### Inherited from @@ -95,7 +95,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) #### Inherited from @@ -107,7 +107,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) #### Inherited from @@ -134,7 +134,7 @@ checks when retrieving it via the getter > `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`BlockEvents`](../type-aliases/BlockEvents.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) #### Inherited from @@ -146,7 +146,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) #### Inherited from @@ -158,7 +158,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) #### Inherited from @@ -170,7 +170,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -238,7 +238,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L57) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L57) #### Returns @@ -254,7 +254,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigg > **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L65) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L65) #### Returns @@ -270,7 +270,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigg > **produceBlockAndBatch**(): `Promise`\<\[`undefined` \| [`Block`](../interfaces/Block.md), `undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\]\> -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L50) Produces both an unproven block and immediately produce a settlement block proof @@ -285,7 +285,7 @@ settlement block proof > **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L69) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L69) #### Returns @@ -301,7 +301,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigg > **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L61) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L61) #### Parameters @@ -323,7 +323,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigg > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md b/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md index c6f4b7f..87a5579 100644 --- a/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md +++ b/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md @@ -10,7 +10,7 @@ title: MinaBaseLayer # Class: MinaBaseLayer -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L35) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L35) Lifecycle of a SequencerModule @@ -31,7 +31,7 @@ start(): Executed to execute any logic required to start the module > **new MinaBaseLayer**(`areProofsEnabled`): [`MinaBaseLayer`](MinaBaseLayer.md) -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L43) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L43) #### Parameters @@ -68,7 +68,7 @@ checks when retrieving it via the getter > `optional` **network**: `Mina` -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L39) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L39) *** @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:39](http > `optional` **originalNetwork**: `Mina` -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L41) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L41) *** @@ -84,7 +84,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:41](http > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -152,7 +152,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): `object` -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L50) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L50) #### Returns @@ -192,7 +192,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:50](http > **isLocalBlockChain**(): `boolean` -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L66) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L66) #### Returns @@ -204,7 +204,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:66](http > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:70](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L70) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L70) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md b/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md index d8f58f5..26a7e82 100644 --- a/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md +++ b/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md @@ -10,7 +10,7 @@ title: MinaIncomingMessageAdapter # Class: MinaIncomingMessageAdapter -Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L34) +Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L34) IncomingMessageAdapter implementation for a Mina Baselayer based on decoding L1-dispatched actions @@ -25,7 +25,7 @@ based on decoding L1-dispatched actions > **new MinaIncomingMessageAdapter**(`baseLayer`, `runtime`, `protocol`): [`MinaIncomingMessageAdapter`](MinaIncomingMessageAdapter.md) -Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L35) +Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L35) #### Parameters @@ -51,7 +51,7 @@ Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapt > **getPendingMessages**(`address`, `params`): `Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](PendingTransaction.md)[]; `to`: `string`; \}\> -Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:99](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L99) +Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:99](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L99) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md b/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md index 4a64d02..fe5a772 100644 --- a/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md +++ b/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md @@ -10,7 +10,7 @@ title: MinaSimulationService # Class: MinaSimulationService -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L17) +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L17) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationServic > **new MinaSimulationService**(`baseLayer`): [`MinaSimulationService`](MinaSimulationService.md) -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L18) +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L18) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationServic > **applyTransaction**(`tx`): `void` -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L65) +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L65) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationServic > **updateAccount**(`publicKey`, `tokenId`?): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L41) +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L41) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationServic > **updateNetworkState**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L36) +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L36) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md b/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md index 23e0512..71df160 100644 --- a/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md +++ b/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md @@ -10,7 +10,7 @@ title: MinaTransactionSender # Class: MinaTransactionSender -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L29) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L29) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSende > **new MinaTransactionSender**(`creator`, `provingTask`, `simulator`, `baseLayer`): [`MinaTransactionSender`](MinaTransactionSender.md) -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L39) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L39) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSende > **proveAndSendTransaction**(`transaction`, `waitOnStatus`): `Promise`\<[`EventListenable`](../../common/type-aliases/EventListenable.md)\<[`TxEvents`](../interfaces/TxEvents.md)\>\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:116](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L116) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:116](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L116) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md b/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md index 5d5c114..f6d8689 100644 --- a/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md +++ b/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md @@ -10,7 +10,7 @@ title: MinaTransactionSimulator # Class: MinaTransactionSimulator -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L32) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L32) Custom variant of the ocaml ledger implementation that applies account updates to a ledger state. It isn't feature complete and is mainly used to update the @@ -22,7 +22,7 @@ o1js internal account cache to create batched transactions > **new MinaTransactionSimulator**(`baseLayer`): [`MinaTransactionSimulator`](MinaTransactionSimulator.md) -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L37) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L37) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **apply**(`account`, `au`): `void` -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:247](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L247) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:247](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L247) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **applyFeepayer**(`account`, `feepayer`): `void` -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:242](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L242) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:242](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L242) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **applyTransaction**(`tx`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L86) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L86) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **checkFeePayer**(`account`, `feepayer`): `boolean` -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:199](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L199) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:199](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L199) #### Parameters @@ -124,7 +124,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **checkPreconditions**(`account`, `au`): `string`[] -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:206](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L206) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:206](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L206) #### Parameters @@ -146,7 +146,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **getAccount**(`publicKey`, `tokenId`?): `Promise`\<`Account`\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:142](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L142) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:142](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L142) #### Parameters @@ -168,7 +168,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **getAccounts**(`tx`): `Promise`\<`Account`[]\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L80) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L80) #### Parameters @@ -186,7 +186,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **reloadAccount**(`publicKey`, `tokenId`?): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:163](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L163) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:163](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L163) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md b/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md index c877e6d..5b31327 100644 --- a/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md +++ b/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md @@ -10,7 +10,7 @@ title: NetworkStateQuery # Class: NetworkStateQuery -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L5) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L5) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:5](https: > **new NetworkStateQuery**(`transportModule`): [`NetworkStateQuery`](NetworkStateQuery.md) -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L6) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L6) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:6](https: > **get** **proven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L18) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L18) ##### Returns @@ -52,7 +52,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:18](https > **get** **stagedUnproven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L14) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L14) ##### Returns @@ -66,7 +66,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:14](https > **get** **unproven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L10) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L10) ##### Returns diff --git a/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md index a5329fe..bbbcbde 100644 --- a/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md @@ -10,7 +10,7 @@ title: NewBlockProvingParametersSerializer # Class: NewBlockProvingParametersSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L38) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L38) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlo > **new NewBlockProvingParametersSerializer**(`stProofSerializer`, `blockProofSerializer`): [`NewBlockProvingParametersSerializer`](NewBlockProvingParametersSerializer.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L41) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L41) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlo > **fromJSON**(`json`): `Promise`\<`NewBlockPayload`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L73) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L73) #### Parameters @@ -66,7 +66,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlo > **toJSON**(`input`): `string` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L52) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L52) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/NewBlockTask.md b/src/pages/docs/reference/sequencer/classes/NewBlockTask.md index 2ae7892..f72a98c 100644 --- a/src/pages/docs/reference/sequencer/classes/NewBlockTask.md +++ b/src/pages/docs/reference/sequencer/classes/NewBlockTask.md @@ -10,7 +10,7 @@ title: NewBlockTask # Class: NewBlockTask -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L45) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new NewBlockTask**(`protocol`, `executionContext`, `compileRegistry`): [`NewBlockTask`](NewBlockTask.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L55) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L55) #### Parameters @@ -73,7 +73,7 @@ checks when retrieving it via the getter > `readonly` **name**: `"newBlock"` = `"newBlock"` -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L53) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L53) #### Implementation of @@ -119,7 +119,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<`BlockProof`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:105](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L105) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L105) #### Parameters @@ -163,7 +163,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L66) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L66) #### Returns @@ -179,7 +179,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:66 > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:129](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L129) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L129) #### Returns @@ -195,7 +195,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:12 > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`BlockProof`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:81](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L81) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L81) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md b/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md index b0cb5b4..b2a052a 100644 --- a/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md +++ b/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md @@ -10,7 +10,7 @@ title: NoopBaseLayer # Class: NoopBaseLayer -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L53) +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L53) Lifecycle of a SequencerModule @@ -59,7 +59,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -105,7 +105,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **blockProduced**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L54) +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L54) #### Returns @@ -139,7 +139,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): [`BaseLayerDependencyRecord`](../interfaces/BaseLayerDependencyRecord.md) -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L62) +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L62) #### Returns @@ -155,7 +155,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:62](http > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L58) +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L58) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md index 0940458..cfdadcb 100644 --- a/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md @@ -10,7 +10,7 @@ title: PairProofTaskSerializer # Class: PairProofTaskSerializer\ -Defined in: [packages/sequencer/src/helpers/utils.ts:164](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L164) +Defined in: [packages/sequencer/src/helpers/utils.ts:164](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L164) ## Type Parameters @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:164](https://github.com/pro > **new PairProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`PairProofTaskSerializer`](PairProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> -Defined in: [packages/sequencer/src/helpers/utils.ts:170](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L170) +Defined in: [packages/sequencer/src/helpers/utils.ts:170](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L170) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:170](https://github.com/pro > **fromJSON**(`json`): `Promise`\<[`PairTuple`](../type-aliases/PairTuple.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\>\> -Defined in: [packages/sequencer/src/helpers/utils.ts:176](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L176) +Defined in: [packages/sequencer/src/helpers/utils.ts:176](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L176) #### Parameters @@ -68,7 +68,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:176](https://github.com/pro > **toJSON**(`input`): `string` -Defined in: [packages/sequencer/src/helpers/utils.ts:187](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L187) +Defined in: [packages/sequencer/src/helpers/utils.ts:187](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L187) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/PendingTransaction.md b/src/pages/docs/reference/sequencer/classes/PendingTransaction.md index f7dbfb3..a358c76 100644 --- a/src/pages/docs/reference/sequencer/classes/PendingTransaction.md +++ b/src/pages/docs/reference/sequencer/classes/PendingTransaction.md @@ -10,7 +10,7 @@ title: PendingTransaction # Class: PendingTransaction -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:123](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L123) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:123](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L123) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:123](https://g > **new PendingTransaction**(`data`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:140](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L140) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:140](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L140) #### Parameters @@ -70,7 +70,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:140](https://g > **argsFields**: `Field`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L37) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L37) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://gi > **auxiliaryData**: `string`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L39) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L39) Used to transport non-provable data, mainly proof data for now These values will not be part of the signature message or transaction hash @@ -97,7 +97,7 @@ These values will not be part of the signature message or transaction hash > **isMessage**: `boolean` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L41) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L41) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://gi > **methodId**: `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L31) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L31) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://gi > **nonce**: `UInt64` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L33) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L33) #### Inherited from @@ -133,7 +133,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://gi > **sender**: `PublicKey` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L35) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L35) #### Inherited from @@ -145,7 +145,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://gi > **signature**: `Signature` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:138](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L138) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:138](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L138) ## Methods @@ -153,7 +153,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:138](https://g > **argsHash**(): `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L59) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L59) #### Returns @@ -169,7 +169,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://gi > **getSignatureData**(): `Field`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L72) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L72) #### Returns @@ -185,7 +185,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://gi > **hash**(): `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L63) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L63) #### Returns @@ -201,7 +201,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://gi > **sign**(`privateKey`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L80) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L80) #### Parameters @@ -223,7 +223,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://gi > **signed**(`signature`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L95) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L95) #### Parameters @@ -245,7 +245,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://gi > **toJSON**(): `PendingTransactionJSONType` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:153](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L153) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:153](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L153) #### Returns @@ -257,7 +257,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:153](https://g > **toProtocolTransaction**(): [`SignedTransaction`](../../protocol/classes/SignedTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:171](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L171) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:171](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L171) #### Returns @@ -269,7 +269,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:171](https://g > **toRuntimeTransaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L85) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L85) #### Returns @@ -285,7 +285,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://gi > `static` **fromJSON**(`object`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:124](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L124) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:124](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L124) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md b/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md index 8efb0a3..34fecc1 100644 --- a/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md +++ b/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md @@ -10,7 +10,7 @@ title: PreFilledStateService # Class: PreFilledStateService -Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L4) +Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L4) Naive implementation of an in-memory variant of the StateService interface @@ -24,7 +24,7 @@ Naive implementation of an in-memory variant of the StateService interface > **new PreFilledStateService**(`values`): [`PreFilledStateService`](PreFilledStateService.md) -Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L5) +Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L5) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/PrivateMempool.md b/src/pages/docs/reference/sequencer/classes/PrivateMempool.md index 216903f..1c98fde 100644 --- a/src/pages/docs/reference/sequencer/classes/PrivateMempool.md +++ b/src/pages/docs/reference/sequencer/classes/PrivateMempool.md @@ -10,7 +10,7 @@ title: PrivateMempool # Class: PrivateMempool -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L36) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L36) Lifecycle of a SequencerModule @@ -30,7 +30,7 @@ start(): Executed to execute any logic required to start the module > **new PrivateMempool**(`transactionValidator`, `transactionStorage`, `protocol`, `sequencer`, `stateService`): [`PrivateMempool`](PrivateMempool.md) -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L41) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L41) #### Parameters @@ -83,7 +83,7 @@ checks when retrieving it via the getter > `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`MempoolEvents`](../type-aliases/MempoolEvents.md)\> -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L37) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L37) #### Implementation of @@ -95,7 +95,7 @@ Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:37](https: > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -141,7 +141,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **add**(`tx`): `Promise`\<`boolean`\> -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L57) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L57) Add a transaction to the mempool @@ -189,7 +189,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **getStagedNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:91](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L91) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:91](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L91) #### Returns @@ -201,7 +201,7 @@ Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:91](https: > **getTxs**(`limit`?): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:96](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L96) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:96](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L96) Retrieve all transactions that are currently in the mempool @@ -225,7 +225,7 @@ Retrieve all transactions that are currently in the mempool > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:200](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/private/PrivateMempool.ts#L200) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:200](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L200) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md index 8d818c9..9fdd6dd 100644 --- a/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md @@ -10,7 +10,7 @@ title: ProofTaskSerializer # Class: ProofTaskSerializer\ -Defined in: [packages/sequencer/src/helpers/utils.ts:100](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L100) +Defined in: [packages/sequencer/src/helpers/utils.ts:100](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L100) ## Extends @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:100](https://github.com/pro > **new ProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`ProofTaskSerializer`](ProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> -Defined in: [packages/sequencer/src/helpers/utils.ts:104](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L104) +Defined in: [packages/sequencer/src/helpers/utils.ts:104](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L104) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:104](https://github.com/pro > **fromJSON**(`json`): `Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> -Defined in: [packages/sequencer/src/helpers/utils.ts:112](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L112) +Defined in: [packages/sequencer/src/helpers/utils.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L112) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:112](https://github.com/pro > **fromJSONProof**(`jsonProof`): `Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> -Defined in: [packages/sequencer/src/helpers/utils.ts:119](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L119) +Defined in: [packages/sequencer/src/helpers/utils.ts:119](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L119) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:119](https://github.com/pro > `protected` **getDummy**\<`T`\>(`c`, `jsonProof`): `T` -Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L41) +Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L41) #### Type Parameters @@ -124,7 +124,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/prot > **toJSON**(`proof`): `string` -Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L65) +Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L65) #### Parameters @@ -150,7 +150,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/prot > **toJSONProof**(`proof`): `JsonProof` -Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L73) +Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L73) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md b/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md index 121012f..4f8d305 100644 --- a/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md +++ b/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md @@ -10,7 +10,7 @@ title: ProvenSettlementPermissions # Class: ProvenSettlementPermissions -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L5) +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L5) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermi > **bridgeContractMina**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L35) +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L35) #### Returns @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermi > **bridgeContractToken**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L39) +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L39) #### Returns @@ -64,7 +64,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermi > **dispatchContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L31) +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L31) #### Returns @@ -80,7 +80,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermi > **settlementContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L27) +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L27) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md b/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md index 931dda9..915fbf7 100644 --- a/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md +++ b/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md @@ -10,7 +10,7 @@ title: ReductionTaskFlow # Class: ReductionTaskFlow\ -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L30) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L30) This class builds and executes a flow that follows the map-reduce pattern. This works in 2 steps: @@ -31,7 +31,7 @@ We use this pattern extensively in our pipeline, > **new ReductionTaskFlow**\<`Input`, `Output`\>(`options`, `flowCreator`): [`ReductionTaskFlow`](ReductionTaskFlow.md)\<`Input`, `Output`\> -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L37) #### Parameters @@ -71,7 +71,7 @@ Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.t > **deferErrorsTo**(`flow`): `void` -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:184](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L184) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:184](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L184) To be used in conjunction with onCompletion It allows errors from this flow to be "defered" to another parent @@ -94,7 +94,7 @@ error up to the user > **execute**(`inputs`): `Promise`\<`Output`\> -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:193](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L193) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:193](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L193) Execute the flow using the returned Promise that resolved when the flow is finished @@ -117,7 +117,7 @@ initial inputs - doesnt have to be the complete set of inputs > **onCompletion**(`callback`): `void` -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:173](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L173) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:173](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L173) Execute the flow using a callback method that is invoked upon completion of the flow. @@ -139,7 +139,7 @@ Push inputs using pushInput() > **pushInput**(`input`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:205](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L205) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:205](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L205) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md index 837a73f..6b09075 100644 --- a/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md @@ -10,7 +10,7 @@ title: RuntimeProofParametersSerializer # Class: RuntimeProofParametersSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L11) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L11) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Runtim > **fromJSON**(`json`): [`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L29) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L29) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Runtim > **toJSON**(`parameters`): `string` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L14) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L14) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md b/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md index 8394d97..acf2bf7 100644 --- a/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md +++ b/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md @@ -10,7 +10,7 @@ title: RuntimeProvingTask # Class: RuntimeProvingTask -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L36) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L36) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new RuntimeProvingTask**(`runtime`, `executionContext`, `compileRegistry`): [`RuntimeProvingTask`](RuntimeProvingTask.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L45) #### Parameters @@ -73,7 +73,7 @@ checks when retrieving it via the getter > **name**: `string` = `"runtimeProof"` -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L43) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L43) #### Implementation of @@ -85,7 +85,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > `protected` `readonly` **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<`never`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L46) *** @@ -93,7 +93,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > `protected` `readonly` **runtimeZkProgrammable**: [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\>[] -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L40) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L40) ## Accessors @@ -135,7 +135,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<`RuntimeProof`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L61) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L61) #### Parameters @@ -179,7 +179,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L53) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L53) #### Returns @@ -195,7 +195,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:107](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L107) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:107](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L107) #### Returns @@ -211,7 +211,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`RuntimeProof`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L57) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L57) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md b/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md index 199ebb2..5d20627 100644 --- a/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md @@ -10,7 +10,7 @@ title: RuntimeVerificationKeyAttestationSerializer # Class: RuntimeVerificationKeyAttestationSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L9) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L9) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Runtim > `static` **fromJSON**(`json`): [`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L10) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L10) #### Parameters @@ -68,7 +68,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Runtim > `static` **toJSON**(`attestation`): `object` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L20) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L20) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/Sequencer.md b/src/pages/docs/reference/sequencer/classes/Sequencer.md index c63c90a..bf7c469 100644 --- a/src/pages/docs/reference/sequencer/classes/Sequencer.md +++ b/src/pages/docs/reference/sequencer/classes/Sequencer.md @@ -10,7 +10,7 @@ title: Sequencer # Class: Sequencer\ -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L30) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L30) Reusable module container facilitating registration, resolution configuration, decoration and validation of modules @@ -136,7 +136,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 > **get** **dependencyContainer**(): `DependencyContainer` -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L61) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L61) ##### Returns @@ -188,7 +188,7 @@ list of module names > **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L53) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L53) ##### Returns @@ -202,7 +202,7 @@ Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:53](https:// > **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L49) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L49) ##### Returns @@ -262,7 +262,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:125](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L125) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:125](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L125) #### Returns @@ -618,7 +618,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L69) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L69) Starts the sequencer by iterating over all provided modules to start each @@ -666,7 +666,7 @@ such as only injecting other known modules. > `static` **from**\<`Modules`\>(`definition`): [`TypedClass`](../type-aliases/TypedClass.md)\<[`Sequencer`](Sequencer.md)\<`Modules`\>\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L39) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L39) Alternative constructor for Sequencer diff --git a/src/pages/docs/reference/sequencer/classes/SequencerModule.md b/src/pages/docs/reference/sequencer/classes/SequencerModule.md index e25be11..10527cd 100644 --- a/src/pages/docs/reference/sequencer/classes/SequencerModule.md +++ b/src/pages/docs/reference/sequencer/classes/SequencerModule.md @@ -10,7 +10,7 @@ title: SequencerModule # Class: `abstract` SequencerModule\ -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L15) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L15) Lifecycle of a SequencerModule @@ -79,7 +79,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) ## Accessors @@ -143,7 +143,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `abstract` **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md b/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md index 456b31e..509cc65 100644 --- a/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md +++ b/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md @@ -10,7 +10,7 @@ title: SequencerStartupModule # Class: SequencerStartupModule -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L28) +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L28) Lifecycle of a SequencerModule @@ -30,7 +30,7 @@ start(): Executed to execute any logic required to start the module > **new SequencerStartupModule**(`flowCreator`, `protocol`, `compileTask`, `verificationKeyService`, `registrationFlow`, `compileRegistry`): [`SequencerStartupModule`](SequencerStartupModule.md) -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L32) +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L32) #### Parameters @@ -87,7 +87,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -133,7 +133,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:153](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L153) +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:153](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L153) #### Returns @@ -149,7 +149,7 @@ Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:153](htt > **compileRuntime**(`flow`): `Promise`\<`bigint`\> -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L55) +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L55) #### Parameters @@ -189,7 +189,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:122](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L122) +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L122) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/SettlementModule.md b/src/pages/docs/reference/sequencer/classes/SettlementModule.md index e222860..923233e 100644 --- a/src/pages/docs/reference/sequencer/classes/SettlementModule.md +++ b/src/pages/docs/reference/sequencer/classes/SettlementModule.md @@ -10,7 +10,7 @@ title: SettlementModule # Class: SettlementModule -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L62) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L62) Lifecycle of a SequencerModule @@ -31,7 +31,7 @@ start(): Executed to execute any logic required to start the module > **new SettlementModule**(`baseLayer`, `protocol`, `incomingMessagesAdapter`, `messageStorage`, `blockProofSerializer`, `transactionSender`, `areProofsEnabled`, `feeStrategy`, `settlementStartupModule`): [`SettlementModule`](SettlementModule.md) -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:86](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L86) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L86) #### Parameters @@ -85,7 +85,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:86](https://g > `optional` **addresses**: `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L71) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L71) #### dispatch @@ -101,7 +101,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:71](https://g > `protected` `optional` **contracts**: `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L66) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L66) #### dispatch @@ -132,7 +132,7 @@ checks when retrieving it via the getter > **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`SettlementModuleEvents`](../type-aliases/SettlementModuleEvents.md)\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L84) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L84) #### Implementation of @@ -144,7 +144,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:84](https://g > `optional` **keys**: `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L76) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L76) #### dispatch @@ -164,7 +164,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:76](https://g > **utils**: `SettlementUtils` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:82](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L82) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L82) *** @@ -172,7 +172,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:82](https://g > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -240,7 +240,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:106](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L106) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:106](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L106) #### Returns @@ -264,7 +264,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:106](https:// > **deploy**(`settlementKey`, `dispatchKey`, `minaBridgeKey`, `options`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:243](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L243) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:243](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L243) #### Parameters @@ -296,7 +296,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:243](https:// > **deployTokenBridge**(`owner`, `ownerKey`, `contractKey`, `options`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:343](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L343) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:343](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L343) #### Parameters @@ -328,7 +328,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:343](https:// > **getContracts**(): `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:127](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L127) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:127](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L127) #### Returns @@ -348,7 +348,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:127](https:// > **settleBatch**(`batch`, `options`): `Promise`\<[`Settlement`](../interfaces/Settlement.md)\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:164](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L164) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:164](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L164) #### Parameters @@ -372,7 +372,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:164](https:// > `protected` **settlementContractModule**(): [`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md)\<[`MandatorySettlementModulesRecord`](../../protocol/type-aliases/MandatorySettlementModulesRecord.md)\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L114) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L114) #### Returns @@ -384,7 +384,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:114](https:// > **signTransaction**(`tx`, `pks`): `Transaction`\<`false`, `true`\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:149](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L149) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:149](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L149) #### Parameters @@ -406,7 +406,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:149](https:// > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:387](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L387) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:387](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L387) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md b/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md index f3301cc..c2b38ba 100644 --- a/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md +++ b/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md @@ -10,7 +10,7 @@ title: SettlementProvingTask # Class: SettlementProvingTask -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L72) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L72) Implementation of a task to prove any Mina transaction. The o1js-internal account state is configurable via the task args. @@ -31,7 +31,7 @@ the provided AccountUpdate > **new SettlementProvingTask**(`protocol`, `compileRegistry`, `areProofsEnabled`): [`SettlementProvingTask`](SettlementProvingTask.md) -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:84](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L84) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L84) #### Parameters @@ -76,7 +76,7 @@ checks when retrieving it via the getter > **name**: `string` = `"settlementTransactions"` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:76](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L76) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L76) #### Implementation of @@ -88,7 +88,7 @@ Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:76 > **settlementContractModule**: `undefined` \| [`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md)\<[`MandatorySettlementModulesRecord`](../../protocol/type-aliases/MandatorySettlementModulesRecord.md)\> = `undefined` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L78) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L78) ## Accessors @@ -130,7 +130,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:125](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L125) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:125](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L125) #### Parameters @@ -174,7 +174,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskArgs`](../type-aliases/TransactionTaskArgs.md)\> -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:158](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L158) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:158](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L158) #### Returns @@ -190,7 +190,7 @@ Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:15 > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:395](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L395) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:395](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L395) #### Returns @@ -206,7 +206,7 @@ Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:39 > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:432](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L432) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:432](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L432) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md b/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md index b68c400..aa66c28 100644 --- a/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md +++ b/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md @@ -10,7 +10,7 @@ title: SignedSettlementPermissions # Class: SignedSettlementPermissions -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L5) +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L5) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermi > **bridgeContractMina**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L28) +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L28) #### Returns @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermi > **bridgeContractToken**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L32) +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L32) #### Returns @@ -64,7 +64,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermi > **dispatchContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L20) +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L20) #### Returns @@ -80,7 +80,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermi > **settlementContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L24) +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L24) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md b/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md index 362a97d..e4a83bc 100644 --- a/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md +++ b/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md @@ -10,7 +10,7 @@ title: SomeProofSubclass # Class: SomeProofSubclass -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L58) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L58) ## Extends @@ -118,7 +118,7 @@ Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:92 > `static` **publicInputType**: *typeof* `Field` & (`x`) => `Field` = `Field` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L59) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L59) #### Overrides @@ -130,7 +130,7 @@ Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:59 > `static` **publicOutputType**: `ProvablePureExtended`\<`void`, `void`, `null`\> = `Void` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L61) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L61) #### Overrides diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md index b9bcd66..4580b04 100644 --- a/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md @@ -10,7 +10,7 @@ title: StateTransitionParametersSerializer # Class: StateTransitionParametersSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L21) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L21) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateT > **fromJSON**(`json`): [`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L43) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L43) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateT > **toJSON**(`parameters`): `string` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L24) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L24) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md b/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md index fae1607..3fc33c9 100644 --- a/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md +++ b/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md @@ -10,7 +10,7 @@ title: StateTransitionReductionTask # Class: StateTransitionReductionTask -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L24) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L24) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new StateTransitionReductionTask**(`protocol`, `executionContext`, `compileRegistry`): [`StateTransitionReductionTask`](StateTransitionReductionTask.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L32) #### Parameters @@ -73,7 +73,7 @@ checks when retrieving it via the getter > **name**: `string` = `"stateTransitionReduction"` -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L30) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L30) #### Implementation of @@ -85,7 +85,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionRed > `protected` `readonly` **stateTransitionProver**: [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L28) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L28) ## Accessors @@ -127,7 +127,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L56) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L56) #### Parameters @@ -171,7 +171,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\>\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L44) #### Returns @@ -187,7 +187,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionRed > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L66) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L66) #### Returns @@ -203,7 +203,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionRed > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L50) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md b/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md index c503c80..3e63e5e 100644 --- a/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md +++ b/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md @@ -10,7 +10,7 @@ title: StateTransitionTask # Class: StateTransitionTask -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L38) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L38) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new StateTransitionTask**(`protocol`, `executionContext`, `compileRegistry`): [`StateTransitionTask`](StateTransitionTask.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L46) #### Parameters @@ -73,7 +73,7 @@ checks when retrieving it via the getter > **name**: `string` = `"stateTransitionProof"` -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L44) #### Implementation of @@ -85,7 +85,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > `protected` `readonly` **stateTransitionProver**: [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L42) ## Accessors @@ -127,7 +127,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L68) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L68) #### Parameters @@ -171,7 +171,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L58) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L58) #### Returns @@ -187,7 +187,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:88](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L88) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L88) #### Returns @@ -203,7 +203,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:62](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L62) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L62) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md index d0aba48..4f76ee8 100644 --- a/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md +++ b/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md @@ -10,7 +10,7 @@ title: SyncCachedMerkleTreeStore # Class: SyncCachedMerkleTreeStore -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L7) +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L7) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:7] > **new SyncCachedMerkleTreeStore**(`parent`): [`SyncCachedMerkleTreeStore`](SyncCachedMerkleTreeStore.md) -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L8) +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L8) #### Parameters @@ -60,7 +60,7 @@ Defined in: packages/common/dist/trees/InMemoryMerkleTreeStorage.d.ts:3 > **getNode**(`key`, `level`): `undefined` \| `bigint` -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L12) +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L12) #### Parameters @@ -86,7 +86,7 @@ Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:12 > **mergeIntoParent**(): `void` -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L20) +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L20) #### Returns @@ -98,7 +98,7 @@ Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:20 > **setNode**(`key`, `level`, `value`): `void` -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L16) +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md b/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md index 10f6278..4159e7b 100644 --- a/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md +++ b/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md @@ -10,7 +10,7 @@ title: TaskWorkerModule # Class: `abstract` TaskWorkerModule -Defined in: [packages/sequencer/src/worker/worker/TaskWorkerModule.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/TaskWorkerModule.ts#L3) +Defined in: [packages/sequencer/src/worker/worker/TaskWorkerModule.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/TaskWorkerModule.ts#L3) Used by various module sub-types that may need to be configured diff --git a/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md b/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md index 18a69ee..bbfbd40 100644 --- a/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md +++ b/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md @@ -10,7 +10,7 @@ title: TimedBlockTrigger # Class: TimedBlockTrigger -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L36) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L36) A BlockTrigger is the primary method to start the production of a block and all associated processes. @@ -30,7 +30,7 @@ all associated processes. > **new TimedBlockTrigger**(`batchProducerModule`, `blockProducerModule`, `settlementModule`, `blockQueue`, `batchStorage`, `settlementStorage`, `mempool`): [`TimedBlockTrigger`](TimedBlockTrigger.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L44) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) #### Inherited from @@ -139,7 +139,7 @@ checks when retrieving it via the getter > `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`TimedBlockTriggerEvent`](../interfaces/TimedBlockTriggerEvent.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) #### Inherited from @@ -151,7 +151,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) #### Inherited from @@ -163,7 +163,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) #### Inherited from @@ -175,7 +175,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -221,7 +221,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:137](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L137) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:137](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L137) #### Returns @@ -259,7 +259,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `protected` **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) #### Returns @@ -275,7 +275,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) #### Returns @@ -291,7 +291,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) #### Returns @@ -307,7 +307,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) #### Parameters @@ -329,7 +329,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:90](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L90) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:90](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L90) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md b/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md index 2abd21a..b11d26a 100644 --- a/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md +++ b/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md @@ -10,7 +10,7 @@ title: TransactionExecutionService # Class: TransactionExecutionService -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:153](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L153) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:153](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L153) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionEx > **new TransactionExecutionService**(`runtime`, `protocol`, `stateServiceProvider`): [`TransactionExecutionService`](TransactionExecutionService.md) -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:156](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L156) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:156](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L156) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionEx > **createExecutionTrace**(`asyncStateService`, `tx`, `networkState`): `Promise`\<[`TransactionExecutionResult`](../interfaces/TransactionExecutionResult.md)\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:209](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L209) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:209](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L209) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md b/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md index 736b97a..6b4467e 100644 --- a/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md +++ b/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md @@ -10,7 +10,7 @@ title: TransactionProvingTask # Class: TransactionProvingTask -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L50) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new TransactionProvingTask**(`protocol`, `runtime`, `stateServiceProvider`, `executionContext`, `compileRegistry`): [`TransactionProvingTask`](TransactionProvingTask.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L63) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L63) #### Parameters @@ -81,7 +81,7 @@ checks when retrieving it via the getter > **name**: `string` = `"block"` -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L61) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L61) #### Implementation of @@ -127,7 +127,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:114](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L114) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L114) #### Parameters @@ -171,7 +171,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:79](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L79) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L79) #### Returns @@ -187,7 +187,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:144](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L144) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L144) #### Returns @@ -203,7 +203,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:92](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L92) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L92) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md b/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md index 738d832..2e3f5a9 100644 --- a/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md @@ -10,7 +10,7 @@ title: TransactionProvingTaskParameterSerializer # Class: TransactionProvingTaskParameterSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L18) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L18) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Transa > **new TransactionProvingTaskParameterSerializer**(`stProofSerializer`, `runtimeProofSerializer`): [`TransactionProvingTaskParameterSerializer`](TransactionProvingTaskParameterSerializer.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L21) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L21) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Transa > **fromJSON**(`json`): `Promise`\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L57) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L57) #### Parameters @@ -66,7 +66,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Transa > **toJSON**(`input`): `string` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L32) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md b/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md index 555f2db..673f3cd 100644 --- a/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md +++ b/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md @@ -10,7 +10,7 @@ title: TransactionTraceService # Class: TransactionTraceService -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L36) +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L36) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService. > **createBlockTrace**(`traces`, `stateServices`, `blockHashTreeStore`, `beforeBlockStateRoot`, `block`): `Promise`\<[`BlockTrace`](../interfaces/BlockTrace.md)\> -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L78) +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L78) #### Parameters @@ -68,7 +68,7 @@ Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService. > **createTransactionTrace**(`executionResult`, `stateServices`, `verificationKeyService`, `networkState`, `bundleTracker`, `eternalBundleTracker`, `messageTracker`): `Promise`\<[`TransactionTrace`](../interfaces/TransactionTrace.md)\> -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:172](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L172) +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:172](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L172) What is in a trace? A trace has two parts: diff --git a/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md b/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md index b3e07b4..db073f7 100644 --- a/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md +++ b/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md @@ -10,7 +10,7 @@ title: UnsignedTransaction # Class: UnsignedTransaction -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L30) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L30) ## Extended by @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:30](https://gi > **new UnsignedTransaction**(`data`): [`UnsignedTransaction`](UnsignedTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L43) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L43) #### Parameters @@ -66,7 +66,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:43](https://gi > **argsFields**: `Field`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L37) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L37) #### Implementation of @@ -78,7 +78,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://gi > **auxiliaryData**: `string`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L39) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L39) Used to transport non-provable data, mainly proof data for now These values will not be part of the signature message or transaction hash @@ -93,7 +93,7 @@ These values will not be part of the signature message or transaction hash > **isMessage**: `boolean` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L41) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L41) #### Implementation of @@ -105,7 +105,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://gi > **methodId**: `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L31) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L31) #### Implementation of @@ -117,7 +117,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://gi > **nonce**: `UInt64` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L33) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L33) #### Implementation of @@ -129,7 +129,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://gi > **sender**: `PublicKey` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L35) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L35) #### Implementation of @@ -141,7 +141,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://gi > **argsHash**(): `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L59) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L59) #### Returns @@ -153,7 +153,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://gi > **getSignatureData**(): `Field`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L72) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L72) #### Returns @@ -165,7 +165,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://gi > **hash**(): `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L63) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L63) #### Returns @@ -177,7 +177,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://gi > **sign**(`privateKey`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L80) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L80) #### Parameters @@ -195,7 +195,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://gi > **signed**(`signature`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L95) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L95) #### Parameters @@ -213,7 +213,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://gi > **toRuntimeTransaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L85) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L85) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/UntypedOption.md b/src/pages/docs/reference/sequencer/classes/UntypedOption.md index 3dc282a..d81c8cd 100644 --- a/src/pages/docs/reference/sequencer/classes/UntypedOption.md +++ b/src/pages/docs/reference/sequencer/classes/UntypedOption.md @@ -10,7 +10,7 @@ title: UntypedOption # Class: UntypedOption -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L7) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L7) Option facilitating in-circuit values that may or may not exist. @@ -24,7 +24,7 @@ Option facilitating in-circuit values that may or may not exist. > **new UntypedOption**(`isSome`, `value`, `enforceEmpty`): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L32) #### Parameters @@ -78,7 +78,7 @@ Defined in: packages/protocol/dist/model/Option.d.ts:59 > **value**: `Field`[] -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L34) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L34) ## Accessors @@ -106,7 +106,7 @@ Tree representation of the current value > **clone**(): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L40) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L40) #### Returns @@ -122,7 +122,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts > `protected` **encodeValueToFields**(): `Field`[] -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L44) #### Returns @@ -219,7 +219,7 @@ Provable representation of the current option. > `static` **fromJSON**(`__namedParameters`): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L16) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L16) #### Parameters @@ -247,7 +247,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts > `static` **fromOption**\<`Value`\>(`option`): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L8) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L8) #### Type Parameters diff --git a/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md b/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md index 9482e13..6f0e0e8 100644 --- a/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md +++ b/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md @@ -10,7 +10,7 @@ title: UntypedStateTransition # Class: UntypedStateTransition -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L10) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L10) Generic state transition that constraints the current method circuit to external state, by providing a state anchor. @@ -21,7 +21,7 @@ to external state, by providing a state anchor. > **new UntypedStateTransition**(`path`, `fromValue`, `toValue`): [`UntypedStateTransition`](UntypedStateTransition.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L35) #### Parameters @@ -47,7 +47,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **fromValue**: [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L37) *** @@ -55,7 +55,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **path**: `Field` -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L36) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L36) *** @@ -63,7 +63,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **toValue**: [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L38) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L38) ## Accessors @@ -73,7 +73,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **get** **from**(): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L41) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L41) ##### Returns @@ -87,7 +87,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **get** **to**(): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:47](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L47) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L47) ##### Returns @@ -99,7 +99,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **toJSON**(): `object` -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:63](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L63) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L63) #### Returns @@ -147,7 +147,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **toProvable**(): [`ProvableStateTransition`](../../protocol/classes/ProvableStateTransition.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L55) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L55) Converts a StateTransition to a ProvableStateTransition, while enforcing the 'from' property to be 'Some' in all cases. @@ -162,7 +162,7 @@ while enforcing the 'from' property to be 'Some' in all cases. > `static` **fromJSON**(`__namedParameters`): [`UntypedStateTransition`](UntypedStateTransition.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L19) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L19) #### Parameters @@ -214,7 +214,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > `static` **fromStateTransition**\<`Value`\>(`st`): [`UntypedStateTransition`](UntypedStateTransition.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L11) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L11) #### Type Parameters diff --git a/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md b/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md index 33d1fe8..f0b26ce 100644 --- a/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md +++ b/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md @@ -10,7 +10,7 @@ title: VanillaTaskWorkerModules # Class: VanillaTaskWorkerModules -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:131](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L131) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:131](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L131) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:131]( > `static` **allTasks**(): `object` -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:145](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L145) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:145](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L145) #### Returns @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:145]( > `static` **defaultConfig**(): `object` -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:152](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L152) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:152](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L152) #### Returns @@ -128,7 +128,7 @@ Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:152]( > `static` **withoutSettlement**(): `object` -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:132](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L132) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L132) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md b/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md index 9dad882..1862af7 100644 --- a/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md +++ b/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md @@ -10,7 +10,7 @@ title: VerificationKeySerializer # Class: VerificationKeySerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L5) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L5) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Verifi > `static` **fromJSON**(`json`): `VerificationKey` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L13) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L13) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Verifi > `static` **toJSON**(`verificationKey`): [`VerificationKeyJSON`](../type-aliases/VerificationKeyJSON.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L6) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L6) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md b/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md index 3853456..ed160d8 100644 --- a/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md +++ b/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md @@ -10,7 +10,7 @@ title: WithdrawalEvent # Class: WithdrawalEvent -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L24) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L24) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L25) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L25) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:25](h > **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L26) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L26) #### Inherited from diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md b/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md index d1c5bed..dd5d933 100644 --- a/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md +++ b/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md @@ -10,7 +10,7 @@ title: WithdrawalKey # Class: WithdrawalKey -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L19) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L19) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **index**: `Field` = `Field` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L20) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L20) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:20](h > **tokenId**: `Field` = `Field` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L21) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L21) #### Inherited from diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md b/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md index 2897488..a9628c5 100644 --- a/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md +++ b/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md @@ -10,7 +10,7 @@ title: WithdrawalQueue # Class: WithdrawalQueue -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L44) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L44) This interface allows the SettlementModule to retrieve information about pending L2-dispatched (outgoing) messages that it can then use to roll @@ -33,7 +33,7 @@ outgoing message type is not limited to Withdrawals > **new WithdrawalQueue**(`sequencer`): [`WithdrawalQueue`](WithdrawalQueue.md) -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L54) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L54) #### Parameters @@ -70,7 +70,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -138,7 +138,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **length**(): `number` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:74](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L74) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L74) #### Returns @@ -154,7 +154,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:74](h > **peek**(`num`): [`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L64) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L64) #### Parameters @@ -176,7 +176,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:64](h > **pop**(`num`): [`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:68](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L68) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L68) #### Parameters @@ -198,7 +198,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:68](h > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:78](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L78) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L78) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md b/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md index 2965cff..d6e156b 100644 --- a/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md +++ b/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md @@ -10,7 +10,7 @@ title: WorkerReadyModule # Class: WorkerReadyModule -Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L11) +Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L11) Module to safely wait for the finish of the worker startup Behaves like a noop for non-worker appchain configurations @@ -21,7 +21,7 @@ Behaves like a noop for non-worker appchain configurations > **new WorkerReadyModule**(`localTaskWorkerModule`): [`WorkerReadyModule`](WorkerReadyModule.md) -Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L12) +Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L12) #### Parameters @@ -39,7 +39,7 @@ Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:12](https > **waitForReady**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L20) +Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L20) #### Returns diff --git a/src/pages/docs/reference/sequencer/functions/closeable.md b/src/pages/docs/reference/sequencer/functions/closeable.md index 8e78633..959fa78 100644 --- a/src/pages/docs/reference/sequencer/functions/closeable.md +++ b/src/pages/docs/reference/sequencer/functions/closeable.md @@ -12,7 +12,7 @@ title: closeable > **closeable**(): (`target`) => `void` -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/Closeable.ts#L7) +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/Closeable.ts#L7) ## Returns diff --git a/src/pages/docs/reference/sequencer/functions/distinct.md b/src/pages/docs/reference/sequencer/functions/distinct.md index d6f8256..1b18f15 100644 --- a/src/pages/docs/reference/sequencer/functions/distinct.md +++ b/src/pages/docs/reference/sequencer/functions/distinct.md @@ -12,7 +12,7 @@ title: distinct > **distinct**\<`Value`\>(`value`, `index`, `array`): `boolean` -Defined in: [packages/sequencer/src/helpers/utils.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L7) +Defined in: [packages/sequencer/src/helpers/utils.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L7) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md b/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md index b9104f3..f852e15 100644 --- a/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md +++ b/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md @@ -12,7 +12,7 @@ title: distinctByPredicate > **distinctByPredicate**\<`Value`\>(`predicate`): (`value`, `index`, `array`) => `boolean` -Defined in: [packages/sequencer/src/helpers/utils.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L15) +Defined in: [packages/sequencer/src/helpers/utils.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L15) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/functions/distinctByString.md b/src/pages/docs/reference/sequencer/functions/distinctByString.md index f6f4886..6438584 100644 --- a/src/pages/docs/reference/sequencer/functions/distinctByString.md +++ b/src/pages/docs/reference/sequencer/functions/distinctByString.md @@ -12,7 +12,7 @@ title: distinctByString > **distinctByString**\<`Value`\>(`value`, `index`, `array`): `boolean` -Defined in: [packages/sequencer/src/helpers/utils.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L23) +Defined in: [packages/sequencer/src/helpers/utils.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L23) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md b/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md index f40a54b..19ef681 100644 --- a/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md +++ b/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md @@ -12,7 +12,7 @@ title: executeWithExecutionContext > **executeWithExecutionContext**\<`MethodResult`\>(`method`, `contextInputs`, `runSimulated`): `Promise`\<[`RuntimeContextReducedExecutionResult`](../type-aliases/RuntimeContextReducedExecutionResult.md) & `object`\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:109](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L109) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L109) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/functions/sequencerModule.md b/src/pages/docs/reference/sequencer/functions/sequencerModule.md index b9478b7..b5cbee4 100644 --- a/src/pages/docs/reference/sequencer/functions/sequencerModule.md +++ b/src/pages/docs/reference/sequencer/functions/sequencerModule.md @@ -12,7 +12,7 @@ title: sequencerModule > **sequencerModule**(): (`target`) => `void` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L33) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L33) Marks the decorated class as a sequencer module, while also making it injectable with our dependency injection solution. diff --git a/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md b/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md index ee8a336..46bcd6c 100644 --- a/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md +++ b/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md @@ -10,7 +10,7 @@ title: AsyncMerkleTreeStore # Interface: AsyncMerkleTreeStore -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L10) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L10) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:10](http > **commit**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L13) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L13) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:13](http > **getNodesAsync**: (`nodes`) => `Promise`\<(`undefined` \| `bigint`)[]\> -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L17) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L17) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:17](http > **openTransaction**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L11) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L11) #### Returns @@ -60,7 +60,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:11](http > **writeNodes**: (`nodes`) => `void` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L15) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L15) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md b/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md index b7ac43f..823edbf 100644 --- a/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md +++ b/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md @@ -10,7 +10,7 @@ title: AsyncStateService # Interface: AsyncStateService -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L13) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L13) This Interface should be implemented for services that store the state in an external storage (like a DB). This can be used in conjunction with @@ -22,7 +22,7 @@ CachedStateService to preload keys for In-Circuit usage. > **commit**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L16) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L16) #### Returns @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:16](https:/ > **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L22) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L22) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:22](https:/ > **getMany**: (`keys`) => `Promise`\<[`StateEntry`](StateEntry.md)[]\> -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L20) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L20) #### Parameters @@ -70,7 +70,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:20](https:/ > **openTransaction**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L14) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L14) #### Returns @@ -82,7 +82,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:14](https:/ > **writeStates**: (`entries`) => `void` -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L18) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L18) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md index 80d9be5..237b5f5 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md +++ b/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md @@ -10,7 +10,7 @@ title: BaseLayer # Interface: BaseLayer -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L16) +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L16) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -33,7 +33,7 @@ deps that are necessary for the sequencer to work. > **dependencies**: () => [`BaseLayerDependencyRecord`](BaseLayerDependencyRecord.md) -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L17) +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L17) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md index 6fa71a0..6fd87eb 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md +++ b/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md @@ -10,7 +10,7 @@ title: BaseLayerContractPermissions # Interface: BaseLayerContractPermissions -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L3) +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L3) ## Methods @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPerm > **bridgeContractMina**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L6) +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L6) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPerm > **bridgeContractToken**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L9) +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L9) #### Returns @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPerm > **dispatchContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L5) +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L5) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPerm > **settlementContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L4) +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L4) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md index 0475234..07955b7 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md +++ b/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md @@ -10,7 +10,7 @@ title: BaseLayerDependencyRecord # Interface: BaseLayerDependencyRecord -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L10) +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L10) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:10](https:// > **IncomingMessageAdapter**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`IncomingMessageAdapter`](IncomingMessageAdapter.md)\> -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L11) +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L11) *** @@ -34,4 +34,4 @@ Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:11](https:// > **OutgoingMessageQueue**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`OutgoingMessageQueue`](OutgoingMessageQueue.md)\> -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L13) +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L13) diff --git a/src/pages/docs/reference/sequencer/interfaces/Batch.md b/src/pages/docs/reference/sequencer/interfaces/Batch.md index 4087445..d9e3500 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Batch.md +++ b/src/pages/docs/reference/sequencer/interfaces/Batch.md @@ -10,7 +10,7 @@ title: Batch # Interface: Batch -Defined in: [packages/sequencer/src/storage/model/Batch.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L12) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L12) ## Extended by @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:12](https://github.co > **blockHashes**: `string`[] -Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L14) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L14) *** @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.co > **height**: `number` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L15) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L15) *** @@ -38,4 +38,4 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.co > **proof**: `JsonProof` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L13) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L13) diff --git a/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md b/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md index 5120b82..effbedf 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md @@ -10,7 +10,7 @@ title: BatchStorage # Interface: BatchStorage -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L3) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:3](http > **getCurrentBatchHeight**: () => `Promise`\<`number`\> -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L5) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L5) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:5](http > **getLatestBatch**: () => `Promise`\<`undefined` \| [`Batch`](Batch.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L6) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L6) #### Returns @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:6](http > **pushBatch**: (`block`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L7) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L7) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md b/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md index dbf1fc2..6a218bf 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md +++ b/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md @@ -10,7 +10,7 @@ title: BatchTransaction # Interface: BatchTransaction -Defined in: [packages/sequencer/src/storage/model/Batch.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L6) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L6) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:6](https://github.com > **status**: `boolean` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L8) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L8) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:8](https://github.com > `optional` **statusMessage**: `string` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L9) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L9) *** @@ -34,4 +34,4 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:9](https://github.com > **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) -Defined in: [packages/sequencer/src/storage/model/Batch.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L7) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L7) diff --git a/src/pages/docs/reference/sequencer/interfaces/Block.md b/src/pages/docs/reference/sequencer/interfaces/Block.md index 3336bf1..0fedf7e 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Block.md +++ b/src/pages/docs/reference/sequencer/interfaces/Block.md @@ -10,7 +10,7 @@ title: Block # Interface: Block -Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L22) +Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L22) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.co > **fromBlockHashRoot**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L33) +Defined in: [packages/sequencer/src/storage/model/Block.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L33) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:33](https://github.co > **fromEternalTransactionsHash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L32) +Defined in: [packages/sequencer/src/storage/model/Block.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L32) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:32](https://github.co > **fromMessagesHash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L34) +Defined in: [packages/sequencer/src/storage/model/Block.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L34) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:34](https://github.co > **hash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L23) +Defined in: [packages/sequencer/src/storage/model/Block.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L23) *** @@ -50,7 +50,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:23](https://github.co > **height**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L24) +Defined in: [packages/sequencer/src/storage/model/Block.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L24) *** @@ -58,7 +58,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:24](https://github.co > **networkState**: `object` -Defined in: [packages/sequencer/src/storage/model/Block.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L25) +Defined in: [packages/sequencer/src/storage/model/Block.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L25) #### before @@ -74,7 +74,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:25](https://github.co > **previousBlockHash**: `undefined` \| `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L36) +Defined in: [packages/sequencer/src/storage/model/Block.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L36) *** @@ -82,7 +82,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:36](https://github.co > **toEternalTransactionsHash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L31) +Defined in: [packages/sequencer/src/storage/model/Block.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L31) *** @@ -90,7 +90,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:31](https://github.co > **toMessagesHash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L35) +Defined in: [packages/sequencer/src/storage/model/Block.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L35) *** @@ -98,7 +98,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:35](https://github.co > **transactions**: [`TransactionExecutionResult`](TransactionExecutionResult.md)[] -Defined in: [packages/sequencer/src/storage/model/Block.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L29) +Defined in: [packages/sequencer/src/storage/model/Block.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L29) *** @@ -106,4 +106,4 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:29](https://github.co > **transactionsHash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L30) +Defined in: [packages/sequencer/src/storage/model/Block.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L30) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md b/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md index c00e5ca..fa179b7 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md @@ -10,7 +10,7 @@ title: BlockConfig # Interface: BlockConfig -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L33) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L33) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducer > `optional` **allowEmptyBlock**: `boolean` -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L34) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L34) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducer > `optional` **maximumBlockSize**: `number` -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L35) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md b/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md index 7a1ecba..dd51a90 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md @@ -10,7 +10,7 @@ title: BlockProverParameters # Interface: BlockProverParameters -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L35) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **executionData**: [`BlockProverExecutionData`](../../protocol/classes/BlockProverExecutionData.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L37) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **publicInput**: [`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L36) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L36) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **startingState**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L38) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L38) *** @@ -42,4 +42,4 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **verificationKeyAttestation**: [`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L39) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L39) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md b/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md index db35012..accdab8 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md @@ -10,7 +10,7 @@ title: BlockQueue # Interface: BlockQueue -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L9) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L9) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:9](http > **getLatestBlockAndResult**: () => `Promise`\<`undefined` \| [`BlockWithMaybeResult`](BlockWithMaybeResult.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L13) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L13) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:13](htt > **getNewBlocks**: () => `Promise`\<[`BlockWithPreviousResult`](BlockWithPreviousResult.md)[]\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L12) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L12) #### Returns @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:12](htt > **pushBlock**: (`block`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L10) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L10) #### Parameters @@ -60,7 +60,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:10](htt > **pushResult**: (`result`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L11) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L11) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockResult.md index 73571ce..8280c7b 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockResult.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockResult.md @@ -10,7 +10,7 @@ title: BlockResult # Interface: BlockResult -Defined in: [packages/sequencer/src/storage/model/Block.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L50) +Defined in: [packages/sequencer/src/storage/model/Block.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L50) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:50](https://github.co > **afterNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L54) +Defined in: [packages/sequencer/src/storage/model/Block.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L54) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:54](https://github.co > **blockHash**: `bigint` -Defined in: [packages/sequencer/src/storage/model/Block.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L51) +Defined in: [packages/sequencer/src/storage/model/Block.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L51) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:51](https://github.co > **blockHashRoot**: `bigint` -Defined in: [packages/sequencer/src/storage/model/Block.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L53) +Defined in: [packages/sequencer/src/storage/model/Block.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L53) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:53](https://github.co > **blockHashWitness**: [`BlockHashMerkleTreeWitness`](../../protocol/classes/BlockHashMerkleTreeWitness.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:56](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L56) +Defined in: [packages/sequencer/src/storage/model/Block.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L56) *** @@ -50,7 +50,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:56](https://github.co > **blockStateTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] -Defined in: [packages/sequencer/src/storage/model/Block.ts:55](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L55) +Defined in: [packages/sequencer/src/storage/model/Block.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L55) *** @@ -58,4 +58,4 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:55](https://github.co > **stateRoot**: `bigint` -Defined in: [packages/sequencer/src/storage/model/Block.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L52) +Defined in: [packages/sequencer/src/storage/model/Block.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L52) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md b/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md index 01c977a..16b51b4 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md @@ -10,7 +10,7 @@ title: BlockStorage # Interface: BlockStorage -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L16) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L16) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:16](htt > **getCurrentBlockHeight**: () => `Promise`\<`number`\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L17) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L17) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:17](htt > **getLatestBlock**: () => `Promise`\<`undefined` \| [`BlockWithResult`](BlockWithResult.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L18) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L18) #### Returns @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:18](htt > **pushBlock**: (`block`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L19) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L19) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md b/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md index 3ca4b01..1d27c0f 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md @@ -10,7 +10,7 @@ title: BlockTrace # Interface: BlockTrace -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L43) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L43) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:4 > **block**: [`NewBlockProverParameters`](NewBlockProverParameters.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L44) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:4 > **stateTransitionProver**: [`StateTransitionProofParameters`](StateTransitionProofParameters.md)[] -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:45](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L45) *** @@ -34,4 +34,4 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:4 > **transactions**: [`TransactionTrace`](TransactionTrace.md)[] -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:46](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L46) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md b/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md index 5fdae78..27632f8 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md @@ -10,7 +10,7 @@ title: BlockTrigger # Interface: BlockTrigger -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L24) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L24) A BlockTrigger is the primary method to start the production of a block and all associated processes. diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md index 2d4f40b..65111d7 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md @@ -10,7 +10,7 @@ title: BlockWithMaybeResult # Interface: BlockWithMaybeResult -Defined in: [packages/sequencer/src/storage/model/Block.ts:64](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L64) +Defined in: [packages/sequencer/src/storage/model/Block.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L64) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:64](https://github.co > **block**: [`Block`](Block.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:65](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L65) +Defined in: [packages/sequencer/src/storage/model/Block.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L65) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:65](https://github.co > `optional` **result**: [`BlockResult`](BlockResult.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:66](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L66) +Defined in: [packages/sequencer/src/storage/model/Block.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L66) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md index 9336ff7..cb0338d 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md @@ -10,7 +10,7 @@ title: BlockWithPreviousResult # Interface: BlockWithPreviousResult -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L49) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L49) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:4 > **block**: [`BlockWithResult`](BlockWithResult.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:50](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L50) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:5 > `optional` **lastBlockResult**: [`BlockResult`](BlockResult.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L51) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L51) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md index 45490f5..0f728a0 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md @@ -10,7 +10,7 @@ title: BlockWithResult # Interface: BlockWithResult -Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L59) +Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L59) ## Extended by @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.co > **block**: [`Block`](Block.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:60](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L60) +Defined in: [packages/sequencer/src/storage/model/Block.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L60) *** @@ -30,4 +30,4 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:60](https://github.co > **result**: [`BlockResult`](BlockResult.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L61) +Defined in: [packages/sequencer/src/storage/model/Block.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L61) diff --git a/src/pages/docs/reference/sequencer/interfaces/Closeable.md b/src/pages/docs/reference/sequencer/interfaces/Closeable.md index 2157d65..9e96f15 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Closeable.md +++ b/src/pages/docs/reference/sequencer/interfaces/Closeable.md @@ -10,7 +10,7 @@ title: Closeable # Interface: Closeable -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/Closeable.ts#L3) +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/Closeable.ts#L3) ## Extended by @@ -23,7 +23,7 @@ Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:3](https://gi > **close**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/Database.md b/src/pages/docs/reference/sequencer/interfaces/Database.md index ef4f2a3..7d3fb3c 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Database.md +++ b/src/pages/docs/reference/sequencer/interfaces/Database.md @@ -10,7 +10,7 @@ title: Database # Interface: Database -Defined in: [packages/sequencer/src/storage/Database.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/Database.ts#L5) +Defined in: [packages/sequencer/src/storage/Database.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/Database.ts#L5) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -33,7 +33,7 @@ deps that are necessary for the sequencer to work. > **close**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) #### Returns @@ -49,7 +49,7 @@ Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://gi > **dependencies**: () => [`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) #### Returns @@ -65,7 +65,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](http > **executeInTransaction**(`f`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/Database.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/Database.ts#L13) +Defined in: [packages/sequencer/src/storage/Database.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/Database.ts#L13) #### Parameters @@ -83,7 +83,7 @@ Defined in: [packages/sequencer/src/storage/Database.ts:13](https://github.com/p > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/Database.ts#L11) +Defined in: [packages/sequencer/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/Database.ts#L11) Prunes all data from the database connection. Note: This function should only be called immediately at startup, diff --git a/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md b/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md index 3d4f6cc..2d3024b 100644 --- a/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md @@ -10,7 +10,7 @@ title: HistoricalBatchStorage # Interface: HistoricalBatchStorage -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:10](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L10) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L10) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:10](htt > **getBatchAt**: (`height`) => `Promise`\<`undefined` \| [`Batch`](Batch.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BatchStorage.ts#L11) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L11) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md b/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md index a476af7..3f9bde9 100644 --- a/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md @@ -10,7 +10,7 @@ title: HistoricalBlockStorage # Interface: HistoricalBlockStorage -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L22) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L22) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:22](htt > **getBlock**: (`hash`) => `Promise`\<`undefined` \| [`Block`](Block.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L24) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L24) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:24](htt > **getBlockAt**: (`height`) => `Promise`\<`undefined` \| [`Block`](Block.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/BlockStorage.ts#L23) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L23) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md b/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md index fb5af5b..5715aab 100644 --- a/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md +++ b/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md @@ -10,7 +10,7 @@ title: IncomingMessageAdapter # Interface: IncomingMessageAdapter -Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L11) +Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L11) An interface provided by the BaseLayer via DependencyFactory, which implements a function that allows us to retrieve @@ -23,7 +23,7 @@ unconsumed incoming messages from the BaseLayer > **getPendingMessages**: (`address`, `params`) => `Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](../classes/PendingTransaction.md)[]; `to`: `string`; \}\> -Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L12) +Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L12) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md b/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md index 7dd0e85..17b20dd 100644 --- a/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md +++ b/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md @@ -10,7 +10,7 @@ title: InstantiatedQueue # Interface: InstantiatedQueue -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L20) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L20) Object that abstracts a concrete connection to a queue instance. @@ -24,7 +24,7 @@ Object that abstracts a concrete connection to a queue instance. > **addTask**: (`payload`, `taskId`?) => `Promise`\<\{ `taskId`: `string`; \}\> -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L26) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L26) Adds a specific payload to the queue and returns a unique jobId @@ -48,7 +48,7 @@ Adds a specific payload to the queue and returns a unique jobId > **close**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) #### Returns @@ -64,7 +64,7 @@ Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://gi > **name**: `string` -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L21) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L21) *** @@ -72,7 +72,7 @@ Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:21](https://github > **offCompleted**: (`listenerId`) => `void` -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L38) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L38) #### Parameters @@ -90,7 +90,7 @@ Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:38](https://github > **onCompleted**: (`listener`) => `Promise`\<`number`\> -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L34) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L34) Registers a listener for the completion of jobs diff --git a/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md b/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md index 096aad2..61308ed 100644 --- a/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md +++ b/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md @@ -10,7 +10,7 @@ title: LocalTaskQueueConfig # Interface: LocalTaskQueueConfig -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L22) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L22) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:22](https://g > `optional` **simulatedDuration**: `number` -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L23) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L23) diff --git a/src/pages/docs/reference/sequencer/interfaces/Mempool.md b/src/pages/docs/reference/sequencer/interfaces/Mempool.md index 608e86b..950898d 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Mempool.md +++ b/src/pages/docs/reference/sequencer/interfaces/Mempool.md @@ -10,7 +10,7 @@ title: Mempool # Interface: Mempool\ -Defined in: [packages/sequencer/src/mempool/Mempool.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/Mempool.ts#L9) +Defined in: [packages/sequencer/src/mempool/Mempool.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/Mempool.ts#L9) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/mempool/Mempool.ts:9](https://github.com/pro > **add**: (`tx`) => `Promise`\<`boolean`\> -Defined in: [packages/sequencer/src/mempool/Mempool.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/Mempool.ts#L15) +Defined in: [packages/sequencer/src/mempool/Mempool.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/Mempool.ts#L15) Add a transaction to the mempool @@ -60,7 +60,7 @@ Defined in: packages/common/dist/events/EventEmittingComponent.d.ts:4 > **getTxs**: (`limit`?) => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/mempool/Mempool.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/Mempool.ts#L20) +Defined in: [packages/sequencer/src/mempool/Mempool.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/Mempool.ts#L20) Retrieve all transactions that are currently in the mempool diff --git a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md index ec468fc..398b834 100644 --- a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md +++ b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md @@ -10,7 +10,7 @@ title: MerkleTreeNode # Interface: MerkleTreeNode -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L6) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L6) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:6](https > **key**: `bigint` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https > **level**: `number` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) #### Inherited from @@ -46,4 +46,4 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https > **value**: `bigint` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L7) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L7) diff --git a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md index 5047d14..a4901f5 100644 --- a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md +++ b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md @@ -10,7 +10,7 @@ title: MerkleTreeNodeQuery # Interface: MerkleTreeNodeQuery -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L1) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L1) ## Extended by @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:1](https > **key**: `bigint` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) *** @@ -30,4 +30,4 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https > **level**: `number` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) diff --git a/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md b/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md index 1d5fc54..55b9a36 100644 --- a/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md @@ -10,7 +10,7 @@ title: MessageStorage # Interface: MessageStorage -Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/MessageStorage.ts#L6) +Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/MessageStorage.ts#L6) Interface to store Messages previously fetched by a IncomingMessageadapter @@ -20,7 +20,7 @@ Interface to store Messages previously fetched by a IncomingMessageadapter > **getMessages**: (`fromMessagesHash`) => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/MessageStorage.ts#L12) +Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/MessageStorage.ts#L12) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:12](h > **pushMessages**: (`fromMessagesHash`, `toMessagesHash`, `messages`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:7](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/MessageStorage.ts#L7) +Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/MessageStorage.ts#L7) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md b/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md index 3989bfc..ea2d13c 100644 --- a/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md +++ b/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md @@ -10,7 +10,7 @@ title: MinaBaseLayerConfig # Interface: MinaBaseLayerConfig -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L16) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L16) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:16](http > **network**: \{ `type`: `"local"`; \} \| \{ `accountManager`: `string`; `archive`: `string`; `graphql`: `string`; `type`: `"lightnet"`; \} \| \{ `archive`: `string`; `graphql`: `string`; `type`: `"remote"`; \} -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L17) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L17) diff --git a/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md b/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md index 02f4645..0659f26 100644 --- a/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md +++ b/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md @@ -10,7 +10,7 @@ title: NetworkStateTransportModule # Interface: NetworkStateTransportModule -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L3) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts > **getProvenNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L6) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L6) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts > **getStagedNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L5) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L5) #### Returns @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts > **getUnprovenNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L4) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L4) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md b/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md index 9f70a81..665631d 100644 --- a/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md +++ b/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md @@ -10,7 +10,7 @@ title: NewBlockProverParameters # Interface: NewBlockProverParameters -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L30) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L30) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:30 > **blockWitness**: [`BlockHashMerkleTreeWitness`](../../protocol/classes/BlockHashMerkleTreeWitness.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L33) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L33) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:33 > **networkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L32) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:32 > **publicInput**: [`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L31) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L31) *** @@ -42,4 +42,4 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:31 > **startingState**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:34](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L34) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L34) diff --git a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md index 1988356..498a419 100644 --- a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md +++ b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md @@ -10,7 +10,7 @@ title: OutgoingMessage # Interface: OutgoingMessage\ -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L13) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L13) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:13](h > **index**: `number` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L14) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L14) *** @@ -30,4 +30,4 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:14](h > **value**: `Type` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L15) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L15) diff --git a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md index 9a29482..6e64631 100644 --- a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md +++ b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md @@ -10,7 +10,7 @@ title: OutgoingMessageQueue # Interface: OutgoingMessageQueue -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L37) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L37) This interface allows the SettlementModule to retrieve information about pending L2-dispatched (outgoing) messages that it can then use to roll @@ -25,7 +25,7 @@ outgoing message type is not limited to Withdrawals > **length**: () => `number` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L40) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L40) #### Returns @@ -37,7 +37,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:40](h > **peek**: (`num`) => [`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L38) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L38) #### Parameters @@ -55,7 +55,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:38](h > **pop**: (`num`) => [`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L39) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L39) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md b/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md index 9f736bf..2194cae 100644 --- a/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md +++ b/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md @@ -10,7 +10,7 @@ title: PairingDerivedInput # Interface: PairingDerivedInput\ -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L16) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L16) This type is used to consistently define the input type of a MapReduce flow that is depenend on the result a pairing. @@ -29,7 +29,7 @@ This type is used to consistently define the input type of a MapReduce flow > **input1**: `Input1` -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L17) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L17) *** @@ -37,7 +37,7 @@ Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.t > **input2**: `Input2` -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L18) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L18) *** @@ -45,4 +45,4 @@ Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.t > **params**: `AdditionalParameters` -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L19) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L19) diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md b/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md index faf274f..fe73516 100644 --- a/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md +++ b/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md @@ -10,7 +10,7 @@ title: QueryGetterState # Interface: QueryGetterState\ -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L24) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L24) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:24](htt > **get**: () => `Promise`\<`undefined` \| `Value`\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L25) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L25) #### Returns @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:25](htt > **merkleWitness**: () => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L27) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L27) #### Returns @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:27](htt > **path**: () => `string` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L26) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L26) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md b/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md index cb495b9..1609ff4 100644 --- a/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md +++ b/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md @@ -10,7 +10,7 @@ title: QueryGetterStateMap # Interface: QueryGetterStateMap\ -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L30) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L30) ## Type Parameters @@ -24,7 +24,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:30](htt > **get**: (`key`) => `Promise`\<`undefined` \| `Value`\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L31) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L31) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:31](htt > **merkleWitness**: (`key`) => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L33) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L33) #### Parameters @@ -60,7 +60,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:33](htt > **path**: (`key`) => `string` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L32) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L32) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md b/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md index c267750..f78813e 100644 --- a/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md +++ b/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md @@ -10,7 +10,7 @@ title: QueryTransportModule # Interface: QueryTransportModule -Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L4) +Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L4) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:4](htt > **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L5) +Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L5) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:5](htt > **merkleWitness**: (`key`) => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> -Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L6) +Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L6) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md b/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md index 1ebcebf..9eaeecf 100644 --- a/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md +++ b/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md @@ -10,7 +10,7 @@ title: RuntimeProofParameters # Interface: RuntimeProofParameters -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L26) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L26) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > **networkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L28) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L28) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > **state**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L29) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L29) *** @@ -34,4 +34,4 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L27) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L27) diff --git a/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md b/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md index 08072c1..55d12cb 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md +++ b/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md @@ -10,7 +10,7 @@ title: Sequenceable # Interface: Sequenceable -Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L1) +Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L1) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:1](https: > **start**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:2](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L2) +Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:2](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L2) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md b/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md index db36521..0b1e18e 100644 --- a/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md +++ b/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md @@ -10,7 +10,7 @@ title: SettleableBatch # Interface: SettleableBatch -Defined in: [packages/sequencer/src/storage/model/Batch.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L18) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L18) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:18](https://github.co > **blockHashes**: `string`[] -Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L14) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L14) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.co > **fromNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [packages/sequencer/src/storage/model/Batch.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L19) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L19) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:19](https://github.co > **height**: `number` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L15) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L15) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.co > **proof**: `JsonProof` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L13) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L13) #### Inherited from @@ -66,4 +66,4 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.co > **toNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [packages/sequencer/src/storage/model/Batch.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Batch.ts#L20) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L20) diff --git a/src/pages/docs/reference/sequencer/interfaces/Settlement.md b/src/pages/docs/reference/sequencer/interfaces/Settlement.md index 98808c7..702c411 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Settlement.md +++ b/src/pages/docs/reference/sequencer/interfaces/Settlement.md @@ -10,7 +10,7 @@ title: Settlement # Interface: Settlement -Defined in: [packages/sequencer/src/storage/model/Settlement.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Settlement.ts#L1) +Defined in: [packages/sequencer/src/storage/model/Settlement.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Settlement.ts#L1) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Settlement.ts:1](https://githu > **batches**: `number`[] -Defined in: [packages/sequencer/src/storage/model/Settlement.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Settlement.ts#L6) +Defined in: [packages/sequencer/src/storage/model/Settlement.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Settlement.ts#L6) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/storage/model/Settlement.ts:6](https://githu > **promisedMessagesHash**: `string` -Defined in: [packages/sequencer/src/storage/model/Settlement.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Settlement.ts#L5) +Defined in: [packages/sequencer/src/storage/model/Settlement.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Settlement.ts#L5) diff --git a/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md b/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md index a7dab0b..ac80304 100644 --- a/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md +++ b/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md @@ -10,7 +10,7 @@ title: SettlementModuleConfig # Interface: SettlementModuleConfig -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:52](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L52) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L52) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:52](https://g > `optional` **address**: `PublicKey` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L54) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L54) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:54](https://g > **feepayer**: `PrivateKey` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:53](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L53) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L53) diff --git a/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md b/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md index a58d403..8b47b45 100644 --- a/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md @@ -10,7 +10,7 @@ title: SettlementStorage # Interface: SettlementStorage -Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L3) +Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:3] > **pushSettlement**: (`settlement`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L4) +Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L4) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/StateEntry.md b/src/pages/docs/reference/sequencer/interfaces/StateEntry.md index 848650c..9cff811 100644 --- a/src/pages/docs/reference/sequencer/interfaces/StateEntry.md +++ b/src/pages/docs/reference/sequencer/interfaces/StateEntry.md @@ -10,7 +10,7 @@ title: StateEntry # Interface: StateEntry -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L3) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:3](https:// > **key**: `Field` -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L4) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L4) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:4](https:// > **value**: `undefined` \| `Field`[] -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/state/async/AsyncStateService.ts#L5) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L5) diff --git a/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md b/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md index 4544fbd..1d4bc04 100644 --- a/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md +++ b/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md @@ -10,7 +10,7 @@ title: StateTransitionProofParameters # Interface: StateTransitionProofParameters -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L27) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L27) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:33](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L33) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L33) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > **publicInput**: [`StateTransitionProverPublicInput`](../../protocol/classes/StateTransitionProverPublicInput.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L28) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L28) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > **stateTransitions**: `object`[] -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L29) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L29) #### transition diff --git a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md index 95d63a7..f8625f0 100644 --- a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md +++ b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md @@ -10,7 +10,7 @@ title: StorageDependencyFactory # Interface: StorageDependencyFactory -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L30) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L30) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -37,7 +37,7 @@ deps that are necessary for the sequencer to work. > **dependencies**: () => [`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md index 235c385..bfb8240 100644 --- a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md +++ b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md @@ -10,7 +10,7 @@ title: StorageDependencyMinimumDependencies # Interface: StorageDependencyMinimumDependencies -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L16) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L16) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:16](http > **asyncMerkleStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L18) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L18) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:18](http > **asyncStateService**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncStateService`](AsyncStateService.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L17) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L17) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:17](http > **batchStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BatchStorage`](BatchStorage.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L19) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L19) *** @@ -50,7 +50,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:19](http > **blockQueue**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BlockQueue`](BlockQueue.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L20) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L20) *** @@ -58,7 +58,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:20](http > **blockStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BlockStorage`](BlockStorage.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L21) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L21) *** @@ -66,7 +66,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:21](http > **blockTreeStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L24) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L24) *** @@ -74,7 +74,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:24](http > **messageStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`MessageStorage`](MessageStorage.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L25) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L25) *** @@ -82,7 +82,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:25](http > **settlementStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`SettlementStorage`](SettlementStorage.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L26) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L26) *** @@ -90,7 +90,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:26](http > **transactionStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`TransactionStorage`](TransactionStorage.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L27) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L27) *** @@ -98,7 +98,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:27](http > **unprovenMerkleStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L23) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L23) *** @@ -106,4 +106,4 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:23](http > **unprovenStateService**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncStateService`](AsyncStateService.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/StorageDependencyFactory.ts#L22) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L22) diff --git a/src/pages/docs/reference/sequencer/interfaces/Task.md b/src/pages/docs/reference/sequencer/interfaces/Task.md index c1fa0e3..c0b55c3 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Task.md +++ b/src/pages/docs/reference/sequencer/interfaces/Task.md @@ -10,7 +10,7 @@ title: Task # Interface: Task\ -Defined in: [packages/sequencer/src/worker/flow/Task.ts:1](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L1) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L1) ## Type Parameters @@ -24,7 +24,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:1](https://github.com/pr > **compute**: (`input`) => `Promise`\<`Result`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L6) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L6) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:6](https://github.com/pr > **inputSerializer**: () => [`TaskSerializer`](TaskSerializer.md)\<`Input`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L8) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L8) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:8](https://github.com/pr > **name**: `string` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:2](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L2) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:2](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L2) *** @@ -62,7 +62,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:2](https://github.com/pr > **prepare**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L4) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L4) #### Returns @@ -74,7 +74,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:4](https://github.com/pr > **resultSerializer**: () => [`TaskSerializer`](TaskSerializer.md)\<`Result`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L9) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L9) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md b/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md index 5b2b0ca..59e5c16 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md +++ b/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md @@ -10,7 +10,7 @@ title: TaskPayload # Interface: TaskPayload -Defined in: [packages/sequencer/src/worker/flow/Task.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L17) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L17) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:17](https://github.com/p > **flowId**: `string` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L22) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L22) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:22](https://github.com/p > **name**: `string` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L19) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L19) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:19](https://github.com/p > **payload**: `string` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:20](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L20) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L20) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:20](https://github.com/p > `optional` **status**: `"error"` \| `"success"` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L18) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L18) *** @@ -50,4 +50,4 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:18](https://github.com/p > `optional` **taskId**: `string` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:21](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L21) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L21) diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md b/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md index 5e19223..70874bd 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md +++ b/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md @@ -10,7 +10,7 @@ title: TaskQueue # Interface: TaskQueue -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:8](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L8) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L8) Definition of a connection-object that can generate queues and workers for a specific connection type (e.g. BullMQ, In-memory) @@ -21,7 +21,7 @@ for a specific connection type (e.g. BullMQ, In-memory) > **createWorker**: (`name`, `executor`, `options`?) => [`Closeable`](Closeable.md) -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L11) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L11) #### Parameters @@ -49,7 +49,7 @@ Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:11](https://github > **getQueue**: (`name`) => `Promise`\<[`InstantiatedQueue`](InstantiatedQueue.md)\> -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:9](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/queue/TaskQueue.ts#L9) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L9) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md b/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md index d3f9c61..898144b 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md +++ b/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md @@ -10,7 +10,7 @@ title: TaskSerializer # Interface: TaskSerializer\ -Defined in: [packages/sequencer/src/worker/flow/Task.ts:12](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L12) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L12) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:12](https://github.com/p > **fromJSON**: (`json`) => `Type` \| `Promise`\<`Type`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L14) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L14) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:14](https://github.com/p > **toJSON**: (`input`) => `string` \| `Promise`\<`string`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/Task.ts#L13) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L13) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md index d545bc2..908eb4a 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md +++ b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md @@ -10,7 +10,7 @@ title: TimedBlockTriggerConfig # Interface: TimedBlockTriggerConfig -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L16) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L16) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > **blockInterval**: `number` -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:26](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L26) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L26) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > `optional` **produceEmptyBlocks**: `boolean` -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:27](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L27) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L27) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > `optional` **settlementInterval**: `number` -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L25) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L25) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > `optional` **tick**: `number` -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L24) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L24) Interval for the tick event to be fired. The time x of any block trigger time is always guaranteed to be diff --git a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md index a6468b2..076ea9a 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md +++ b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md @@ -10,7 +10,7 @@ title: TimedBlockTriggerEvent # Interface: TimedBlockTriggerEvent -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L30) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L30) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > **batch-produced**: \[[`Batch`](Batch.md)\] -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L31) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L31) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > **block-metadata-produced**: \[[`BlockWithResult`](BlockWithResult.md)\] -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L30) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L30) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > **block-produced**: \[[`Block`](Block.md)\] -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:29](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L29) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L29) #### Inherited from @@ -58,4 +58,4 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > **tick**: \[`number`\] -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L31) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L31) diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md b/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md index 49d1f5e..d18e9ae 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md +++ b/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md @@ -10,7 +10,7 @@ title: TransactionExecutionResult # Interface: TransactionExecutionResult -Defined in: [packages/sequencer/src/storage/model/Block.ts:13](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L13) +Defined in: [packages/sequencer/src/storage/model/Block.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L13) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:13](https://github.co > **events**: `object`[] -Defined in: [packages/sequencer/src/storage/model/Block.ts:19](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L19) +Defined in: [packages/sequencer/src/storage/model/Block.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L19) #### data @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:19](https://github.co > **protocolTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] -Defined in: [packages/sequencer/src/storage/model/Block.ts:16](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L16) +Defined in: [packages/sequencer/src/storage/model/Block.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L16) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:16](https://github.co > **stateTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] -Defined in: [packages/sequencer/src/storage/model/Block.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L15) +Defined in: [packages/sequencer/src/storage/model/Block.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L15) *** @@ -50,7 +50,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:15](https://github.co > **status**: `Bool` -Defined in: [packages/sequencer/src/storage/model/Block.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L17) +Defined in: [packages/sequencer/src/storage/model/Block.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L17) *** @@ -58,7 +58,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:17](https://github.co > `optional` **statusMessage**: `string` -Defined in: [packages/sequencer/src/storage/model/Block.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L18) +Defined in: [packages/sequencer/src/storage/model/Block.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L18) *** @@ -66,4 +66,4 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:18](https://github.co > **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:14](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L14) +Defined in: [packages/sequencer/src/storage/model/Block.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L14) diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md b/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md index b2cca4b..a5c7171 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md @@ -10,7 +10,7 @@ title: TransactionStorage # Interface: TransactionStorage -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L3) +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:3 > **findTransaction**: (`hash`) => `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../classes/PendingTransaction.md); \}\> -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L15) +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L15) Finds a transaction by its hash. It returns both pending transaction and already included transactions @@ -41,7 +41,7 @@ and batch number where applicable. > **getPendingUserTransactions**: () => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:6](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L6) +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L6) #### Returns @@ -53,7 +53,7 @@ Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:6 > **pushUserTransaction**: (`tx`) => `Promise`\<`boolean`\> -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:4](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L4) +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L4) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md b/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md index 4e1951e..d79e7c3 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md +++ b/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md @@ -10,7 +10,7 @@ title: TransactionTrace # Interface: TransactionTrace -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L37) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:3 > **blockProver**: [`BlockProverParameters`](BlockProverParameters.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L40) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L40) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:4 > **runtimeProver**: [`RuntimeProofParameters`](RuntimeProofParameters.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L38) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L38) *** @@ -34,4 +34,4 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:3 > **stateTransitionProver**: [`StateTransitionProofParameters`](StateTransitionProofParameters.md)[] -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:39](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L39) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L39) diff --git a/src/pages/docs/reference/sequencer/interfaces/TxEvents.md b/src/pages/docs/reference/sequencer/interfaces/TxEvents.md index 981a0a0..3c74cdf 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TxEvents.md +++ b/src/pages/docs/reference/sequencer/interfaces/TxEvents.md @@ -10,7 +10,7 @@ title: TxEvents # Interface: TxEvents -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L22) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L22) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSende > **included**: \[\{ `hash`: `string`; \}\] -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:24](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L24) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L24) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSende > **rejected**: \[`any`\] -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L25) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L25) *** @@ -42,4 +42,4 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSende > **sent**: \[\{ `hash`: `string`; \}\] -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L23) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L23) diff --git a/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md b/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md index c7abbc5..b8c0fa9 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md +++ b/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md @@ -12,4 +12,4 @@ title: AllTaskWorkerModules > **AllTaskWorkerModules**: [`ReturnType`](../../protocol/type-aliases/ReturnType.md)\<*typeof* [`allTasks`](../classes/VanillaTaskWorkerModules.md#alltasks)\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:171](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L171) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:171](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L171) diff --git a/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md b/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md index 011b92b..377cbb3 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md +++ b/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md @@ -12,7 +12,7 @@ title: BlockEvents > **BlockEvents**: `object` -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:28](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L28) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L28) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md b/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md index 80ed595..cfd4da4 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md +++ b/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md @@ -12,7 +12,7 @@ title: ChainStateTaskArgs > **ChainStateTaskArgs**: `object` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:44](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L44) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L44) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md b/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md index 2703fd6..e58fa81 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md +++ b/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md @@ -12,7 +12,7 @@ title: DatabasePruneConfig > **DatabasePruneConfig**: `object` -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:11](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/DatabasePruneModule.ts#L11) +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/DatabasePruneModule.ts#L11) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md b/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md index 980d80d..4944932 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md +++ b/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md @@ -12,4 +12,4 @@ title: JSONEncodableState > **JSONEncodableState**: `Record`\<`string`, `string`[]\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L32) diff --git a/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md b/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md index 19cceb8..836d4d8 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md +++ b/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md @@ -12,7 +12,7 @@ title: MapStateMapToQuery > **MapStateMapToQuery**\<`StateProperty`\>: `StateProperty` *extends* [`StateMap`](../../protocol/classes/StateMap.md)\ ? [`QueryGetterStateMap`](../interfaces/QueryGetterStateMap.md)\<`Key`, `Value`\> : `never` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:43](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L43) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L43) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md b/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md index 2acdb1d..731bdf5 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md +++ b/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md @@ -12,7 +12,7 @@ title: MapStateToQuery > **MapStateToQuery**\<`StateProperty`\>: `StateProperty` *extends* [`State`](../../protocol/classes/State.md)\ ? [`QueryGetterState`](../interfaces/QueryGetterState.md)\<`Value`\> : `never` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:40](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L40) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L40) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md b/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md index 3a916e0..7474845 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md +++ b/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md @@ -12,7 +12,7 @@ title: MempoolEvents > **MempoolEvents**: `object` -Defined in: [packages/sequencer/src/mempool/Mempool.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/Mempool.ts#L5) +Defined in: [packages/sequencer/src/mempool/Mempool.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/Mempool.ts#L5) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md b/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md index 465bab5..b60404b 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md +++ b/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md @@ -12,7 +12,7 @@ title: ModuleQuery > **ModuleQuery**\<`Module`\>: `{ [Key in keyof PickStateMapProperties]: MapStateMapToQuery[Key]> }` & `{ [Key in keyof PickStateProperties]: MapStateToQuery[Key]> }` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:48](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L48) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L48) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md b/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md index 7162735..7520f87 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md +++ b/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md @@ -12,4 +12,4 @@ title: NewBlockProvingParameters > **NewBlockProvingParameters**: [`PairingDerivedInput`](../interfaces/PairingDerivedInput.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md), `BlockProof`, [`NewBlockProverParameters`](../interfaces/NewBlockProverParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L37) diff --git a/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md b/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md index a8156f4..eea94b0 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md +++ b/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md @@ -12,7 +12,7 @@ title: PairTuple > **PairTuple**\<`Type`\>: \[`Type`, `Type`\] -Defined in: [packages/sequencer/src/helpers/utils.ts:162](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/utils.ts#L162) +Defined in: [packages/sequencer/src/helpers/utils.ts:162](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L162) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickByType.md b/src/pages/docs/reference/sequencer/type-aliases/PickByType.md index ce6e7e7..317a555 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/PickByType.md +++ b/src/pages/docs/reference/sequencer/type-aliases/PickByType.md @@ -12,7 +12,7 @@ title: PickByType > **PickByType**\<`Type`, `Value`\>: \{ \[Key in keyof Type as Type\[Key\] extends Value \| undefined ? Key : never\]: Type\[Key\] \} -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:18](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L18) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L18) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md b/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md index 2ef1863..f7ae1bb 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md +++ b/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md @@ -12,7 +12,7 @@ title: PickStateMapProperties > **PickStateMapProperties**\<`Type`\>: [`PickByType`](PickByType.md)\<`Type`, [`StateMap`](../../protocol/classes/StateMap.md)\<`any`, `any`\>\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:38](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L38) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L38) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md b/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md index 99dbd85..e64d8db 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md +++ b/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md @@ -12,7 +12,7 @@ title: PickStateProperties > **PickStateProperties**\<`Type`\>: [`PickByType`](PickByType.md)\<`Type`, [`State`](../../protocol/classes/State.md)\<`any`\>\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:36](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L36) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L36) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/Query.md b/src/pages/docs/reference/sequencer/type-aliases/Query.md index 133a8c9..9c5130b 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/Query.md +++ b/src/pages/docs/reference/sequencer/type-aliases/Query.md @@ -12,7 +12,7 @@ title: Query > **Query**\<`ModuleType`, `ModuleRecord`\>: `{ [Key in keyof ModuleRecord]: ModuleQuery> }` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L58) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L58) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md b/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md index 3a4c8c7..65f73f7 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md +++ b/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md @@ -12,4 +12,4 @@ title: RuntimeContextReducedExecutionResult > **RuntimeContextReducedExecutionResult**: `Pick`\<[`RuntimeProvableMethodExecutionResult`](../../protocol/classes/RuntimeProvableMethodExecutionResult.md), `"stateTransitions"` \| `"status"` \| `"statusMessage"` \| `"stackTrace"` \| `"events"`\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:37](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L37) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md b/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md index 28e4f0e..b568afb 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md +++ b/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md @@ -12,4 +12,4 @@ title: SequencerModulesRecord > **SequencerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](TypedClass.md)\<[`SequencerModule`](../classes/SequencerModule.md)\<`unknown`\>\>\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:25](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/sequencer/executor/Sequencer.ts#L25) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L25) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md b/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md index 70947ec..c038d56 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md +++ b/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md @@ -12,4 +12,4 @@ title: SerializedArtifactRecord > **SerializedArtifactRecord**: `Record`\<`string`, \{ `verificationKey`: \{ `data`: `string`; `hash`: `string`; \}; \}\> -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:5](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L5) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L5) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md b/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md index 6e4eb3c..a2fbed2 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md +++ b/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md @@ -12,7 +12,7 @@ title: SettlementModuleEvents > **SettlementModuleEvents**: `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:57](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/SettlementModule.ts#L57) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L57) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md b/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md index 979fc5a..3ce8cc1 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md +++ b/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md @@ -12,7 +12,7 @@ title: SomeRuntimeMethod > **SomeRuntimeMethod**: (...`args`) => `Promise`\<`unknown`\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L35) ## Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md b/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md index 5e254a3..8716315 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md +++ b/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md @@ -12,4 +12,4 @@ title: StateRecord > **StateRecord**: `Record`\<`string`, `Field`[] \| `undefined`\> -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:35](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L35) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md b/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md index c0eb45b..016d43b 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md @@ -12,4 +12,4 @@ title: TaskStateRecord > **TaskStateRecord**: `Record`\<`string`, `Field`[]\> -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:32](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L32) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md index 30e074e..f0af0eb 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md @@ -12,4 +12,4 @@ title: TaskWorkerModulesRecord > **TaskWorkerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](TypedClass.md)\<[`TaskWorkerModule`](../classes/TaskWorkerModule.md) & [`Task`](../interfaces/Task.md)\<`any`, `any`\>\>\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:41](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L41) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L41) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md index 58a61e6..902ad29 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md @@ -12,4 +12,4 @@ title: TaskWorkerModulesWithoutSettlement > **TaskWorkerModulesWithoutSettlement**: [`ReturnType`](../../protocol/type-aliases/ReturnType.md)\<*typeof* [`withoutSettlement`](../classes/VanillaTaskWorkerModules.md#withoutsettlement)\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:168](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L168) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:168](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L168) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md index 401826d..2ffb43d 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md @@ -12,4 +12,4 @@ title: TransactionProvingTaskParameters > **TransactionProvingTaskParameters**: [`PairingDerivedInput`](../interfaces/PairingDerivedInput.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md), `RuntimeProof`, [`BlockProverParameters`](../interfaces/BlockProverParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:42](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L42) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md index 70e7e69..a09157b 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md @@ -12,7 +12,7 @@ title: TransactionTaskArgs > **TransactionTaskArgs**: `object` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:49](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L49) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L49) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md index 85d1976..261d20a 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md @@ -12,7 +12,7 @@ title: TransactionTaskResult > **TransactionTaskResult**: `object` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:54](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L54) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L54) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md b/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md index 5eb0a65..b2f9ffb 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md +++ b/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md @@ -12,7 +12,7 @@ title: UnsignedTransactionBody > **UnsignedTransactionBody**: `object` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:17](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/mempool/PendingTransaction.ts#L17) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L17) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md b/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md index 6e112c4..84c8b5c 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md +++ b/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md @@ -12,7 +12,7 @@ title: VerificationKeyJSON > **VerificationKeyJSON**: `object` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L3) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L3) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/variables/Block.md b/src/pages/docs/reference/sequencer/variables/Block.md index a668c6c..baa3883 100644 --- a/src/pages/docs/reference/sequencer/variables/Block.md +++ b/src/pages/docs/reference/sequencer/variables/Block.md @@ -12,7 +12,7 @@ title: Block > **Block**: `object` -Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L22) +Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L22) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/variables/BlockWithResult.md b/src/pages/docs/reference/sequencer/variables/BlockWithResult.md index b987186..6ed008a 100644 --- a/src/pages/docs/reference/sequencer/variables/BlockWithResult.md +++ b/src/pages/docs/reference/sequencer/variables/BlockWithResult.md @@ -12,7 +12,7 @@ title: BlockWithResult > **BlockWithResult**: `object` -Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/storage/model/Block.ts#L59) +Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L59) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md b/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md index 3feec66..e0dac7b 100644 --- a/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md +++ b/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md @@ -12,7 +12,7 @@ title: JSONTaskSerializer > `const` **JSONTaskSerializer**: `object` -Defined in: [packages/sequencer/src/worker/flow/JSONTaskSerializer.ts:3](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/worker/flow/JSONTaskSerializer.ts#L3) +Defined in: [packages/sequencer/src/worker/flow/JSONTaskSerializer.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/JSONTaskSerializer.ts#L3) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md b/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md index 5f7b5fe..f509fee 100644 --- a/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md +++ b/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md @@ -12,7 +12,7 @@ title: QueryBuilderFactory > `const` **QueryBuilderFactory**: `object` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:71](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L71) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L71) ## Type declaration diff --git a/src/pages/docs/reference/stack/classes/TestBalances.md b/src/pages/docs/reference/stack/classes/TestBalances.md index e760196..c986aee 100644 --- a/src/pages/docs/reference/stack/classes/TestBalances.md +++ b/src/pages/docs/reference/stack/classes/TestBalances.md @@ -10,7 +10,7 @@ title: TestBalances # Class: TestBalances -Defined in: [stack/src/scripts/graphql/server.ts:51](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/stack/src/scripts/graphql/server.ts#L51) +Defined in: [stack/src/scripts/graphql/server.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/stack/src/scripts/graphql/server.ts#L51) Base class for runtime modules providing the necessary utilities. @@ -133,7 +133,7 @@ Holds all method names that are callable throw transactions > **totalSupply**: [`State`](../../protocol/classes/State.md)\<[`UInt64`](../../library/classes/UInt64.md)\> -Defined in: [stack/src/scripts/graphql/server.ts:58](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/stack/src/scripts/graphql/server.ts#L58) +Defined in: [stack/src/scripts/graphql/server.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/stack/src/scripts/graphql/server.ts#L58) We use `satisfies` here in order to be able to access presets by key in a type safe way. @@ -226,7 +226,7 @@ Defined in: module/dist/runtime/RuntimeModule.d.ts:33 > **addBalance**(`tokenId`, `address`, `balance`): `Promise`\<`void`\> -Defined in: [stack/src/scripts/graphql/server.ts:69](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/stack/src/scripts/graphql/server.ts#L69) +Defined in: [stack/src/scripts/graphql/server.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/stack/src/scripts/graphql/server.ts#L69) #### Parameters @@ -330,7 +330,7 @@ Defined in: library/dist/runtime/Balances.d.ts:85 > **getBalanceForUser**(`tokenId`, `address`): `Promise`\<[`Balance`](../../library/classes/Balance.md)\> -Defined in: [stack/src/scripts/graphql/server.ts:61](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/stack/src/scripts/graphql/server.ts#L61) +Defined in: [stack/src/scripts/graphql/server.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/stack/src/scripts/graphql/server.ts#L61) #### Parameters diff --git a/src/pages/docs/reference/stack/functions/startServer.md b/src/pages/docs/reference/stack/functions/startServer.md index 0c5e654..a7e4c5c 100644 --- a/src/pages/docs/reference/stack/functions/startServer.md +++ b/src/pages/docs/reference/stack/functions/startServer.md @@ -12,7 +12,7 @@ title: startServer > **startServer**(): `Promise`\<[`AppChain`](../../sdk/classes/AppChain.md)\<`object` & `object`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `Graphql`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md)\<\{ `BatchStorageResolver`: *typeof* [`BatchStorageResolver`](../../api/classes/BatchStorageResolver.md); `BlockResolver`: *typeof* [`BlockResolver`](../../api/classes/BlockResolver.md); `MempoolResolver`: *typeof* [`MempoolResolver`](../../api/classes/MempoolResolver.md); `MerkleWitnessResolver`: *typeof* [`MerkleWitnessResolver`](../../api/classes/MerkleWitnessResolver.md); `NodeStatusResolver`: *typeof* [`NodeStatusResolver`](../../api/classes/NodeStatusResolver.md); `QueryGraphqlModule`: *typeof* [`QueryGraphqlModule`](../../api/classes/QueryGraphqlModule.md); \}\>\>; `GraphqlServer`: *typeof* [`GraphqlServer`](../../api/classes/GraphqlServer.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](../../sdk/classes/BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](../../sdk/classes/StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](../../sdk/classes/InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](../../sdk/classes/InMemoryTransactionSender.md); \}\>\> -Defined in: [stack/src/scripts/graphql/server.ts:87](https://github.com/proto-kit/framework/blob/28efa802e3737fc3b77339148b307ef7246f3ef1/packages/stack/src/scripts/graphql/server.ts#L87) +Defined in: [stack/src/scripts/graphql/server.ts:87](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/stack/src/scripts/graphql/server.ts#L87) ## Returns diff --git a/src/pages/docs/workers.mdx b/src/pages/docs/workers.mdx deleted file mode 100644 index 58a56a9..0000000 --- a/src/pages/docs/workers.mdx +++ /dev/null @@ -1,75 +0,0 @@ -# Worker Architecture - -All sequencer modules are registered, resolved and then started when the AppChain is started. Several of these modules -are what define the process to be a worker. This can be considered a lightweight instance of the AppChain that is responsible -for executing expensive asynchronous `tasks`, such as Block Proving, so that the main AppChain isn't blocked by them. For testing purposes, -it is fine to have the main AppChain be the worker, but in production set-ups you will likely want multiple workers defined, -separately. - -## LocalTaskWorkerModule - -This module is used to create a worker locally. Without this being defined in some process no worker will be spawned and -this means no tasks will be processed. This module is itself defined with several tasks that it will be capable of executing, such as - - StateTransitionTask, - - StateTransitionReductionTask, - - RuntimeProvingTask, - - BlockProvingTask, - - BlockReductionTask, - - BlockBuildingTak, - - NewBlockTask, - - CircuitCompilerTask - - WorkerRegistrationTask. - -When the `LocalTaskWorkerModule` is started it has a set of start-up tasks, like those above, passed to it. These tasks basically -define what sort of computations the worker can handle, as you may want different workers to handle different tasks for resourcing reasons. -There are two types of tasks: `Unprepared`, i.e. tasks that don’t have a prepare method and therefore don’t need to wait for registration to get initialized, and - `Regular`, i.e. all other tasks that require registration. - -When the worker is started it first registers the required callback functions for the `Unprepared` tasks, i.e. `CircuitCompilerTask` and `WorkerRegistrationTask`, -with its local instance of the queue. Then, the `LocalTaskWorkerModule` calls the `prepare` method for non-startup/normal tasks, before registering their callbacks with the queue. -This registration ensures the worker is ready to handle any request when one later arrives via the queue. Once all the tasks are registered a promise is resolved, called `prepareResolve`. -This tells the `LocalTaskWorkerModule` it is ready, and the `LocalTaskWorkerModule` emits a `ready` event of its own that other modules like the `WorkerReadyModule` are waiting for to proceed. - -## WorkerReadyModule - -This is another sequencer module that waits until key events have been emitted by the `LocalTaskWorkerModule` to signal that the worker -is ready and that the AppChain can continue. The `WorkerReadyModule` is called by the `AppChain.ts` at the end of the `start()` method. -If the `waitForReady()` method on the `WorkerReadyModule` is never resolved then the AppChain will never finish its start-up. Note that the -`waitForReady()` will always complete if the AppChain is not a worker, in particular if `LocalTaskWorkerModule` is not defined. - -## SequencerStartUpModule -This is module is designed to ensure that all zk-circuits are compiled and their verification keys are accessible to the workers that -will need them. This spares workers from having to waste resources compiling the circuits themselves. This is achieved by having the AppChain -use the verification keys, and compilation artifacts, which are static parameters, as input to the `WorkerRegistrationFlow`. This in turns leaves -it as a task on the queue. A worker when starting-up will process the task that has been pushed onto the queue and access these static parameters -that way. In order for subsequent workers to have access to the same task, which will be removed from the queue after having been executed, the -sequencer uses the `WorkerRegistrationFlow` to push the same task again in a boundless loop. This loop consumes no resources as it is just a `Promise` that -awaits until a worker has registered. We ensure it's the new worker that picks up this task from the queue and not an older worker that is already configured, -by having the old worker be configured to delete the task-handler for the registration from its local queue so that it can't handle that particular kind of task, anymore. - -## Worker Start-up Flow -A summary of the worker registration flow: -1. The `LocalTaskWorkerModule` creates a worker. -2. The worker is started, which registers the callbacks for `Unprepared` tasks with the queue. -3. The worker calls the `prepare()` method for the `Regular` tasks. -4. The worker registers `Regular` tasks with the queue. -5. The AppChain, specifically `SequencerStartupModule`, compiles the zk-circuits of the various zk-Programs. -6. The `SequencerStartupModule` invokes the `WorkerRegistrationFlow` and submits a `WorkerRegistration` task to the queue. -7. The worker listens to the queue and processes the `WorkerRegistration` task. -8. The AppChain continues and starts submitting tasks to the queue, which the worker processes. - - -## TaskQueue -The TaskQueue has two different implementations: - -### BullQueue -This is Redis underneath. Each worker registers to consume specific jobs. Redis takes care of a lot of the implementation details. -This uses a separate Redis instance, whose configuration details are shared with the AppChain on start-up. -In the starter-kit, this is run from Docker. - -### LocalTaskQueue -This can only be used by one worker built into the AppChain, as it's not really a queue, executing tasks directly where possible. -The `workNextTasks()` is called whenever a task is added to the queue and again after tasks have already been executed (in case any others have been added in the meanwhile). -The `LocalTaskQueue` isn't suitable for production usage because it runs only one instance in-process. But for mock-proofs it's good enough. - - From afc32c06e513246f3369929578fb7f169858d281 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Mon, 3 Feb 2025 16:01:39 +0100 Subject: [PATCH 14/37] document typedoc generation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c6bef08..7b63ee1 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Then, run `pnpm dev` to start the development server and visit localhost:3000. ## Typedoc generation -Typedoc / reference docs must be generated in the `framework` repo first, and then it can be copied over by running `pnpm run typedoc:replace`. This will also generate all the necessary `_meta.tsx` files for Nextra.js. +Run `pnpm run typedoc:generate` to generate reference documentation from the framework's typedoc. ## License From 747c677af2713fc9e1cb9ef1975d7b5cc627ba5f Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Mon, 3 Feb 2025 16:02:47 +0100 Subject: [PATCH 15/37] remove framework from gitignore --- .gitignore | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index bdb63ac..7bf1de1 100644 --- a/.gitignore +++ b/.gitignore @@ -2,5 +2,4 @@ node_modules .DS_Store .git -.idea -framework \ No newline at end of file +.idea \ No newline at end of file From 09503767b0b3adcb5f54554072a491a3400cc1b4 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 11:15:09 +0100 Subject: [PATCH 16/37] remove reference docs from version control --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 7bf1de1..fe59072 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,5 @@ node_modules .DS_Store .git -.idea \ No newline at end of file +.idea +src/pages/docs/reference \ No newline at end of file From e84e9a5b06297142592890f8c81b8cc45a139869 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 11:16:22 +0100 Subject: [PATCH 17/37] generate typedoc from framework's develop directly --- generate-typedoc.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/generate-typedoc.sh b/generate-typedoc.sh index 1477829..655f620 100755 --- a/generate-typedoc.sh +++ b/generate-typedoc.sh @@ -3,7 +3,7 @@ git clone git@github.com:proto-kit/framework.git ./../framework-typedoc cd ./../framework-typedoc # git checkout develop -git checkout feature/typedoc +git checkout develop npm ci --force npm run prisma:generate npm run build From 67e17ba81be1dab477258a58fea5bd9754753a1f Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 11:20:51 +0100 Subject: [PATCH 18/37] generate typedoc after installing deps --- package.json | 1 + src/pages/docs/reference/api/_meta.tsx | 2 +- .../api/classes/AdvancedNodeStatusResolver.md | 6 +- .../api/classes/BatchStorageResolver.md | 6 +- .../docs/reference/api/classes/BlockModel.md | 14 +- .../reference/api/classes/BlockResolver.md | 6 +- .../api/classes/ComputedBlockModel.md | 10 +- .../reference/api/classes/GraphqlModule.md | 4 +- .../api/classes/GraphqlSequencerModule.md | 10 +- .../reference/api/classes/GraphqlServer.md | 18 +-- .../reference/api/classes/MempoolResolver.md | 10 +- .../reference/api/classes/MerkleWitnessDTO.md | 10 +- .../api/classes/MerkleWitnessResolver.md | 6 +- .../api/classes/NodeInformationObject.md | 10 +- .../reference/api/classes/NodeStatusObject.md | 10 +- .../api/classes/NodeStatusResolver.md | 6 +- .../api/classes/NodeStatusService.md | 8 +- .../api/classes/ProcessInformationObject.md | 20 +-- .../api/classes/QueryGraphqlModule.md | 14 +- .../classes/ResolverFactoryGraphqlModule.md | 6 +- .../classes/SchemaGeneratingGraphqlModule.md | 6 +- .../docs/reference/api/classes/Signature.md | 8 +- .../api/classes/TransactionObject.md | 22 +-- .../api/classes/VanillaGraphqlModules.md | 6 +- .../reference/api/functions/graphqlModule.md | 2 +- src/pages/docs/reference/api/globals.md | 51 ------- .../api/interfaces/GraphqlModulesDefintion.md | 6 +- .../api/interfaces/NodeInformation.md | 6 +- .../api/interfaces/ProcessInformation.md | 16 +-- .../api/type-aliases/GraphqlModulesRecord.md | 2 +- .../VanillaGraphqlModulesRecord.md | 2 +- src/pages/docs/reference/common/_meta.tsx | 2 +- .../common/classes/AtomicCompileHelper.md | 6 +- .../classes/ChildVerificationKeyService.md | 6 +- .../common/classes/CompileRegistry.md | 14 +- .../common/classes/ConfigurableModule.md | 10 +- .../reference/common/classes/EventEmitter.md | 14 +- .../common/classes/EventEmitterProxy.md | 16 +-- .../classes/InMemoryMerkleTreeStorage.md | 8 +- .../classes/MockAsyncMerkleTreeStore.md | 12 +- .../common/classes/ModuleContainer.md | 50 +++---- .../classes/ProvableMethodExecutionContext.md | 22 +-- .../classes/ProvableMethodExecutionResult.md | 12 +- .../classes/ReplayingSingleUseEventEmitter.md | 16 +-- .../common/classes/RollupMerkleTree.md | 28 ++-- .../common/classes/RollupMerkleTreeWitness.md | 20 +-- .../common/classes/ZkProgrammable.md | 10 +- .../functions/assertValidTextLogLevel.md | 2 +- .../common/functions/compileToMockable.md | 2 +- .../common/functions/createMerkleTree.md | 2 +- .../reference/common/functions/dummyValue.md | 2 +- .../common/functions/expectDefined.md | 2 +- .../common/functions/filterNonNull.md | 2 +- .../common/functions/filterNonUndefined.md | 2 +- .../common/functions/getInjectAliases.md | 2 +- .../common/functions/hashWithPrefix.md | 2 +- .../reference/common/functions/implement.md | 2 +- .../reference/common/functions/injectAlias.md | 2 +- .../common/functions/injectOptional.md | 2 +- .../common/functions/isSubtypeOfName.md | 2 +- .../common/functions/mapSequential.md | 2 +- .../docs/reference/common/functions/noop.md | 2 +- .../common/functions/prefixToField.md | 2 +- .../common/functions/provableMethod.md | 2 +- .../docs/reference/common/functions/range.md | 2 +- .../common/functions/reduceSequential.md | 2 +- .../reference/common/functions/requireTrue.md | 2 +- .../common/functions/safeParseJson.md | 2 +- .../docs/reference/common/functions/sleep.md | 2 +- .../reference/common/functions/splitArray.md | 2 +- .../reference/common/functions/toProver.md | 2 +- .../common/functions/verifyToMockable.md | 2 +- src/pages/docs/reference/common/globals.md | 136 ------------------ .../common/interfaces/AbstractMerkleTree.md | 18 +-- .../interfaces/AbstractMerkleTreeClass.md | 12 +- .../interfaces/AbstractMerkleWitness.md | 18 +-- .../common/interfaces/AreProofsEnabled.md | 6 +- .../interfaces/BaseModuleInstanceType.md | 6 +- .../interfaces/ChildContainerCreatable.md | 4 +- .../interfaces/ChildContainerProvider.md | 4 +- .../common/interfaces/CompilableModule.md | 4 +- .../reference/common/interfaces/Compile.md | 4 +- .../common/interfaces/CompileArtifact.md | 4 +- .../common/interfaces/Configurable.md | 4 +- .../common/interfaces/DependencyFactory.md | 4 +- .../interfaces/EventEmittingComponent.md | 4 +- .../interfaces/EventEmittingContainer.md | 4 +- .../common/interfaces/MerkleTreeStore.md | 6 +- .../interfaces/ModuleContainerDefinition.md | 6 +- .../common/interfaces/ModulesRecord.md | 2 +- .../common/interfaces/PlainZkProgram.md | 14 +- .../interfaces/StaticConfigurableModule.md | 4 +- .../common/interfaces/ToFieldable.md | 4 +- .../common/interfaces/ToFieldableStatic.md | 4 +- .../common/interfaces/ToJSONableStatic.md | 4 +- .../reference/common/interfaces/Verify.md | 4 +- .../common/interfaces/WithZkProgrammable.md | 4 +- .../common/type-aliases/ArgumentTypes.md | 2 +- .../common/type-aliases/ArrayElement.md | 2 +- .../common/type-aliases/ArtifactRecord.md | 2 +- .../common/type-aliases/BaseModuleType.md | 2 +- .../common/type-aliases/CapitalizeAny.md | 2 +- .../common/type-aliases/CastToEventsRecord.md | 2 +- .../common/type-aliases/CompileTarget.md | 2 +- .../common/type-aliases/ContainerEvents.md | 2 +- .../common/type-aliases/DecoratedMethod.md | 2 +- .../type-aliases/DependenciesFromModules.md | 2 +- .../type-aliases/DependencyDeclaration.md | 2 +- .../common/type-aliases/DependencyRecord.md | 2 +- .../common/type-aliases/EventListenable.md | 2 +- .../common/type-aliases/EventsRecord.md | 2 +- .../common/type-aliases/FilterNeverValues.md | 2 +- .../common/type-aliases/FlattenObject.md | 2 +- .../type-aliases/FlattenedContainerEvents.md | 2 +- .../common/type-aliases/InferDependencies.md | 2 +- .../common/type-aliases/InferProofBase.md | 2 +- .../MapDependencyRecordToTypes.md | 2 +- .../common/type-aliases/MergeObjects.md | 2 +- .../common/type-aliases/ModuleEvents.md | 2 +- .../common/type-aliases/ModulesConfig.md | 2 +- .../reference/common/type-aliases/NoConfig.md | 2 +- .../common/type-aliases/NonMethods.md | 2 +- .../common/type-aliases/O1JSPrimitive.md | 2 +- .../reference/common/type-aliases/OmitKeys.md | 2 +- .../type-aliases/OverwriteObjectType.md | 2 +- .../reference/common/type-aliases/Preset.md | 2 +- .../reference/common/type-aliases/Presets.md | 2 +- .../common/type-aliases/ProofTypes.md | 2 +- .../common/type-aliases/RecursivePartial.md | 2 +- .../common/type-aliases/ResolvableModules.md | 2 +- .../common/type-aliases/StringKeyOf.md | 2 +- .../TypeFromDependencyDeclaration.md | 2 +- .../common/type-aliases/TypedClass.md | 2 +- .../common/type-aliases/UnTypedClass.md | 2 +- .../type-aliases/UnionToIntersection.md | 2 +- .../common/variables/EMPTY_PUBLICKEY.md | 2 +- .../common/variables/EMPTY_PUBLICKEY_X.md | 2 +- .../reference/common/variables/MAX_FIELD.md | 2 +- .../reference/common/variables/MOCK_PROOF.md | 2 +- .../common/variables/MOCK_VERIFICATION_KEY.md | 2 +- .../common/variables/ModuleContainerErrors.md | 2 +- .../variables/injectAliasMetadataKey.md | 2 +- .../docs/reference/common/variables/log.md | 2 +- .../reference/deployment/classes/BullQueue.md | 10 +- .../deployment/classes/Environment.md | 12 +- .../deployment/interfaces/BullQueueConfig.md | 6 +- .../deployment/interfaces/Startable.md | 4 +- .../type-aliases/StartableEnvironment.md | 2 +- src/pages/docs/reference/indexer/_meta.tsx | 2 +- .../GeneratedResolverFactoryGraphqlModule.md | 10 +- .../indexer/classes/IndexBlockTask.md | 18 +-- .../IndexBlockTaskParametersSerializer.md | 14 +- .../docs/reference/indexer/classes/Indexer.md | 8 +- .../indexer/classes/IndexerModule.md | 4 +- .../indexer/classes/IndexerNotifier.md | 14 +- .../indexer/functions/ValidateTakeArg.md | 2 +- .../indexer/functions/cleanResolvers.md | 2 +- src/pages/docs/reference/indexer/globals.md | 34 ----- .../interfaces/IndexBlockTaskParameters.md | 2 +- .../type-aliases/IndexerModulesRecord.md | 2 +- .../NotifierMandatorySequencerModules.md | 2 +- src/pages/docs/reference/library/_meta.tsx | 2 +- .../docs/reference/library/classes/Balance.md | 72 +++++----- .../reference/library/classes/Balances.md | 16 +-- .../reference/library/classes/BalancesKey.md | 8 +- .../docs/reference/library/classes/FeeTree.md | 2 +- .../classes/InMemorySequencerModules.md | 4 +- .../library/classes/MethodFeeConfigData.md | 12 +- .../classes/RuntimeFeeAnalyzerService.md | 18 +-- .../library/classes/SimpleSequencerModules.md | 14 +- .../docs/reference/library/classes/TokenId.md | 2 +- .../library/classes/TransactionFeeHook.md | 52 ++++--- .../docs/reference/library/classes/UInt.md | 60 ++++---- .../docs/reference/library/classes/UInt112.md | 74 +++++----- .../docs/reference/library/classes/UInt224.md | 72 +++++----- .../docs/reference/library/classes/UInt32.md | 74 +++++----- .../docs/reference/library/classes/UInt64.md | 72 +++++----- .../library/classes/VanillaProtocolModules.md | 10 +- .../library/classes/VanillaRuntimeModules.md | 6 +- .../library/classes/WithdrawalEvent.md | 6 +- .../library/classes/WithdrawalKey.md | 6 +- .../reference/library/classes/Withdrawals.md | 14 +- src/pages/docs/reference/library/globals.md | 60 -------- .../library/interfaces/BalancesEvents.md | 4 +- .../library/interfaces/FeeIndexes.md | 2 +- .../library/interfaces/FeeTreeValues.md | 2 +- .../library/interfaces/MethodFeeConfig.md | 10 +- .../RuntimeFeeAnalyzerServiceConfig.md | 12 +- .../interfaces/TransactionFeeHookConfig.md | 12 +- .../AdditionalSequencerModules.md | 2 +- .../InMemorySequencerModulesRecord.md | 2 +- .../library/type-aliases/MinimalBalances.md | 2 +- .../MinimumAdditionalSequencerModules.md | 2 +- .../SimpleSequencerModulesRecord.md | 2 +- .../SimpleSequencerWorkerModulesRecord.md | 2 +- .../library/type-aliases/UIntConstructor.md | 2 +- .../VanillaProtocolModulesRecord.md | 2 +- .../VanillaRuntimeModulesRecord.md | 2 +- .../reference/library/variables/errors.md | 2 +- .../library/variables/treeFeeHeight.md | 2 +- .../module/classes/InMemoryStateService.md | 8 +- .../module/classes/MethodIdFactory.md | 4 +- .../module/classes/MethodIdResolver.md | 10 +- .../module/classes/MethodParameterEncoder.md | 14 +- .../docs/reference/module/classes/Runtime.md | 32 ++--- .../reference/module/classes/RuntimeEvents.md | 8 +- .../reference/module/classes/RuntimeModule.md | 22 +-- .../module/classes/RuntimeZkProgrammable.md | 10 +- .../module/functions/combineMethodName.md | 2 +- .../module/functions/getAllPropertyNames.md | 2 +- .../module/functions/isRuntimeMethod.md | 2 +- .../module/functions/runtimeMessage.md | 2 +- .../module/functions/runtimeMethod.md | 2 +- .../module/functions/runtimeModule.md | 2 +- .../docs/reference/module/functions/state.md | 2 +- .../module/functions/toEventsHash.md | 2 +- .../functions/toStateTransitionsHash.md | 2 +- .../module/functions/toWrappedMethod.md | 2 +- src/pages/docs/reference/module/globals.md | 2 + .../module/interfaces/RuntimeDefinition.md | 6 +- .../module/interfaces/RuntimeEnvironment.md | 10 +- .../module/type-aliases/AsyncWrappedMethod.md | 2 +- .../RuntimeMethodInvocationType.md | 2 +- .../type-aliases/RuntimeModulesRecord.md | 2 +- .../module/type-aliases/WrappedMethod.md | 2 +- .../variables/runtimeMethodMetadataKey.md | 2 +- .../runtimeMethodNamesMetadataKey.md | 2 +- .../variables/runtimeMethodTypeMetadataKey.md | 2 +- .../docs/reference/persistance/_meta.tsx | 2 +- .../persistance/classes/BatchMapper.md | 6 +- .../persistance/classes/BlockMapper.md | 6 +- .../persistance/classes/BlockResultMapper.md | 8 +- .../persistance/classes/FieldMapper.md | 6 +- .../persistance/classes/PrismaBatchStore.md | 12 +- .../persistance/classes/PrismaBlockStorage.md | 20 +-- .../classes/PrismaDatabaseConnection.md | 14 +- .../classes/PrismaMessageStorage.md | 8 +- .../classes/PrismaRedisDatabase.md | 26 ++-- .../classes/PrismaSettlementStorage.md | 6 +- .../persistance/classes/PrismaStateService.md | 14 +- .../classes/PrismaTransactionStorage.md | 10 +- .../classes/RedisConnectionModule.md | 20 +-- .../classes/RedisMerkleTreeStore.md | 12 +- .../persistance/classes/SettlementMapper.md | 6 +- .../classes/StateTransitionArrayMapper.md | 8 +- .../classes/StateTransitionMapper.md | 6 +- .../TransactionExecutionResultMapper.md | 8 +- .../persistance/classes/TransactionMapper.md | 6 +- .../docs/reference/persistance/globals.md | 45 ------ .../interfaces/PrismaConnection.md | 4 +- .../interfaces/PrismaDatabaseConfig.md | 4 +- .../interfaces/PrismaRedisCombinedConfig.md | 6 +- .../persistance/interfaces/RedisConnection.md | 6 +- .../interfaces/RedisConnectionConfig.md | 10 +- .../type-aliases/RedisTransaction.md | 2 +- src/pages/docs/reference/processor/_meta.tsx | 2 +- .../processor/classes/BlockFetching.md | 14 +- .../reference/processor/classes/Database.md | 14 +- .../processor/classes/DatabasePruneModule.md | 6 +- .../processor/classes/HandlersExecutor.md | 20 +-- .../reference/processor/classes/Processor.md | 6 +- .../processor/classes/ProcessorModule.md | 4 +- .../classes/ResolverFactoryGraphqlModule.md | 14 +- .../classes/TimedProcessorTrigger.md | 18 +-- .../processor/functions/ValidateTakeArg.md | 2 +- .../processor/functions/cleanResolvers.md | 2 +- src/pages/docs/reference/processor/globals.md | 42 ------ .../interfaces/BlockFetchingConfig.md | 4 +- .../processor/interfaces/BlockResponse.md | 4 +- .../interfaces/DatabasePruneModuleConfig.md | 4 +- .../interfaces/HandlersExecutorConfig.md | 6 +- .../processor/interfaces/HandlersRecord.md | 4 +- .../interfaces/TimedProcessorTriggerConfig.md | 4 +- .../processor/type-aliases/BlockHandler.md | 2 +- .../type-aliases/ClientTransaction.md | 2 +- .../type-aliases/ProcessorModulesRecord.md | 2 +- .../protocol/classes/AccountState.md | 4 +- .../protocol/classes/AccountStateHook.md | 16 +-- .../protocol/classes/BlockHashMerkleTree.md | 2 +- .../classes/BlockHashMerkleTreeWitness.md | 2 +- .../protocol/classes/BlockHashTreeEntry.md | 8 +- .../protocol/classes/BlockHeightHook.md | 16 +-- .../reference/protocol/classes/BlockProver.md | 26 ++-- .../classes/BlockProverExecutionData.md | 8 +- .../classes/BlockProverProgrammable.md | 24 ++-- .../classes/BlockProverPublicInput.md | 16 +-- .../classes/BlockProverPublicOutput.md | 20 +-- .../protocol/classes/BridgeContract.md | 26 ++-- .../protocol/classes/BridgeContractBase.md | 20 +-- .../classes/BridgeContractProtocolModule.md | 6 +- .../protocol/classes/ContractModule.md | 6 +- .../protocol/classes/CurrentBlock.md | 4 +- .../classes/DefaultProvableHashList.md | 16 +-- .../reference/protocol/classes/Deposit.md | 8 +- .../classes/DispatchContractProtocolModule.md | 10 +- .../protocol/classes/DispatchSmartContract.md | 32 ++--- .../classes/DispatchSmartContractBase.md | 24 ++-- .../protocol/classes/DynamicBlockProof.md | 8 +- .../protocol/classes/DynamicRuntimeProof.md | 8 +- .../classes/LastStateRootBlockHook.md | 16 +-- .../protocol/classes/MethodPublicOutput.md | 14 +- .../protocol/classes/MethodVKConfigData.md | 8 +- .../reference/protocol/classes/MinaActions.md | 4 +- .../protocol/classes/MinaActionsHashList.md | 18 +-- .../reference/protocol/classes/MinaEvents.md | 4 +- .../classes/MinaPrefixedProvableHashList.md | 18 +-- .../protocol/classes/NetworkState.md | 10 +- .../classes/NetworkStateSettlementModule.md | 12 +- .../docs/reference/protocol/classes/Option.md | 36 ++--- .../reference/protocol/classes/OptionBase.md | 22 +-- .../classes/OutgoingMessageArgument.md | 8 +- .../classes/OutgoingMessageArgumentBatch.md | 8 +- .../protocol/classes/OutgoingMessageKey.md | 6 +- .../docs/reference/protocol/classes/Path.md | 8 +- .../classes/PrefixedProvableHashList.md | 16 +-- .../protocol/classes/PreviousBlock.md | 4 +- .../reference/protocol/classes/Protocol.md | 26 ++-- .../protocol/classes/ProtocolModule.md | 10 +- .../protocol/classes/ProvableBlockHook.md | 16 +-- .../protocol/classes/ProvableHashList.md | 16 +-- .../protocol/classes/ProvableOption.md | 8 +- .../classes/ProvableReductionHashList.md | 20 +-- .../classes/ProvableSettlementHook.md | 12 +- .../classes/ProvableStateTransition.md | 10 +- .../classes/ProvableStateTransitionType.md | 12 +- .../classes/ProvableTransactionHook.md | 14 +- .../protocol/classes/PublicKeyOption.md | 10 +- .../classes/RuntimeMethodExecutionContext.md | 28 ++-- .../RuntimeMethodExecutionDataStruct.md | 6 +- .../RuntimeProvableMethodExecutionResult.md | 12 +- .../protocol/classes/RuntimeTransaction.md | 24 ++-- .../RuntimeVerificationKeyAttestation.md | 6 +- .../RuntimeVerificationKeyRootService.md | 6 +- .../classes/SettlementContractModule.md | 26 ++-- .../SettlementContractProtocolModule.md | 8 +- .../classes/SettlementSmartContract.md | 36 ++--- .../classes/SettlementSmartContractBase.md | 28 ++-- .../protocol/classes/SignedTransaction.md | 16 +-- .../docs/reference/protocol/classes/State.md | 20 +-- .../reference/protocol/classes/StateMap.md | 24 ++-- .../protocol/classes/StateServiceProvider.md | 8 +- .../protocol/classes/StateTransition.md | 24 ++-- .../classes/StateTransitionProvableBatch.md | 12 +- .../protocol/classes/StateTransitionProver.md | 20 +-- .../StateTransitionProverProgrammable.md | 16 +-- .../StateTransitionProverPublicInput.md | 10 +- .../StateTransitionProverPublicOutput.md | 10 +- .../classes/StateTransitionReductionList.md | 22 +-- .../protocol/classes/StateTransitionType.md | 10 +- .../classes/TokenBridgeAttestation.md | 6 +- .../classes/TokenBridgeDeploymentAuth.md | 10 +- .../protocol/classes/TokenBridgeEntry.md | 8 +- .../protocol/classes/TokenBridgeTree.md | 8 +- .../classes/TokenBridgeTreeAddition.md | 6 +- .../classes/TokenBridgeTreeWitness.md | 2 +- .../protocol/classes/TokenMapping.md | 6 +- .../TransitionMethodExecutionResult.md | 4 +- .../protocol/classes/UInt64Option.md | 10 +- .../classes/UpdateMessagesHashAuth.md | 10 +- .../docs/reference/protocol/classes/VKTree.md | 2 +- .../protocol/classes/VKTreeWitness.md | 2 +- .../reference/protocol/classes/WithPath.md | 6 +- .../classes/WithStateServiceProvider.md | 6 +- .../reference/protocol/classes/Withdrawal.md | 10 +- .../reference/protocol/functions/assert.md | 2 +- .../protocol/functions/emptyActions.md | 2 +- .../protocol/functions/emptyEvents.md | 2 +- .../protocol/functions/notInCircuit.md | 2 +- .../protocol/functions/protocolState.md | 2 +- .../functions/reduceStateTransitions.md | 2 +- .../protocol/functions/singleFieldToString.md | 2 +- .../protocol/functions/stringToField.md | 2 +- .../protocol/interfaces/BlockProvable.md | 8 +- .../protocol/interfaces/BlockProverState.md | 14 +- .../protocol/interfaces/BlockProverType.md | 16 +-- .../interfaces/ContractAuthorization.md | 6 +- .../interfaces/DispatchContractType.md | 10 +- .../interfaces/MinimalVKTreeService.md | 4 +- .../protocol/interfaces/ProtocolDefinition.md | 6 +- .../interfaces/ProtocolEnvironment.md | 8 +- .../protocol/interfaces/RuntimeLike.md | 4 +- .../interfaces/RuntimeMethodExecutionData.md | 6 +- .../interfaces/SettlementContractType.md | 12 +- .../interfaces/SimpleAsyncStateService.md | 6 +- .../interfaces/StateTransitionProvable.md | 6 +- .../interfaces/StateTransitionProverType.md | 14 +- .../TransitionMethodExecutionContext.md | 8 +- .../protocol/type-aliases/BlockProof.md | 2 +- .../protocol/type-aliases/BlockProverProof.md | 2 +- .../type-aliases/BridgeContractConfig.md | 2 +- .../type-aliases/BridgeContractType.md | 2 +- .../type-aliases/DispatchContractConfig.md | 2 +- .../protocol/type-aliases/InputBlockProof.md | 2 +- .../MandatoryProtocolModulesRecord.md | 2 +- .../MandatorySettlementModulesRecord.md | 2 +- .../type-aliases/ProtocolModulesRecord.md | 2 +- .../protocol/type-aliases/ReturnType.md | 2 +- .../type-aliases/RuntimeMethodIdMapping.md | 2 +- .../RuntimeMethodInvocationType.md | 2 +- .../protocol/type-aliases/RuntimeProof.md | 2 +- .../type-aliases/SettlementContractConfig.md | 2 +- .../type-aliases/SettlementHookInputs.md | 2 +- .../type-aliases/SettlementModulesRecord.md | 2 +- .../type-aliases/SettlementStateRecord.md | 2 +- .../SmartContractClassFromInterface.md | 2 +- .../type-aliases/StateTransitionProof.md | 2 +- .../protocol/type-aliases/Subclass.md | 2 +- .../protocol/variables/ACTIONS_EMPTY_HASH.md | 2 +- .../variables/BATCH_SIGNATURE_PREFIX.md | 2 +- .../protocol/variables/MINA_EVENT_PREFIXES.md | 2 +- .../variables/OUTGOING_MESSAGE_BATCH_SIZE.md | 2 +- .../protocol/variables/ProtocolConstants.md | 2 +- .../protocol/variables/treeFeeHeight.md | 2 +- .../docs/reference/sdk/classes/AppChain.md | 22 +-- .../reference/sdk/classes/AppChainModule.md | 6 +- .../sdk/classes/AppChainTransaction.md | 20 +-- .../sdk/classes/AreProofsEnabledFactory.md | 4 +- .../docs/reference/sdk/classes/AuroSigner.md | 8 +- .../classes/BlockStorageNetworkStateModule.md | 14 +- .../reference/sdk/classes/ClientAppChain.md | 24 ++-- .../reference/sdk/classes/GraphqlClient.md | 8 +- .../GraphqlNetworkStateTransportModule.md | 14 +- .../classes/GraphqlQueryTransportModule.md | 12 +- .../sdk/classes/GraphqlTransactionSender.md | 10 +- .../sdk/classes/InMemoryAreProofsEnabled.md | 6 +- .../reference/sdk/classes/InMemorySigner.md | 10 +- .../sdk/classes/InMemoryTransactionSender.md | 14 +- .../sdk/classes/SharedDependencyFactory.md | 4 +- .../sdk/classes/StateServiceQueryModule.md | 18 +-- .../reference/sdk/classes/TestingAppChain.md | 34 ++--- .../sdk/interfaces/AppChainConfig.md | 10 +- .../sdk/interfaces/AppChainDefinition.md | 10 +- .../interfaces/ExpandAppChainDefinition.md | 4 +- .../sdk/interfaces/GraphqlClientConfig.md | 4 +- .../sdk/interfaces/InMemorySignerConfig.md | 4 +- .../sdk/interfaces/SharedDependencyRecord.md | 6 +- .../docs/reference/sdk/interfaces/Signer.md | 4 +- .../sdk/interfaces/TransactionSender.md | 6 +- .../sdk/type-aliases/AppChainModulesRecord.md | 2 +- .../sdk/type-aliases/ExpandAppChainModules.md | 2 +- .../PartialVanillaRuntimeModulesRecord.md | 2 +- .../TestingSequencerModulesRecord.md | 2 +- .../sdk/variables/randomFeeRecipient.md | 2 +- .../sequencer/classes/AbstractTaskQueue.md | 12 +- .../classes/ArtifactRecordSerializer.md | 6 +- .../sequencer/classes/BatchProducerModule.md | 10 +- .../sequencer/classes/BlockProducerModule.md | 14 +- .../sequencer/classes/BlockProofSerializer.md | 6 +- .../sequencer/classes/BlockTaskFlowService.md | 10 +- .../sequencer/classes/BlockTriggerBase.md | 30 ++-- .../classes/CachedMerkleTreeStore.md | 28 ++-- .../sequencer/classes/CachedStateService.md | 22 +-- .../sequencer/classes/CompressedSignature.md | 12 +- .../sequencer/classes/DatabasePruneModule.md | 8 +- .../classes/DecodedStateSerializer.md | 6 +- .../sequencer/classes/DummyStateService.md | 6 +- .../classes/DynamicProofTaskSerializer.md | 14 +- .../docs/reference/sequencer/classes/Flow.md | 22 +-- .../sequencer/classes/FlowCreator.md | 6 +- .../sequencer/classes/FlowTaskWorker.md | 16 +-- .../classes/InMemoryAsyncMerkleTreeStore.md | 10 +- .../sequencer/classes/InMemoryBatchStorage.md | 10 +- .../sequencer/classes/InMemoryBlockStorage.md | 22 +-- .../sequencer/classes/InMemoryDatabase.md | 14 +- .../classes/InMemoryMessageStorage.md | 6 +- .../classes/InMemorySettlementStorage.md | 6 +- .../classes/InMemoryTransactionStorage.md | 10 +- .../sequencer/classes/ListenerList.md | 10 +- .../sequencer/classes/LocalTaskQueue.md | 22 +-- .../classes/LocalTaskWorkerModule.md | 14 +- .../sequencer/classes/ManualBlockTrigger.md | 32 ++--- .../sequencer/classes/MinaBaseLayer.md | 16 +-- .../classes/MinaIncomingMessageAdapter.md | 6 +- .../classes/MinaSimulationService.md | 10 +- .../classes/MinaTransactionSender.md | 6 +- .../classes/MinaTransactionSimulator.md | 20 +-- .../sequencer/classes/NetworkStateQuery.md | 10 +- .../NewBlockProvingParametersSerializer.md | 8 +- .../sequencer/classes/NewBlockTask.md | 14 +- .../sequencer/classes/NoopBaseLayer.md | 10 +- .../classes/PairProofTaskSerializer.md | 8 +- .../sequencer/classes/PendingTransaction.md | 36 ++--- .../classes/PreFilledStateService.md | 4 +- .../sequencer/classes/PrivateMempool.md | 16 +-- .../sequencer/classes/ProofTaskSerializer.md | 14 +- .../classes/ProvenSettlementPermissions.md | 10 +- .../sequencer/classes/ReductionTaskFlow.md | 12 +- .../RuntimeProofParametersSerializer.md | 6 +- .../sequencer/classes/RuntimeProvingTask.md | 18 +-- ...imeVerificationKeyAttestationSerializer.md | 6 +- .../reference/sequencer/classes/Sequencer.md | 14 +- .../sequencer/classes/SequencerModule.md | 6 +- .../classes/SequencerStartupModule.md | 12 +- .../sequencer/classes/SettlementModule.md | 32 ++--- .../classes/SettlementProvingTask.md | 16 +-- .../classes/SignedSettlementPermissions.md | 10 +- .../sequencer/classes/SomeProofSubclass.md | 6 +- .../StateTransitionParametersSerializer.md | 6 +- .../classes/StateTransitionReductionTask.md | 16 +-- .../sequencer/classes/StateTransitionTask.md | 16 +-- .../classes/SyncCachedMerkleTreeStore.md | 10 +- .../sequencer/classes/TaskWorkerModule.md | 2 +- .../sequencer/classes/TimedBlockTrigger.md | 32 ++--- .../classes/TransactionExecutionService.md | 6 +- .../classes/TransactionProvingTask.md | 14 +- ...ansactionProvingTaskParameterSerializer.md | 8 +- .../classes/TransactionTraceService.md | 6 +- .../sequencer/classes/UnsignedTransaction.md | 28 ++-- .../sequencer/classes/UntypedOption.md | 14 +- .../classes/UntypedStateTransition.md | 22 +-- .../classes/VanillaTaskWorkerModules.md | 12 +- .../classes/VerificationKeySerializer.md | 6 +- .../sequencer/classes/WithdrawalEvent.md | 6 +- .../sequencer/classes/WithdrawalKey.md | 6 +- .../sequencer/classes/WithdrawalQueue.md | 14 +- .../sequencer/classes/WorkerReadyModule.md | 6 +- .../sequencer/functions/closeable.md | 2 +- .../reference/sequencer/functions/distinct.md | 2 +- .../functions/distinctByPredicate.md | 2 +- .../sequencer/functions/distinctByString.md | 2 +- .../functions/executeWithExecutionContext.md | 2 +- .../sequencer/functions/sequencerModule.md | 2 +- .../interfaces/AsyncMerkleTreeStore.md | 10 +- .../sequencer/interfaces/AsyncStateService.md | 12 +- .../sequencer/interfaces/BaseLayer.md | 4 +- .../BaseLayerContractPermissions.md | 10 +- .../interfaces/BaseLayerDependencyRecord.md | 6 +- .../reference/sequencer/interfaces/Batch.md | 8 +- .../sequencer/interfaces/BatchStorage.md | 8 +- .../sequencer/interfaces/BatchTransaction.md | 8 +- .../reference/sequencer/interfaces/Block.md | 24 ++-- .../sequencer/interfaces/BlockConfig.md | 6 +- .../interfaces/BlockProverParameters.md | 10 +- .../sequencer/interfaces/BlockQueue.md | 10 +- .../sequencer/interfaces/BlockResult.md | 14 +- .../sequencer/interfaces/BlockStorage.md | 8 +- .../sequencer/interfaces/BlockTrace.md | 8 +- .../sequencer/interfaces/BlockTrigger.md | 2 +- .../interfaces/BlockWithMaybeResult.md | 6 +- .../interfaces/BlockWithPreviousResult.md | 6 +- .../sequencer/interfaces/BlockWithResult.md | 6 +- .../sequencer/interfaces/Closeable.md | 4 +- .../sequencer/interfaces/Database.md | 10 +- .../interfaces/HistoricalBatchStorage.md | 4 +- .../interfaces/HistoricalBlockStorage.md | 6 +- .../interfaces/IncomingMessageAdapter.md | 4 +- .../sequencer/interfaces/InstantiatedQueue.md | 12 +- .../interfaces/LocalTaskQueueConfig.md | 4 +- .../reference/sequencer/interfaces/Mempool.md | 6 +- .../sequencer/interfaces/MerkleTreeNode.md | 8 +- .../interfaces/MerkleTreeNodeQuery.md | 6 +- .../sequencer/interfaces/MessageStorage.md | 6 +- .../interfaces/MinaBaseLayerConfig.md | 4 +- .../interfaces/NetworkStateTransportModule.md | 8 +- .../interfaces/NewBlockProverParameters.md | 10 +- .../sequencer/interfaces/OutgoingMessage.md | 6 +- .../interfaces/OutgoingMessageQueue.md | 8 +- .../interfaces/PairingDerivedInput.md | 8 +- .../sequencer/interfaces/QueryGetterState.md | 8 +- .../interfaces/QueryGetterStateMap.md | 8 +- .../interfaces/QueryTransportModule.md | 6 +- .../interfaces/RuntimeProofParameters.md | 8 +- .../sequencer/interfaces/Sequenceable.md | 4 +- .../sequencer/interfaces/SettleableBatch.md | 12 +- .../sequencer/interfaces/Settlement.md | 6 +- .../interfaces/SettlementModuleConfig.md | 6 +- .../sequencer/interfaces/SettlementStorage.md | 4 +- .../sequencer/interfaces/StateEntry.md | 6 +- .../StateTransitionProofParameters.md | 8 +- .../interfaces/StorageDependencyFactory.md | 4 +- .../StorageDependencyMinimumDependencies.md | 24 ++-- .../reference/sequencer/interfaces/Task.md | 12 +- .../sequencer/interfaces/TaskPayload.md | 12 +- .../sequencer/interfaces/TaskQueue.md | 6 +- .../sequencer/interfaces/TaskSerializer.md | 6 +- .../interfaces/TimedBlockTriggerConfig.md | 10 +- .../interfaces/TimedBlockTriggerEvent.md | 10 +- .../interfaces/TransactionExecutionResult.md | 14 +- .../interfaces/TransactionStorage.md | 8 +- .../sequencer/interfaces/TransactionTrace.md | 8 +- .../sequencer/interfaces/TxEvents.md | 8 +- .../type-aliases/AllTaskWorkerModules.md | 2 +- .../sequencer/type-aliases/BlockEvents.md | 2 +- .../type-aliases/ChainStateTaskArgs.md | 2 +- .../type-aliases/DatabasePruneConfig.md | 2 +- .../type-aliases/JSONEncodableState.md | 2 +- .../type-aliases/MapStateMapToQuery.md | 2 +- .../sequencer/type-aliases/MapStateToQuery.md | 2 +- .../sequencer/type-aliases/MempoolEvents.md | 2 +- .../sequencer/type-aliases/ModuleQuery.md | 2 +- .../type-aliases/NewBlockProvingParameters.md | 2 +- .../sequencer/type-aliases/PairTuple.md | 2 +- .../sequencer/type-aliases/PickByType.md | 2 +- .../type-aliases/PickStateMapProperties.md | 2 +- .../type-aliases/PickStateProperties.md | 2 +- .../reference/sequencer/type-aliases/Query.md | 2 +- .../RuntimeContextReducedExecutionResult.md | 2 +- .../type-aliases/SequencerModulesRecord.md | 2 +- .../type-aliases/SerializedArtifactRecord.md | 2 +- .../type-aliases/SettlementModuleEvents.md | 2 +- .../type-aliases/SomeRuntimeMethod.md | 2 +- .../sequencer/type-aliases/StateRecord.md | 2 +- .../sequencer/type-aliases/TaskStateRecord.md | 2 +- .../type-aliases/TaskWorkerModulesRecord.md | 2 +- .../TaskWorkerModulesWithoutSettlement.md | 2 +- .../TransactionProvingTaskParameters.md | 2 +- .../type-aliases/TransactionTaskArgs.md | 2 +- .../type-aliases/TransactionTaskResult.md | 2 +- .../type-aliases/UnsignedTransactionBody.md | 2 +- .../type-aliases/VerificationKeyJSON.md | 2 +- .../reference/sequencer/variables/Block.md | 2 +- .../sequencer/variables/BlockWithResult.md | 2 +- .../sequencer/variables/JSONTaskSerializer.md | 2 +- .../variables/QueryBuilderFactory.md | 2 +- .../reference/stack/classes/TestBalances.md | 8 +- .../reference/stack/functions/startServer.md | 6 +- 616 files changed, 2611 insertions(+), 2986 deletions(-) delete mode 100644 src/pages/docs/reference/api/globals.md delete mode 100644 src/pages/docs/reference/common/globals.md delete mode 100644 src/pages/docs/reference/indexer/globals.md delete mode 100644 src/pages/docs/reference/library/globals.md delete mode 100644 src/pages/docs/reference/persistance/globals.md delete mode 100644 src/pages/docs/reference/processor/globals.md diff --git a/package.json b/package.json index 8a0cd22..d772a7a 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "@protokit/website", "version": "0.0.1", "scripts": { + "postinstall": "pnpm run typedoc:generate", "typedoc:generate": "./generate-typedoc.sh", "dev": "next dev", "build": "next build", diff --git a/src/pages/docs/reference/api/_meta.tsx b/src/pages/docs/reference/api/_meta.tsx index b6944c5..a31554d 100644 --- a/src/pages/docs/reference/api/_meta.tsx +++ b/src/pages/docs/reference/api/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases" + "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" }; \ No newline at end of file diff --git a/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md b/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md index 3bec116..10abe78 100644 --- a/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md +++ b/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md @@ -10,7 +10,7 @@ title: AdvancedNodeStatusResolver # Class: AdvancedNodeStatusResolver -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L74) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L74) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new AdvancedNodeStatusResolver**(`nodeStatusService`): [`AdvancedNodeStatusResolver`](AdvancedNodeStatusResolver.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L75) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L75) #### Parameters @@ -117,7 +117,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **node**(): `Promise`\<[`NodeStatusObject`](NodeStatusObject.md)\> -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L83) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L83) #### Returns diff --git a/src/pages/docs/reference/api/classes/BatchStorageResolver.md b/src/pages/docs/reference/api/classes/BatchStorageResolver.md index 7e1841e..ed4960a 100644 --- a/src/pages/docs/reference/api/classes/BatchStorageResolver.md +++ b/src/pages/docs/reference/api/classes/BatchStorageResolver.md @@ -10,7 +10,7 @@ title: BatchStorageResolver # Class: BatchStorageResolver -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L41) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L41) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new BatchStorageResolver**(`batchStorage`, `blockResolver`): [`BatchStorageResolver`](BatchStorageResolver.md) -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L43) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L43) #### Parameters @@ -99,7 +99,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **batches**(`height`): `Promise`\<`undefined` \| [`ComputedBlockModel`](ComputedBlockModel.md)\> -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L56) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L56) #### Parameters diff --git a/src/pages/docs/reference/api/classes/BlockModel.md b/src/pages/docs/reference/api/classes/BlockModel.md index aa762b7..980f4e8 100644 --- a/src/pages/docs/reference/api/classes/BlockModel.md +++ b/src/pages/docs/reference/api/classes/BlockModel.md @@ -10,7 +10,7 @@ title: BlockModel # Class: BlockModel -Defined in: [api/src/graphql/modules/BlockResolver.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L14) +Defined in: [api/src/graphql/modules/BlockResolver.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L14) ## Properties @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:14](https://github.com/pro > **hash**: `string` -Defined in: [api/src/graphql/modules/BlockResolver.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L32) +Defined in: [api/src/graphql/modules/BlockResolver.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L32) *** @@ -26,7 +26,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:32](https://github.com/pro > **height**: `number` -Defined in: [api/src/graphql/modules/BlockResolver.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L38) +Defined in: [api/src/graphql/modules/BlockResolver.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L38) *** @@ -34,7 +34,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:38](https://github.com/pro > **previousBlockHash**: `undefined` \| `string` -Defined in: [api/src/graphql/modules/BlockResolver.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L35) +Defined in: [api/src/graphql/modules/BlockResolver.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L35) *** @@ -42,7 +42,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:35](https://github.com/pro > **transactionsHash**: `string` -Defined in: [api/src/graphql/modules/BlockResolver.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L44) +Defined in: [api/src/graphql/modules/BlockResolver.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L44) *** @@ -50,7 +50,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:44](https://github.com/pro > **txs**: `BatchTransactionModel`[] -Defined in: [api/src/graphql/modules/BlockResolver.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L41) +Defined in: [api/src/graphql/modules/BlockResolver.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L41) ## Methods @@ -58,7 +58,7 @@ Defined in: [api/src/graphql/modules/BlockResolver.ts:41](https://github.com/pro > `static` **fromServiceLayerModel**(`block`): [`BlockModel`](BlockModel.md) -Defined in: [api/src/graphql/modules/BlockResolver.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L15) +Defined in: [api/src/graphql/modules/BlockResolver.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L15) #### Parameters diff --git a/src/pages/docs/reference/api/classes/BlockResolver.md b/src/pages/docs/reference/api/classes/BlockResolver.md index 15aebcb..879ec83 100644 --- a/src/pages/docs/reference/api/classes/BlockResolver.md +++ b/src/pages/docs/reference/api/classes/BlockResolver.md @@ -10,7 +10,7 @@ title: BlockResolver # Class: BlockResolver -Defined in: [api/src/graphql/modules/BlockResolver.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L62) +Defined in: [api/src/graphql/modules/BlockResolver.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L62) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new BlockResolver**(`blockStorage`): [`BlockResolver`](BlockResolver.md) -Defined in: [api/src/graphql/modules/BlockResolver.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L63) +Defined in: [api/src/graphql/modules/BlockResolver.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L63) #### Parameters @@ -95,7 +95,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **block**(`height`, `hash`): `Promise`\<`undefined` \| [`BlockModel`](BlockModel.md)\> -Defined in: [api/src/graphql/modules/BlockResolver.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BlockResolver.ts#L75) +Defined in: [api/src/graphql/modules/BlockResolver.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L75) #### Parameters diff --git a/src/pages/docs/reference/api/classes/ComputedBlockModel.md b/src/pages/docs/reference/api/classes/ComputedBlockModel.md index c107760..aba43e2 100644 --- a/src/pages/docs/reference/api/classes/ComputedBlockModel.md +++ b/src/pages/docs/reference/api/classes/ComputedBlockModel.md @@ -10,7 +10,7 @@ title: ComputedBlockModel # Class: ComputedBlockModel -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L15) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L15) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:15](https://github. > **new ComputedBlockModel**(`blocks`, `proof`): [`ComputedBlockModel`](ComputedBlockModel.md) -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L34) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L34) #### Parameters @@ -40,7 +40,7 @@ Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:34](https://github. > **blocks**: [`BlockModel`](BlockModel.md)[] -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L29) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L29) *** @@ -48,7 +48,7 @@ Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:29](https://github. > **proof**: `string` -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L32) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L32) ## Methods @@ -56,7 +56,7 @@ Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:32](https://github. > `static` **fromServiceLayerModel**(`__namedParameters`, `blocks`): [`ComputedBlockModel`](ComputedBlockModel.md) -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/BatchStorageResolver.ts#L16) +Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/api/classes/GraphqlModule.md b/src/pages/docs/reference/api/classes/GraphqlModule.md index 1c6a69a..d5425ed 100644 --- a/src/pages/docs/reference/api/classes/GraphqlModule.md +++ b/src/pages/docs/reference/api/classes/GraphqlModule.md @@ -10,7 +10,7 @@ title: GraphqlModule # Class: `abstract` GraphqlModule\ -Defined in: [api/src/graphql/GraphqlModule.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L8) +Defined in: [api/src/graphql/GraphqlModule.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L8) Used by various module sub-types that may need to be configured @@ -39,7 +39,7 @@ Used by various module sub-types that may need to be configured > **new GraphqlModule**\<`Config`\>(): [`GraphqlModule`](GraphqlModule.md)\<`Config`\> -Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L11) +Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L11) #### Returns diff --git a/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md b/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md index 2aa217c..f320979 100644 --- a/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md +++ b/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md @@ -10,7 +10,7 @@ title: GraphqlSequencerModule # Class: GraphqlSequencerModule\ -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L33) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L33) Lifecycle of a SequencerModule @@ -231,7 +231,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L98) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:98](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L98) #### Returns @@ -297,7 +297,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:115 > **create**(`childContainerProvider`): `void` -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L49) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L49) This is a placeholder for individual modules to override. This method will be called whenever the underlying container fully @@ -595,7 +595,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L55) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L55) Start the module and all it's functionality. The returned Promise has to resolve after initialization, @@ -645,7 +645,7 @@ such as only injecting other known modules. > `static` **from**\<`GraphQLModules`\>(`definition`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](GraphqlSequencerModule.md)\<`GraphQLModules`\>\> -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L37) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L37) #### Type Parameters diff --git a/src/pages/docs/reference/api/classes/GraphqlServer.md b/src/pages/docs/reference/api/classes/GraphqlServer.md index c4866b5..0874a11 100644 --- a/src/pages/docs/reference/api/classes/GraphqlServer.md +++ b/src/pages/docs/reference/api/classes/GraphqlServer.md @@ -10,7 +10,7 @@ title: GraphqlServer # Class: GraphqlServer -Defined in: [api/src/graphql/GraphqlServer.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L30) +Defined in: [api/src/graphql/GraphqlServer.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L30) Lifecycle of a SequencerModule @@ -101,7 +101,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **close**(): `Promise`\<`void`\> -Defined in: [api/src/graphql/GraphqlServer.ts:148](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L148) +Defined in: [api/src/graphql/GraphqlServer.ts:148](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L148) #### Returns @@ -135,7 +135,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **registerModule**(`module`): `void` -Defined in: [api/src/graphql/GraphqlServer.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L55) +Defined in: [api/src/graphql/GraphqlServer.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L55) #### Parameters @@ -153,7 +153,7 @@ Defined in: [api/src/graphql/GraphqlServer.ts:55](https://github.com/proto-kit/f > **registerResolvers**(`resolvers`): `void` -Defined in: [api/src/graphql/GraphqlServer.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L63) +Defined in: [api/src/graphql/GraphqlServer.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L63) #### Parameters @@ -171,7 +171,7 @@ Defined in: [api/src/graphql/GraphqlServer.ts:63](https://github.com/proto-kit/f > **registerSchema**(`schema`): `void` -Defined in: [api/src/graphql/GraphqlServer.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L59) +Defined in: [api/src/graphql/GraphqlServer.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L59) #### Parameters @@ -189,7 +189,7 @@ Defined in: [api/src/graphql/GraphqlServer.ts:59](https://github.com/proto-kit/f > **setContainer**(`container`): `void` -Defined in: [api/src/graphql/GraphqlServer.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L43) +Defined in: [api/src/graphql/GraphqlServer.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L43) #### Parameters @@ -207,7 +207,7 @@ Defined in: [api/src/graphql/GraphqlServer.ts:43](https://github.com/proto-kit/f > **setContext**(`context`): `void` -Defined in: [api/src/graphql/GraphqlServer.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L71) +Defined in: [api/src/graphql/GraphqlServer.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L71) #### Parameters @@ -223,7 +223,7 @@ Defined in: [api/src/graphql/GraphqlServer.ts:71](https://github.com/proto-kit/f > **start**(): `Promise`\<`void`\> -Defined in: [api/src/graphql/GraphqlServer.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L75) +Defined in: [api/src/graphql/GraphqlServer.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L75) Start the module and all it's functionality. The returned Promise has to resolve after initialization, @@ -244,7 +244,7 @@ That means that you mustn't await server.start() for example. > **startServer**(): `Promise`\<`void`\> -Defined in: [api/src/graphql/GraphqlServer.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlServer.ts#L79) +Defined in: [api/src/graphql/GraphqlServer.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L79) #### Returns diff --git a/src/pages/docs/reference/api/classes/MempoolResolver.md b/src/pages/docs/reference/api/classes/MempoolResolver.md index 1e40396..148cfb3 100644 --- a/src/pages/docs/reference/api/classes/MempoolResolver.md +++ b/src/pages/docs/reference/api/classes/MempoolResolver.md @@ -10,7 +10,7 @@ title: MempoolResolver # Class: MempoolResolver -Defined in: [api/src/graphql/modules/MempoolResolver.ts:121](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L121) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:121](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L121) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new MempoolResolver**(`mempool`, `transactionStorage`): [`MempoolResolver`](MempoolResolver.md) -Defined in: [api/src/graphql/modules/MempoolResolver.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L122) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L122) #### Parameters @@ -121,7 +121,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **submitTx**(`tx`): `Promise`\<`string`\> -Defined in: [api/src/graphql/modules/MempoolResolver.ts:133](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L133) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:133](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L133) #### Parameters @@ -139,7 +139,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:133](https://github.com/ > **transactions**(): `Promise`\<`string`[]\> -Defined in: [api/src/graphql/modules/MempoolResolver.ts:169](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L169) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:169](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L169) #### Returns @@ -151,7 +151,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:169](https://github.com/ > **transactionState**(`hash`): `Promise`\<`InclusionStatus`\> -Defined in: [api/src/graphql/modules/MempoolResolver.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L144) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:144](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L144) #### Parameters diff --git a/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md b/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md index 022be0d..c592148 100644 --- a/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md +++ b/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md @@ -10,7 +10,7 @@ title: MerkleWitnessDTO # Class: MerkleWitnessDTO -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L13) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L13) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:13](https://github > **new MerkleWitnessDTO**(`siblings`, `isLefts`): [`MerkleWitnessDTO`](MerkleWitnessDTO.md) -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L20) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L20) #### Parameters @@ -40,7 +40,7 @@ Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:20](https://github > **isLefts**: `boolean`[] -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L31) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L31) *** @@ -48,7 +48,7 @@ Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:31](https://github > **siblings**: `string`[] -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L27) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L27) ## Methods @@ -56,7 +56,7 @@ Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:27](https://github > `static` **fromServiceLayerObject**(`witness`): [`MerkleWitnessDTO`](MerkleWitnessDTO.md) -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L14) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L14) #### Parameters diff --git a/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md b/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md index 2ffe986..6f5d9ad 100644 --- a/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md +++ b/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md @@ -10,7 +10,7 @@ title: MerkleWitnessResolver # Class: MerkleWitnessResolver -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L35) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L35) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new MerkleWitnessResolver**(`treeStore`): [`MerkleWitnessResolver`](MerkleWitnessResolver.md) -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L36) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L36) #### Parameters @@ -117,7 +117,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **witness**(`path`): `Promise`\<[`MerkleWitnessDTO`](MerkleWitnessDTO.md)\> -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L46) +Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L46) #### Parameters diff --git a/src/pages/docs/reference/api/classes/NodeInformationObject.md b/src/pages/docs/reference/api/classes/NodeInformationObject.md index 552a934..4e7ec6d 100644 --- a/src/pages/docs/reference/api/classes/NodeInformationObject.md +++ b/src/pages/docs/reference/api/classes/NodeInformationObject.md @@ -10,7 +10,7 @@ title: NodeInformationObject # Class: NodeInformationObject -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L10) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L10) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:10](https://github.co > **new NodeInformationObject**(`blockHeight`, `batchHeight`): [`NodeInformationObject`](NodeInformationObject.md) -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L21) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L21) #### Parameters @@ -40,7 +40,7 @@ Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:21](https://github.co > **batchHeight**: `number` -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L19) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L19) *** @@ -48,7 +48,7 @@ Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:19](https://github.co > **blockHeight**: `number` -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L16) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L16) ## Methods @@ -56,7 +56,7 @@ Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:16](https://github.co > `static` **fromServiceLayerModel**(`status`): [`NodeInformationObject`](NodeInformationObject.md) -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L11) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L11) #### Parameters diff --git a/src/pages/docs/reference/api/classes/NodeStatusObject.md b/src/pages/docs/reference/api/classes/NodeStatusObject.md index 08ebf68..8656250 100644 --- a/src/pages/docs/reference/api/classes/NodeStatusObject.md +++ b/src/pages/docs/reference/api/classes/NodeStatusObject.md @@ -10,7 +10,7 @@ title: NodeStatusObject # Class: NodeStatusObject -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L53) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L53) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:53](https://g > **new NodeStatusObject**(`node`, `process`): [`NodeStatusObject`](NodeStatusObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L67) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L67) #### Parameters @@ -40,7 +40,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:67](https://g > **node**: [`NodeInformationObject`](NodeInformationObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L65) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L65) *** @@ -48,7 +48,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:65](https://g > **process**: [`ProcessInformationObject`](ProcessInformationObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L62) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L62) ## Methods @@ -56,7 +56,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:62](https://g > `static` **fromServiceLayerModel**(`node`, `process`): [`NodeStatusObject`](NodeStatusObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L54) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L54) #### Parameters diff --git a/src/pages/docs/reference/api/classes/NodeStatusResolver.md b/src/pages/docs/reference/api/classes/NodeStatusResolver.md index 749b0fd..f1563c0 100644 --- a/src/pages/docs/reference/api/classes/NodeStatusResolver.md +++ b/src/pages/docs/reference/api/classes/NodeStatusResolver.md @@ -10,7 +10,7 @@ title: NodeStatusResolver # Class: NodeStatusResolver -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L28) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L28) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new NodeStatusResolver**(`nodeStatusService`): [`NodeStatusResolver`](NodeStatusResolver.md) -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L29) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L29) #### Parameters @@ -117,7 +117,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **node**(): `Promise`\<[`NodeInformationObject`](NodeInformationObject.md)\> -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/NodeStatusResolver.ts#L36) +Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L36) #### Returns diff --git a/src/pages/docs/reference/api/classes/NodeStatusService.md b/src/pages/docs/reference/api/classes/NodeStatusService.md index 37706d7..71464ef 100644 --- a/src/pages/docs/reference/api/classes/NodeStatusService.md +++ b/src/pages/docs/reference/api/classes/NodeStatusService.md @@ -10,7 +10,7 @@ title: NodeStatusService # Class: NodeStatusService -Defined in: [api/src/graphql/services/NodeStatusService.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L27) +Defined in: [api/src/graphql/services/NodeStatusService.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L27) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:27](https://github.co > **new NodeStatusService**(`blockStorage`, `batchStorage`, `settlementStorage`): [`NodeStatusService`](NodeStatusService.md) -Defined in: [api/src/graphql/services/NodeStatusService.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L28) +Defined in: [api/src/graphql/services/NodeStatusService.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L28) #### Parameters @@ -44,7 +44,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:28](https://github.co > **getNodeInformation**(): `Promise`\<[`NodeInformation`](../interfaces/NodeInformation.md)\> -Defined in: [api/src/graphql/services/NodeStatusService.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L56) +Defined in: [api/src/graphql/services/NodeStatusService.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L56) #### Returns @@ -56,7 +56,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:56](https://github.co > **getProcessInfo**(): [`ProcessInformation`](../interfaces/ProcessInformation.md) -Defined in: [api/src/graphql/services/NodeStatusService.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L36) +Defined in: [api/src/graphql/services/NodeStatusService.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L36) #### Returns diff --git a/src/pages/docs/reference/api/classes/ProcessInformationObject.md b/src/pages/docs/reference/api/classes/ProcessInformationObject.md index 6415639..5f1d1fa 100644 --- a/src/pages/docs/reference/api/classes/ProcessInformationObject.md +++ b/src/pages/docs/reference/api/classes/ProcessInformationObject.md @@ -10,7 +10,7 @@ title: ProcessInformationObject # Class: ProcessInformationObject -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L13) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L13) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:13](https://g > **new ProcessInformationObject**(`process`): [`ProcessInformationObject`](ProcessInformationObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L39) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L39) #### Parameters @@ -36,7 +36,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:39](https://g > **arch**: `string` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L34) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L34) *** @@ -44,7 +44,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:34](https://g > **headTotal**: `number` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L28) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L28) *** @@ -52,7 +52,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:28](https://g > **headUsed**: `number` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L25) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L25) *** @@ -60,7 +60,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:25](https://g > **nodeVersion**: `string` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L31) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L31) *** @@ -68,7 +68,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:31](https://g > **platform**: `string` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L37) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L37) *** @@ -76,7 +76,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:37](https://g > **uptime**: `number` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L19) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L19) *** @@ -84,7 +84,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:19](https://g > **uptimeHumanReadable**: `string` -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L22) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L22) ## Methods @@ -92,7 +92,7 @@ Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:22](https://g > `static` **fromServiceLayerModel**(`process`): [`ProcessInformationObject`](ProcessInformationObject.md) -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L14) +Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L14) #### Parameters diff --git a/src/pages/docs/reference/api/classes/QueryGraphqlModule.md b/src/pages/docs/reference/api/classes/QueryGraphqlModule.md index 47f1cad..ab6a32b 100644 --- a/src/pages/docs/reference/api/classes/QueryGraphqlModule.md +++ b/src/pages/docs/reference/api/classes/QueryGraphqlModule.md @@ -10,7 +10,7 @@ title: QueryGraphqlModule # Class: QueryGraphqlModule\ -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L69) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L69) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new QueryGraphqlModule**\<`RuntimeModules`\>(`queryTransportModule`, `networkStateTransportModule`, `runtime`, `protocol`, `blockStorage`): [`QueryGraphqlModule`](QueryGraphqlModule.md)\<`RuntimeModules`\> -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L72) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L72) #### Parameters @@ -137,7 +137,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **generateSchema**(): `GraphQLSchema` -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:361](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L361) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:361](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L361) #### Returns @@ -153,7 +153,7 @@ Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:361](https://github.c > **generateSchemaForQuery**\<`ModuleType`, `ContainerModulesRecord`\>(`container`, `containerQuery`, `namePrefix`): `ObjMap`\<`GraphQLFieldConfig`\<`unknown`, `unknown`\>\> -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:310](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L310) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:310](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L310) #### Type Parameters @@ -185,7 +185,7 @@ Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:310](https://github.c > **generateStateMapResolver**\<`Key`, `Value`\>(`fieldKey`, `query`, `stateMap`): `GraphQLFieldConfig`\<`unknown`, `unknown`\> -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:222](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L222) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:222](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L222) #### Type Parameters @@ -217,7 +217,7 @@ Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:222](https://github.c > **generateStateResolver**\<`Value`\>(`fieldKey`, `query`, `state`): `object` -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:276](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L276) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:276](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L276) #### Type Parameters @@ -263,7 +263,7 @@ Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:276](https://github.c > **state**(`path`): `Promise`\<`undefined` \| `string`[]\> -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:93](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L93) +Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L93) #### Parameters diff --git a/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md b/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md index 11b7476..4cd0f3e 100644 --- a/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md +++ b/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md @@ -10,7 +10,7 @@ title: ResolverFactoryGraphqlModule # Class: `abstract` ResolverFactoryGraphqlModule\ -Defined in: [api/src/graphql/GraphqlModule.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L30) +Defined in: [api/src/graphql/GraphqlModule.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L30) Used by various module sub-types that may need to be configured @@ -33,7 +33,7 @@ Used by various module sub-types that may need to be configured > **new ResolverFactoryGraphqlModule**\<`Config`\>(): [`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`Config`\> -Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L11) +Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L11) #### Returns @@ -120,7 +120,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > `abstract` **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> -Defined in: [api/src/graphql/GraphqlModule.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L33) +Defined in: [api/src/graphql/GraphqlModule.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L33) #### Returns diff --git a/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md b/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md index 750f0b1..5733920 100644 --- a/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md +++ b/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md @@ -10,7 +10,7 @@ title: SchemaGeneratingGraphqlModule # Class: `abstract` SchemaGeneratingGraphqlModule\ -Defined in: [api/src/graphql/GraphqlModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L24) +Defined in: [api/src/graphql/GraphqlModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L24) Used by various module sub-types that may need to be configured @@ -32,7 +32,7 @@ Used by various module sub-types that may need to be configured > **new SchemaGeneratingGraphqlModule**\<`Config`\>(): [`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md)\<`Config`\> -Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L11) +Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L11) #### Returns @@ -119,7 +119,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > `abstract` **generateSchema**(): `GraphQLSchema` -Defined in: [api/src/graphql/GraphqlModule.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L27) +Defined in: [api/src/graphql/GraphqlModule.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L27) #### Returns diff --git a/src/pages/docs/reference/api/classes/Signature.md b/src/pages/docs/reference/api/classes/Signature.md index aaae6d8..c3d0ce4 100644 --- a/src/pages/docs/reference/api/classes/Signature.md +++ b/src/pages/docs/reference/api/classes/Signature.md @@ -10,7 +10,7 @@ title: Signature # Class: Signature -Defined in: [api/src/graphql/modules/MempoolResolver.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L22) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L22) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:22](https://github.com/p > **new Signature**(`r`, `s`): [`Signature`](Signature.md) -Defined in: [api/src/graphql/modules/MempoolResolver.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L31) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L31) #### Parameters @@ -40,7 +40,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:31](https://github.com/p > **r**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L25) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L25) *** @@ -48,4 +48,4 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:25](https://github.com/p > **s**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L29) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L29) diff --git a/src/pages/docs/reference/api/classes/TransactionObject.md b/src/pages/docs/reference/api/classes/TransactionObject.md index e65aa97..06f1d78 100644 --- a/src/pages/docs/reference/api/classes/TransactionObject.md +++ b/src/pages/docs/reference/api/classes/TransactionObject.md @@ -10,7 +10,7 @@ title: TransactionObject # Class: TransactionObject -Defined in: [api/src/graphql/modules/MempoolResolver.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L39) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L39) ## Constructors @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:39](https://github.com/p > **new TransactionObject**(`hash`, `methodId`, `sender`, `nonce`, `signature`, `argsFields`, `auxiliaryData`, `isMessage`): [`TransactionObject`](TransactionObject.md) -Defined in: [api/src/graphql/modules/MempoolResolver.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L88) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L88) #### Parameters @@ -64,7 +64,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:88](https://github.com/p > **argsFields**: `string`[] -Defined in: [api/src/graphql/modules/MempoolResolver.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L80) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L80) *** @@ -72,7 +72,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:80](https://github.com/p > **auxiliaryData**: `string`[] -Defined in: [api/src/graphql/modules/MempoolResolver.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L83) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L83) *** @@ -80,7 +80,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:83](https://github.com/p > **hash**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L63) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L63) *** @@ -88,7 +88,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:63](https://github.com/p > **isMessage**: `boolean` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L86) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L86) *** @@ -96,7 +96,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:86](https://github.com/p > **methodId**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L67) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L67) *** @@ -104,7 +104,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:67](https://github.com/p > **nonce**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L74) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L74) *** @@ -112,7 +112,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:74](https://github.com/p > **sender**: `string` -Defined in: [api/src/graphql/modules/MempoolResolver.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L70) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L70) *** @@ -120,7 +120,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:70](https://github.com/p > **signature**: [`Signature`](Signature.md) -Defined in: [api/src/graphql/modules/MempoolResolver.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L77) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L77) ## Methods @@ -128,7 +128,7 @@ Defined in: [api/src/graphql/modules/MempoolResolver.ts:77](https://github.com/p > `static` **fromServiceLayerModel**(`pt`): [`TransactionObject`](TransactionObject.md) -Defined in: [api/src/graphql/modules/MempoolResolver.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/modules/MempoolResolver.ts#L40) +Defined in: [api/src/graphql/modules/MempoolResolver.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L40) #### Parameters diff --git a/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md b/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md index 83c11f6..051b56a 100644 --- a/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md +++ b/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md @@ -10,7 +10,7 @@ title: VanillaGraphqlModules # Class: VanillaGraphqlModules -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/VanillaGraphqlModules.ts#L20) +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/VanillaGraphqlModules.ts#L20) ## Constructors @@ -28,7 +28,7 @@ Defined in: [api/src/graphql/VanillaGraphqlModules.ts:20](https://github.com/pro > `static` **defaultConfig**(): `object` -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/VanillaGraphqlModules.ts#L35) +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/VanillaGraphqlModules.ts#L35) #### Returns @@ -64,7 +64,7 @@ Defined in: [api/src/graphql/VanillaGraphqlModules.ts:35](https://github.com/pro > `static` **with**\<`AdditionalModules`\>(`additionalModules`): `object` & `AdditionalModules` -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/VanillaGraphqlModules.ts#L21) +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/VanillaGraphqlModules.ts#L21) #### Type Parameters diff --git a/src/pages/docs/reference/api/functions/graphqlModule.md b/src/pages/docs/reference/api/functions/graphqlModule.md index d327429..922b17d 100644 --- a/src/pages/docs/reference/api/functions/graphqlModule.md +++ b/src/pages/docs/reference/api/functions/graphqlModule.md @@ -12,7 +12,7 @@ title: graphqlModule > **graphqlModule**(): (`target`) => `void` -Defined in: [api/src/graphql/GraphqlModule.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlModule.ts#L36) +Defined in: [api/src/graphql/GraphqlModule.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L36) ## Returns diff --git a/src/pages/docs/reference/api/globals.md b/src/pages/docs/reference/api/globals.md deleted file mode 100644 index 869d7c9..0000000 --- a/src/pages/docs/reference/api/globals.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "@proto-kit/api" ---- - -[**@proto-kit/api**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/api - -# @proto-kit/api - -## Classes - -- [AdvancedNodeStatusResolver](classes/AdvancedNodeStatusResolver.md) -- [BatchStorageResolver](classes/BatchStorageResolver.md) -- [BlockModel](classes/BlockModel.md) -- [BlockResolver](classes/BlockResolver.md) -- [ComputedBlockModel](classes/ComputedBlockModel.md) -- [GraphqlModule](classes/GraphqlModule.md) -- [GraphqlSequencerModule](classes/GraphqlSequencerModule.md) -- [GraphqlServer](classes/GraphqlServer.md) -- [MempoolResolver](classes/MempoolResolver.md) -- [MerkleWitnessDTO](classes/MerkleWitnessDTO.md) -- [MerkleWitnessResolver](classes/MerkleWitnessResolver.md) -- [NodeInformationObject](classes/NodeInformationObject.md) -- [NodeStatusObject](classes/NodeStatusObject.md) -- [NodeStatusResolver](classes/NodeStatusResolver.md) -- [NodeStatusService](classes/NodeStatusService.md) -- [ProcessInformationObject](classes/ProcessInformationObject.md) -- [QueryGraphqlModule](classes/QueryGraphqlModule.md) -- [ResolverFactoryGraphqlModule](classes/ResolverFactoryGraphqlModule.md) -- [SchemaGeneratingGraphqlModule](classes/SchemaGeneratingGraphqlModule.md) -- [Signature](classes/Signature.md) -- [TransactionObject](classes/TransactionObject.md) -- [VanillaGraphqlModules](classes/VanillaGraphqlModules.md) - -## Interfaces - -- [GraphqlModulesDefintion](interfaces/GraphqlModulesDefintion.md) -- [NodeInformation](interfaces/NodeInformation.md) -- [ProcessInformation](interfaces/ProcessInformation.md) - -## Type Aliases - -- [GraphqlModulesRecord](type-aliases/GraphqlModulesRecord.md) -- [VanillaGraphqlModulesRecord](type-aliases/VanillaGraphqlModulesRecord.md) - -## Functions - -- [graphqlModule](functions/graphqlModule.md) diff --git a/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md b/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md index cb785da..0c7cbaa 100644 --- a/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md +++ b/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md @@ -10,7 +10,7 @@ title: GraphqlModulesDefintion # Interface: GraphqlModulesDefintion\ -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L25) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L25) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [api/src/graphql/GraphqlSequencerModule.ts:25](https://github.com/pr > `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`GraphQLModules`\> -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L29) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L29) *** @@ -30,4 +30,4 @@ Defined in: [api/src/graphql/GraphqlSequencerModule.ts:29](https://github.com/pr > **modules**: `GraphQLModules` -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L28) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L28) diff --git a/src/pages/docs/reference/api/interfaces/NodeInformation.md b/src/pages/docs/reference/api/interfaces/NodeInformation.md index 06792ed..5483a7d 100644 --- a/src/pages/docs/reference/api/interfaces/NodeInformation.md +++ b/src/pages/docs/reference/api/interfaces/NodeInformation.md @@ -10,7 +10,7 @@ title: NodeInformation # Interface: NodeInformation -Defined in: [api/src/graphql/services/NodeStatusService.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L21) +Defined in: [api/src/graphql/services/NodeStatusService.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L21) ## Properties @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:21](https://github.co > **batchHeight**: `number` -Defined in: [api/src/graphql/services/NodeStatusService.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L23) +Defined in: [api/src/graphql/services/NodeStatusService.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L23) *** @@ -26,4 +26,4 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:23](https://github.co > **blockHeight**: `number` -Defined in: [api/src/graphql/services/NodeStatusService.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L22) +Defined in: [api/src/graphql/services/NodeStatusService.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L22) diff --git a/src/pages/docs/reference/api/interfaces/ProcessInformation.md b/src/pages/docs/reference/api/interfaces/ProcessInformation.md index 029c87e..53d756a 100644 --- a/src/pages/docs/reference/api/interfaces/ProcessInformation.md +++ b/src/pages/docs/reference/api/interfaces/ProcessInformation.md @@ -10,7 +10,7 @@ title: ProcessInformation # Interface: ProcessInformation -Defined in: [api/src/graphql/services/NodeStatusService.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L11) +Defined in: [api/src/graphql/services/NodeStatusService.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L11) ## Properties @@ -18,7 +18,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:11](https://github.co > **arch**: `string` -Defined in: [api/src/graphql/services/NodeStatusService.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L17) +Defined in: [api/src/graphql/services/NodeStatusService.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L17) *** @@ -26,7 +26,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:17](https://github.co > **headTotal**: `number` -Defined in: [api/src/graphql/services/NodeStatusService.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L15) +Defined in: [api/src/graphql/services/NodeStatusService.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L15) *** @@ -34,7 +34,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:15](https://github.co > **headUsed**: `number` -Defined in: [api/src/graphql/services/NodeStatusService.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L14) +Defined in: [api/src/graphql/services/NodeStatusService.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L14) *** @@ -42,7 +42,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:14](https://github.co > **nodeVersion**: `string` -Defined in: [api/src/graphql/services/NodeStatusService.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L16) +Defined in: [api/src/graphql/services/NodeStatusService.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L16) *** @@ -50,7 +50,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:16](https://github.co > **platform**: `string` -Defined in: [api/src/graphql/services/NodeStatusService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L18) +Defined in: [api/src/graphql/services/NodeStatusService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L18) *** @@ -58,7 +58,7 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:18](https://github.co > **uptime**: `number` -Defined in: [api/src/graphql/services/NodeStatusService.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L12) +Defined in: [api/src/graphql/services/NodeStatusService.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L12) *** @@ -66,4 +66,4 @@ Defined in: [api/src/graphql/services/NodeStatusService.ts:12](https://github.co > **uptimeHumanReadable**: `string` -Defined in: [api/src/graphql/services/NodeStatusService.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/services/NodeStatusService.ts#L13) +Defined in: [api/src/graphql/services/NodeStatusService.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L13) diff --git a/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md b/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md index d0b16c7..058054d 100644 --- a/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md +++ b/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md @@ -12,4 +12,4 @@ title: GraphqlModulesRecord > **GraphqlModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlModule`](../classes/GraphqlModule.md)\<`unknown`\>\>\> -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/GraphqlSequencerModule.ts#L21) +Defined in: [api/src/graphql/GraphqlSequencerModule.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L21) diff --git a/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md b/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md index c464038..6ce699e 100644 --- a/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md +++ b/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md @@ -12,7 +12,7 @@ title: VanillaGraphqlModulesRecord > **VanillaGraphqlModulesRecord**: `object` -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/api/src/graphql/VanillaGraphqlModules.ts#L11) +Defined in: [api/src/graphql/VanillaGraphqlModules.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/VanillaGraphqlModules.ts#L11) ## Type declaration diff --git a/src/pages/docs/reference/common/_meta.tsx b/src/pages/docs/reference/common/_meta.tsx index 4d63940..5602e3c 100644 --- a/src/pages/docs/reference/common/_meta.tsx +++ b/src/pages/docs/reference/common/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" + "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" }; \ No newline at end of file diff --git a/src/pages/docs/reference/common/classes/AtomicCompileHelper.md b/src/pages/docs/reference/common/classes/AtomicCompileHelper.md index 84b411b..adfb31b 100644 --- a/src/pages/docs/reference/common/classes/AtomicCompileHelper.md +++ b/src/pages/docs/reference/common/classes/AtomicCompileHelper.md @@ -10,7 +10,7 @@ title: AtomicCompileHelper # Class: AtomicCompileHelper -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/AtomicCompileHelper.ts#L17) +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/AtomicCompileHelper.ts#L17) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:17](https://gi > **new AtomicCompileHelper**(`areProofsEnabled`): [`AtomicCompileHelper`](AtomicCompileHelper.md) -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/AtomicCompileHelper.ts#L18) +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/AtomicCompileHelper.ts#L18) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:18](https://gi > **compileContract**(`contract`, `overrideProofsEnabled`?): `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/AtomicCompileHelper.ts#L24) +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/AtomicCompileHelper.ts#L24) #### Parameters diff --git a/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md b/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md index 650c3d9..84d223a 100644 --- a/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md +++ b/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md @@ -10,7 +10,7 @@ title: ChildVerificationKeyService # Class: ChildVerificationKeyService -Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L7) +Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L7) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService. > **getVerificationKey**(`name`): `object` -Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L14) +Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L14) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService. > **setCompileRegistry**(`registry`): `void` -Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L10) +Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/common/classes/CompileRegistry.md b/src/pages/docs/reference/common/classes/CompileRegistry.md index fb45e91..e06daf9 100644 --- a/src/pages/docs/reference/common/classes/CompileRegistry.md +++ b/src/pages/docs/reference/common/classes/CompileRegistry.md @@ -10,7 +10,7 @@ title: CompileRegistry # Class: CompileRegistry -Defined in: [packages/common/src/compiling/CompileRegistry.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L21) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L21) The CompileRegistry compiles "compilable modules" (i.e. zkprograms, contracts or contractmodules) @@ -22,7 +22,7 @@ while making sure they don't get compiled twice in the same process in parallel. > **new CompileRegistry**(`areProofsEnabled`): [`CompileRegistry`](CompileRegistry.md) -Defined in: [packages/common/src/compiling/CompileRegistry.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L22) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L22) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/common/src/compiling/CompileRegistry.ts:22](https://github > **addArtifactsRaw**(`artifacts`): `void` -Defined in: [packages/common/src/compiling/CompileRegistry.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L68) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L68) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/common/src/compiling/CompileRegistry.ts:68](https://github > **compile**(`target`): `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> -Defined in: [packages/common/src/compiling/CompileRegistry.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L49) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L49) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/common/src/compiling/CompileRegistry.ts:49](https://github > **forceProverExists**(`f`): `Promise`\<`void`\> -Defined in: [packages/common/src/compiling/CompileRegistry.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L41) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L41) This function forces compilation even if the artifact itself is in the registry. Basically the statement is: The artifact along is not enough, we need to @@ -99,7 +99,7 @@ This is true for non-sideloaded circuit dependencies. > **getAllArtifacts**(): [`ArtifactRecord`](../type-aliases/ArtifactRecord.md) -Defined in: [packages/common/src/compiling/CompileRegistry.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L75) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L75) #### Returns @@ -111,7 +111,7 @@ Defined in: [packages/common/src/compiling/CompileRegistry.ts:75](https://github > **getArtifact**(`name`): `undefined` \| [`CompileArtifact`](../interfaces/CompileArtifact.md) -Defined in: [packages/common/src/compiling/CompileRegistry.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompileRegistry.ts#L58) +Defined in: [packages/common/src/compiling/CompileRegistry.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L58) #### Parameters diff --git a/src/pages/docs/reference/common/classes/ConfigurableModule.md b/src/pages/docs/reference/common/classes/ConfigurableModule.md index 14d4d61..60a6b9d 100644 --- a/src/pages/docs/reference/common/classes/ConfigurableModule.md +++ b/src/pages/docs/reference/common/classes/ConfigurableModule.md @@ -10,7 +10,7 @@ title: ConfigurableModule # Class: ConfigurableModule\ -Defined in: [packages/common/src/config/ConfigurableModule.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L27) +Defined in: [packages/common/src/config/ConfigurableModule.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L27) Used by various module sub-types that may need to be configured @@ -52,7 +52,7 @@ Used by various module sub-types that may need to be configured > `protected` **currentConfig**: `undefined` \| `Config` -Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L34) +Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L34) Store the config separately, so that we can apply additional checks when retrieving it via the getter @@ -65,7 +65,7 @@ checks when retrieving it via the getter > **get** **config**(): `Config` -Defined in: [packages/common/src/config/ConfigurableModule.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L37) +Defined in: [packages/common/src/config/ConfigurableModule.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L37) ##### Returns @@ -75,7 +75,7 @@ Defined in: [packages/common/src/config/ConfigurableModule.ts:37](https://github > **set** **config**(`config`): `void` -Defined in: [packages/common/src/config/ConfigurableModule.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L45) +Defined in: [packages/common/src/config/ConfigurableModule.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L45) ##### Parameters @@ -97,7 +97,7 @@ Defined in: [packages/common/src/config/ConfigurableModule.ts:45](https://github > **create**(`childContainerProvider`): `void` -Defined in: [packages/common/src/config/ConfigurableModule.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L49) +Defined in: [packages/common/src/config/ConfigurableModule.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L49) #### Parameters diff --git a/src/pages/docs/reference/common/classes/EventEmitter.md b/src/pages/docs/reference/common/classes/EventEmitter.md index 1328d58..dbcb722 100644 --- a/src/pages/docs/reference/common/classes/EventEmitter.md +++ b/src/pages/docs/reference/common/classes/EventEmitter.md @@ -10,7 +10,7 @@ title: EventEmitter # Class: EventEmitter\ -Defined in: [packages/common/src/events/EventEmitter.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L7) +Defined in: [packages/common/src/events/EventEmitter.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L7) ## Extended by @@ -37,7 +37,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:7](https://github.com/pr > `protected` `readonly` **listeners**: `ListenersHolder`\<`Events`\> = `{}` -Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L8) +Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L8) *** @@ -45,7 +45,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/pr > `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` -Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L10) +Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L10) #### Parameters @@ -67,7 +67,7 @@ keyof `Events` > **emit**\<`Key`\>(`event`, ...`parameters`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L15) +Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L15) #### Type Parameters @@ -93,7 +93,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/p > **off**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L45) +Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L45) Primitive .off() with identity comparison for now. Could be replaced by returning an id in .on() and using that. @@ -122,7 +122,7 @@ Could be replaced by returning an id in .on() and using that. > **on**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L34) +Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L34) #### Type Parameters @@ -148,7 +148,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/p > **onAll**(`listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L30) +Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L30) #### Parameters diff --git a/src/pages/docs/reference/common/classes/EventEmitterProxy.md b/src/pages/docs/reference/common/classes/EventEmitterProxy.md index db834bb..d3883e4 100644 --- a/src/pages/docs/reference/common/classes/EventEmitterProxy.md +++ b/src/pages/docs/reference/common/classes/EventEmitterProxy.md @@ -10,7 +10,7 @@ title: EventEmitterProxy # Class: EventEmitterProxy\ -Defined in: [packages/common/src/events/EventEmitterProxy.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L42) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L42) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/common/src/events/EventEmitterProxy.ts:42](https://github. > **new EventEmitterProxy**\<`Modules`\>(`container`): [`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> -Defined in: [packages/common/src/events/EventEmitterProxy.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L45) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L45) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/common/src/events/EventEmitterProxy.ts:45](https://github. > `protected` `readonly` **listeners**: `ListenersHolder`\<[`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\>\> = `{}` -Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L8) +Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L8) #### Inherited from @@ -60,7 +60,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/pr > `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` -Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L10) +Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L10) #### Parameters @@ -86,7 +86,7 @@ keyof [`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIn > **emit**\<`Key`\>(`event`, ...`parameters`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L15) +Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L15) #### Type Parameters @@ -116,7 +116,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/p > **off**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L45) +Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L45) Primitive .off() with identity comparison for now. Could be replaced by returning an id in .on() and using that. @@ -149,7 +149,7 @@ Could be replaced by returning an id in .on() and using that. > **on**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L34) +Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L34) #### Type Parameters @@ -179,7 +179,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/p > **onAll**(`listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L30) +Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L30) #### Parameters diff --git a/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md b/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md index 29193dc..4c3e4bc 100644 --- a/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md +++ b/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md @@ -10,7 +10,7 @@ title: InMemoryMerkleTreeStorage # Class: InMemoryMerkleTreeStorage -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L3) +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L3) ## Extended by @@ -37,7 +37,7 @@ Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:3](https://g > `protected` **nodes**: `object` = `{}` -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L4) +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L4) #### Index Signature @@ -49,7 +49,7 @@ Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:4](https://g > **getNode**(`key`, `level`): `undefined` \| `bigint` -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L10) +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L10) #### Parameters @@ -75,7 +75,7 @@ Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:10](https:// > **setNode**(`key`, `level`, `value`): `void` -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L14) +Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L14) #### Parameters diff --git a/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md b/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md index 0e67b5c..c001175 100644 --- a/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md +++ b/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md @@ -10,7 +10,7 @@ title: MockAsyncMerkleTreeStore # Class: MockAsyncMerkleTreeStore -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L5) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L5) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:5](https://github > `readonly` **store**: [`InMemoryMerkleTreeStorage`](InMemoryMerkleTreeStorage.md) -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L6) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L6) ## Methods @@ -36,7 +36,7 @@ Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:6](https://github > **commit**(): `void` -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L8) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L8) #### Returns @@ -48,7 +48,7 @@ Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:8](https://github > **getNodeAsync**(`key`, `level`): `Promise`\<`undefined` \| `bigint`\> -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L16) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L16) #### Parameters @@ -70,7 +70,7 @@ Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:16](https://githu > **openTransaction**(): `void` -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L12) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L12) #### Returns @@ -82,7 +82,7 @@ Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:12](https://githu > **setNodeAsync**(`key`, `level`, `value`): `Promise`\<`void`\> -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MockAsyncMerkleStore.ts#L23) +Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L23) #### Parameters diff --git a/src/pages/docs/reference/common/classes/ModuleContainer.md b/src/pages/docs/reference/common/classes/ModuleContainer.md index 532284e..ac8f44d 100644 --- a/src/pages/docs/reference/common/classes/ModuleContainer.md +++ b/src/pages/docs/reference/common/classes/ModuleContainer.md @@ -10,7 +10,7 @@ title: ModuleContainer # Class: ModuleContainer\ -Defined in: [packages/common/src/config/ModuleContainer.ts:145](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L145) +Defined in: [packages/common/src/config/ModuleContainer.ts:145](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L145) Reusable module container facilitating registration, resolution configuration, decoration and validation of modules @@ -41,7 +41,7 @@ configuration, decoration and validation of modules > **new ModuleContainer**\<`Modules`\>(`definition`): [`ModuleContainer`](ModuleContainer.md)\<`Modules`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L159) +Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L159) #### Parameters @@ -63,7 +63,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.c > `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> -Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L34) +Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L34) Store the config separately, so that we can apply additional checks when retrieving it via the getter @@ -78,7 +78,7 @@ checks when retrieving it via the getter > **definition**: [`ModuleContainerDefinition`](../interfaces/ModuleContainerDefinition.md)\<`Modules`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L159) +Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L159) ## Accessors @@ -88,7 +88,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.c > **get** **config**(): [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:317](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L317) +Defined in: [packages/common/src/config/ModuleContainer.ts:317](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L317) ##### Returns @@ -98,7 +98,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:317](https://github.c > **set** **config**(`config`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:321](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L321) +Defined in: [packages/common/src/config/ModuleContainer.ts:321](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L321) ##### Parameters @@ -122,7 +122,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:321](https://github.c > **get** `protected` **container**(): `DependencyContainer` -Defined in: [packages/common/src/config/ModuleContainer.ts:199](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L199) +Defined in: [packages/common/src/config/ModuleContainer.ts:199](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L199) ##### Returns @@ -136,7 +136,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:199](https://github.c > **get** **events**(): [`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:270](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L270) +Defined in: [packages/common/src/config/ModuleContainer.ts:270](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L270) ##### Returns @@ -150,7 +150,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:270](https://github.c > **get** **moduleNames**(): `string`[] -Defined in: [packages/common/src/config/ModuleContainer.ts:166](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L166) +Defined in: [packages/common/src/config/ModuleContainer.ts:166](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L166) ##### Returns @@ -164,7 +164,7 @@ list of module names > **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` -Defined in: [packages/common/src/config/ModuleContainer.ts:224](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L224) +Defined in: [packages/common/src/config/ModuleContainer.ts:224](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L224) #### Parameters @@ -182,7 +182,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:224](https://github.c > **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` -Defined in: [packages/common/src/config/ModuleContainer.ts:209](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L209) +Defined in: [packages/common/src/config/ModuleContainer.ts:209](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L209) Assert that the iterated `moduleName` is of ModuleName type, otherwise it may be just string e.g. when modules are iterated over @@ -204,7 +204,7 @@ using e.g. a for loop. > **configure**(`config`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:306](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L306) +Defined in: [packages/common/src/config/ModuleContainer.ts:306](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L306) Provide additional configuration after the ModuleContainer was created. @@ -228,7 +228,7 @@ before the first resolution. > **configurePartial**(`config`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:310](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L310) +Defined in: [packages/common/src/config/ModuleContainer.ts:310](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L310) #### Parameters @@ -246,7 +246,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:310](https://github.c > **create**(`childContainerProvider`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:479](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L479) +Defined in: [packages/common/src/config/ModuleContainer.ts:477](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L477) This is a placeholder for individual modules to override. This method will be called whenever the underlying container fully @@ -272,7 +272,7 @@ initialized > `protected` **decorateModule**(`moduleName`, `containedModule`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L364) +Defined in: [packages/common/src/config/ModuleContainer.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L364) Override this in the child class to provide custom features or module checks @@ -297,7 +297,7 @@ features or module checks > `protected` **initializeDependencyFactories**(`factories`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:389](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L389) +Defined in: [packages/common/src/config/ModuleContainer.ts:389](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L389) Inject a set of dependencies using the given list of DependencyFactories This method should be called during startup @@ -318,7 +318,7 @@ This method should be called during startup > **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` -Defined in: [packages/common/src/config/ModuleContainer.ts:217](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L217) +Defined in: [packages/common/src/config/ModuleContainer.ts:217](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L217) #### Parameters @@ -340,7 +340,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:217](https://github.c > `protected` **onAfterModuleResolution**(`moduleName`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:451](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L451) +Defined in: [packages/common/src/config/ModuleContainer.ts:449](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L449) Handle module resolution, e.g. by decorating resolved modules @@ -360,7 +360,7 @@ Handle module resolution, e.g. by decorating resolved modules > `protected` **registerAliases**(`originalToken`, `clas`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:232](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L232) +Defined in: [packages/common/src/config/ModuleContainer.ts:232](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L232) #### Parameters @@ -382,7 +382,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:232](https://github.c > `protected` **registerClasses**(`modules`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:288](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L288) +Defined in: [packages/common/src/config/ModuleContainer.ts:288](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L288) #### Parameters @@ -400,7 +400,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:288](https://github.c > `protected` **registerModules**(`modules`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:249](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L249) +Defined in: [packages/common/src/config/ModuleContainer.ts:249](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L249) Register modules into the current container, and registers a respective resolution hook in order to decorate the module @@ -422,7 +422,7 @@ upon/after resolution. > **registerValue**\<`Value`\>(`modules`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L282) +Defined in: [packages/common/src/config/ModuleContainer.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L282) Register a non-module value into the current container @@ -446,7 +446,7 @@ Register a non-module value into the current container > **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> -Defined in: [packages/common/src/config/ModuleContainer.ts:338](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L338) +Defined in: [packages/common/src/config/ModuleContainer.ts:338](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L338) Resolves a module from the current module container @@ -474,7 +474,7 @@ be any module instance, not the one specifically requested as argument. > **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` -Defined in: [packages/common/src/config/ModuleContainer.ts:346](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L346) +Defined in: [packages/common/src/config/ModuleContainer.ts:346](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L346) #### Type Parameters @@ -500,7 +500,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:346](https://github.c > `protected` **validateModule**(`moduleName`, `containedModule`): `void` -Defined in: [packages/common/src/config/ModuleContainer.ts:177](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L177) +Defined in: [packages/common/src/config/ModuleContainer.ts:177](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L177) Check if the provided module satisfies the container requirements, such as only injecting other known modules. diff --git a/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md b/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md index 8a210a7..eff13e2 100644 --- a/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md +++ b/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md @@ -10,7 +10,7 @@ title: ProvableMethodExecutionContext # Class: ProvableMethodExecutionContext -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L48) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L48) Execution context used to wrap runtime module methods, allowing them to post relevant information (such as execution status) @@ -36,7 +36,7 @@ into the context without any unnecessary 'prop drilling'. > **id**: `string` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L49) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L49) *** @@ -44,7 +44,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **methods**: `string`[] = `[]` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L51) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L51) *** @@ -52,7 +52,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **result**: [`ProvableMethodExecutionResult`](ProvableMethodExecutionResult.md) -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L53) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L53) ## Accessors @@ -62,7 +62,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **get** **isFinished**(): `boolean` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L102) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L102) ##### Returns @@ -76,7 +76,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **get** **isTopLevel**(): `boolean` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L98) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:98](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L98) ##### Returns @@ -88,7 +88,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **afterMethod**(): `void` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L94) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L94) Removes the latest method from the execution context stack, keeping track of the amount of 'unfinished' methods. Allowing @@ -104,7 +104,7 @@ for the context to distinguish between top-level and nested method calls. > **beforeMethod**(`moduleName`, `methodName`, `args`): `void` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L74) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L74) 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. @@ -135,7 +135,7 @@ Name of the method being captured in the context > **clear**(): `void` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:119](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L119) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:119](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L119) Manually clears/resets the execution context @@ -149,7 +149,7 @@ Manually clears/resets the execution context > **current**(): `object` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L109) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L109) #### Returns @@ -171,7 +171,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **setProver**(`prover`): `void` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L64) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L64) Adds a method prover to the current execution context, which can be collected and ran asynchronously at a later point in time. diff --git a/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md b/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md index cc77a39..e927474 100644 --- a/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md +++ b/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md @@ -10,7 +10,7 @@ title: ProvableMethodExecutionResult # Class: ProvableMethodExecutionResult -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L16) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L16) ## Extended by @@ -32,7 +32,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > `optional` **args**: [`ArgumentTypes`](../type-aliases/ArgumentTypes.md) -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L21) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L21) *** @@ -40,7 +40,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > `optional` **methodName**: `string` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L19) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L19) *** @@ -48,7 +48,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > `optional` **moduleName**: `string` -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L17) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L17) *** @@ -56,7 +56,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > `optional` **prover**: () => `Promise`\<`Proof`\<`unknown`, `unknown`\>\> -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L23) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L23) #### Returns @@ -68,7 +68,7 @@ Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.t > **prove**\<`ProofType`\>(): `Promise`\<`ProofType`\> -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L25) +Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L25) #### Type Parameters diff --git a/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md b/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md index 08bf43b..eab735c 100644 --- a/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md +++ b/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md @@ -10,7 +10,7 @@ title: ReplayingSingleUseEventEmitter # Class: ReplayingSingleUseEventEmitter\ -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L12) +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L12) Event Emitter variant that emits a certain event only once to a registered listener. Additionally, if a listener registers to a event that has already been emitted, it @@ -47,7 +47,7 @@ so we need to make sure they get notified as well in those cases. > **emitted**: `Partial`\<`Events`\> = `{}` -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L15) +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L15) *** @@ -55,7 +55,7 @@ Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:15](ht > `protected` `readonly` **listeners**: `ListenersHolder`\<`Events`\> = `{}` -Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L8) +Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L8) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/pr > `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` -Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L10) +Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L10) #### Parameters @@ -93,7 +93,7 @@ keyof `Events` > **emit**\<`Key`\>(`event`, ...`parameters`): `void` -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L17) +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L17) #### Type Parameters @@ -123,7 +123,7 @@ Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:17](ht > **off**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L45) +Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L45) Primitive .off() with identity comparison for now. Could be replaced by returning an id in .on() and using that. @@ -156,7 +156,7 @@ Could be replaced by returning an id in .on() and using that. > **on**\<`Key`\>(`event`, `listener`): `void` -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L33) +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L33) #### Type Parameters @@ -186,7 +186,7 @@ Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:33](ht > **onAll**(`listener`): `void` -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L26) +Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L26) #### Parameters diff --git a/src/pages/docs/reference/common/classes/RollupMerkleTree.md b/src/pages/docs/reference/common/classes/RollupMerkleTree.md index f870e9e..3e2d3ca 100644 --- a/src/pages/docs/reference/common/classes/RollupMerkleTree.md +++ b/src/pages/docs/reference/common/classes/RollupMerkleTree.md @@ -10,7 +10,7 @@ title: RollupMerkleTree # Class: RollupMerkleTree -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:344](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L344) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:344](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L344) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:344](https://github.c > **new RollupMerkleTree**(`store`): [`RollupMerkleTree`](RollupMerkleTree.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L85) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L85) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.co > `readonly` **leafCount**: `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L43) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L43) #### Inherited from @@ -56,7 +56,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.co > **store**: [`MerkleTreeStore`](../interfaces/MerkleTreeStore.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L42) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L42) #### Inherited from @@ -68,7 +68,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.co > `static` **EMPTY\_ROOT**: `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L92) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L92) #### Inherited from @@ -80,7 +80,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.co > `static` **HEIGHT**: `number` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L90) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L90) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.co > `static` **WITNESS**: [`TypedClass`](../type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L87) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L87) #### Type declaration @@ -116,7 +116,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.co > **get** `static` **leafCount**(): `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L94) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L94) ##### Returns @@ -132,7 +132,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.co > **assertIndexRange**(`index`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L45) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L45) #### Parameters @@ -154,7 +154,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.co > **fill**(`leaves`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L81) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L81) Fills all leaves of the tree. @@ -180,7 +180,7 @@ Values to fill the leaves with. > **getNode**(`level`, `index`): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L53) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L53) Returns a node which lives at a given index and level. @@ -214,7 +214,7 @@ The data of the node. > **getRoot**(): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L59) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L59) Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). @@ -234,7 +234,7 @@ The root of the Merkle Tree. > **getWitness**(`index`): [`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L75) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L75) Returns the witness (also known as [Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) @@ -264,7 +264,7 @@ The witness that belongs to the leaf. > **setLeaf**(`index`, `leaf`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L66) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L66) Sets the value of a leaf node at a given index to a given value. diff --git a/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md b/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md index 4649934..ab17916 100644 --- a/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md +++ b/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md @@ -10,7 +10,7 @@ title: RollupMerkleTreeWitness # Class: RollupMerkleTreeWitness -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:345](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L345) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:345](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L345) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **isLeft**: `Bool`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L11) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L11) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.co > **path**: `Field`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L10) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L10) #### Inherited from @@ -121,7 +121,7 @@ the element of type `T` to put assertions on. > `static` **dummy**: () => [`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L88) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L88) #### Returns @@ -422,7 +422,7 @@ Convert provable type to a normal JS type. > **calculateIndex**(): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L28) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L28) Calculates the index of the leaf node that belongs to this Witness. @@ -442,7 +442,7 @@ Index of the leaf. > **calculateRoot**(`hash`): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L22) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L22) Calculates a root depending on the leaf value. @@ -468,7 +468,7 @@ The calculated root. > **checkMembership**(`root`, `key`, `value`): `Bool` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L30) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L30) #### Parameters @@ -498,7 +498,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.co > **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L32) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L32) #### Parameters @@ -528,7 +528,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.co > **height**(): `number` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L15) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L15) #### Returns @@ -544,7 +544,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.co > **toShortenedEntries**(): `string`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L38) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L38) #### Returns diff --git a/src/pages/docs/reference/common/classes/ZkProgrammable.md b/src/pages/docs/reference/common/classes/ZkProgrammable.md index 2417bb0..707e9a7 100644 --- a/src/pages/docs/reference/common/classes/ZkProgrammable.md +++ b/src/pages/docs/reference/common/classes/ZkProgrammable.md @@ -10,7 +10,7 @@ title: ZkProgrammable # Class: `abstract` ZkProgrammable\ -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:99](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L99) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:99](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L99) ## Extended by @@ -42,7 +42,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:99](https://gi > **get** `abstract` **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:103](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L103) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:103](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L103) ##### Returns @@ -56,7 +56,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:103](https://g > **get** **zkProgram**(): [`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L113) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L113) ##### Returns @@ -68,7 +68,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:113](https://g > **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../interfaces/CompileArtifact.md)\>\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L130) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L130) #### Parameters @@ -86,7 +86,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:130](https://g > `abstract` **zkProgramFactory**(): [`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L105) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L105) #### Returns diff --git a/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md b/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md index d8fac1d..b74858b 100644 --- a/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md +++ b/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md @@ -12,7 +12,7 @@ title: assertValidTextLogLevel > **assertValidTextLogLevel**(`level`): `asserts level is LogLevelNames` -Defined in: [packages/common/src/log.ts:134](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/log.ts#L134) +Defined in: [packages/common/src/log.ts:134](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/log.ts#L134) ## Parameters diff --git a/src/pages/docs/reference/common/functions/compileToMockable.md b/src/pages/docs/reference/common/functions/compileToMockable.md index d9eb256..752e490 100644 --- a/src/pages/docs/reference/common/functions/compileToMockable.md +++ b/src/pages/docs/reference/common/functions/compileToMockable.md @@ -12,7 +12,7 @@ title: compileToMockable > **compileToMockable**(`compile`, `__namedParameters`): () => `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L84) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L84) ## Parameters diff --git a/src/pages/docs/reference/common/functions/createMerkleTree.md b/src/pages/docs/reference/common/functions/createMerkleTree.md index fbaaee4..3aabee6 100644 --- a/src/pages/docs/reference/common/functions/createMerkleTree.md +++ b/src/pages/docs/reference/common/functions/createMerkleTree.md @@ -12,7 +12,7 @@ title: createMerkleTree > **createMerkleTree**(`height`): [`AbstractMerkleTreeClass`](../interfaces/AbstractMerkleTreeClass.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:116](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L116) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:116](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L116) A [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree) is a binary tree in which every leaf is the cryptography hash of a piece of data, diff --git a/src/pages/docs/reference/common/functions/dummyValue.md b/src/pages/docs/reference/common/functions/dummyValue.md index e5a6980..db4d4f0 100644 --- a/src/pages/docs/reference/common/functions/dummyValue.md +++ b/src/pages/docs/reference/common/functions/dummyValue.md @@ -12,7 +12,7 @@ title: dummyValue > **dummyValue**\<`Value`\>(`valueType`): `Value` -Defined in: [packages/common/src/utils.ts:93](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L93) +Defined in: [packages/common/src/utils.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L93) Computes a dummy value for the given value type. diff --git a/src/pages/docs/reference/common/functions/expectDefined.md b/src/pages/docs/reference/common/functions/expectDefined.md index b62c95c..30d1375 100644 --- a/src/pages/docs/reference/common/functions/expectDefined.md +++ b/src/pages/docs/reference/common/functions/expectDefined.md @@ -12,7 +12,7 @@ title: expectDefined > **expectDefined**\<`T`\>(`value`): `asserts value is T` -Defined in: [packages/common/src/utils.ts:165](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L165) +Defined in: [packages/common/src/utils.ts:165](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L165) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/filterNonNull.md b/src/pages/docs/reference/common/functions/filterNonNull.md index 2eb93e7..1b52094 100644 --- a/src/pages/docs/reference/common/functions/filterNonNull.md +++ b/src/pages/docs/reference/common/functions/filterNonNull.md @@ -12,7 +12,7 @@ title: filterNonNull > **filterNonNull**\<`Type`\>(`value`): `value is Type` -Defined in: [packages/common/src/utils.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L132) +Defined in: [packages/common/src/utils.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L132) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/filterNonUndefined.md b/src/pages/docs/reference/common/functions/filterNonUndefined.md index dd7ff05..1b762fe 100644 --- a/src/pages/docs/reference/common/functions/filterNonUndefined.md +++ b/src/pages/docs/reference/common/functions/filterNonUndefined.md @@ -12,7 +12,7 @@ title: filterNonUndefined > **filterNonUndefined**\<`Type`\>(`value`): `value is Type` -Defined in: [packages/common/src/utils.ts:136](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L136) +Defined in: [packages/common/src/utils.ts:136](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L136) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/getInjectAliases.md b/src/pages/docs/reference/common/functions/getInjectAliases.md index aff10ca..cd7c0a2 100644 --- a/src/pages/docs/reference/common/functions/getInjectAliases.md +++ b/src/pages/docs/reference/common/functions/getInjectAliases.md @@ -12,7 +12,7 @@ title: getInjectAliases > **getInjectAliases**(`target`): `string`[] -Defined in: [packages/common/src/config/injectAlias.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/injectAlias.ts#L63) +Defined in: [packages/common/src/config/injectAlias.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/injectAlias.ts#L63) ## Parameters diff --git a/src/pages/docs/reference/common/functions/hashWithPrefix.md b/src/pages/docs/reference/common/functions/hashWithPrefix.md index fed6daa..308f657 100644 --- a/src/pages/docs/reference/common/functions/hashWithPrefix.md +++ b/src/pages/docs/reference/common/functions/hashWithPrefix.md @@ -12,7 +12,7 @@ title: hashWithPrefix > **hashWithPrefix**(`prefix`, `input`): `Field` -Defined in: [packages/common/src/utils.ts:154](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L154) +Defined in: [packages/common/src/utils.ts:154](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L154) ## Parameters diff --git a/src/pages/docs/reference/common/functions/implement.md b/src/pages/docs/reference/common/functions/implement.md index 44c19e5..c7a335d 100644 --- a/src/pages/docs/reference/common/functions/implement.md +++ b/src/pages/docs/reference/common/functions/implement.md @@ -12,7 +12,7 @@ title: implement > **implement**\<`T`\>(`name`): (`target`) => `void` -Defined in: [packages/common/src/config/injectAlias.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/injectAlias.ts#L51) +Defined in: [packages/common/src/config/injectAlias.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/injectAlias.ts#L51) Marks the class to implement a certain interface T, while also attaching a DI-injection alias as metadata, that will be picked up by the ModuleContainer diff --git a/src/pages/docs/reference/common/functions/injectAlias.md b/src/pages/docs/reference/common/functions/injectAlias.md index d37b3a6..846174e 100644 --- a/src/pages/docs/reference/common/functions/injectAlias.md +++ b/src/pages/docs/reference/common/functions/injectAlias.md @@ -12,7 +12,7 @@ title: injectAlias > **injectAlias**(`aliases`): (`target`) => `void` -Defined in: [packages/common/src/config/injectAlias.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/injectAlias.ts#L11) +Defined in: [packages/common/src/config/injectAlias.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/injectAlias.ts#L11) Attaches metadata to the class that the ModuleContainer can pick up and inject this class in the DI container under the specified aliases. diff --git a/src/pages/docs/reference/common/functions/injectOptional.md b/src/pages/docs/reference/common/functions/injectOptional.md index 7351f75..f17be2e 100644 --- a/src/pages/docs/reference/common/functions/injectOptional.md +++ b/src/pages/docs/reference/common/functions/injectOptional.md @@ -12,7 +12,7 @@ title: injectOptional > **injectOptional**\<`T`\>(`token`): (`target`, `propertyKey`, `parameterIndex`) => `any` -Defined in: [packages/common/src/dependencyFactory/injectOptional.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/injectOptional.ts#L38) +Defined in: [packages/common/src/dependencyFactory/injectOptional.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/injectOptional.ts#L38) This function injects a dependency only if it has been registered, otherwise injects undefined. This can be useful for having optional dependencies, where diff --git a/src/pages/docs/reference/common/functions/isSubtypeOfName.md b/src/pages/docs/reference/common/functions/isSubtypeOfName.md index 488dd09..2986ed7 100644 --- a/src/pages/docs/reference/common/functions/isSubtypeOfName.md +++ b/src/pages/docs/reference/common/functions/isSubtypeOfName.md @@ -12,7 +12,7 @@ title: isSubtypeOfName > **isSubtypeOfName**(`clas`, `name`): `boolean` -Defined in: [packages/common/src/utils.ts:181](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L181) +Defined in: [packages/common/src/utils.ts:181](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L181) Returns a boolean indicating whether a given class is a subclass of another class, indicated by the name parameter. diff --git a/src/pages/docs/reference/common/functions/mapSequential.md b/src/pages/docs/reference/common/functions/mapSequential.md index 473070a..4b06604 100644 --- a/src/pages/docs/reference/common/functions/mapSequential.md +++ b/src/pages/docs/reference/common/functions/mapSequential.md @@ -12,7 +12,7 @@ title: mapSequential > **mapSequential**\<`T`, `R`\>(`array`, `f`): `Promise`\<`R`[]\> -Defined in: [packages/common/src/utils.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L75) +Defined in: [packages/common/src/utils.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L75) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/noop.md b/src/pages/docs/reference/common/functions/noop.md index 1103d87..b9df3dc 100644 --- a/src/pages/docs/reference/common/functions/noop.md +++ b/src/pages/docs/reference/common/functions/noop.md @@ -12,7 +12,7 @@ title: noop > **noop**(): `void` -Defined in: [packages/common/src/utils.ts:103](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L103) +Defined in: [packages/common/src/utils.ts:103](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L103) ## Returns diff --git a/src/pages/docs/reference/common/functions/prefixToField.md b/src/pages/docs/reference/common/functions/prefixToField.md index 0c2292b..8aebadc 100644 --- a/src/pages/docs/reference/common/functions/prefixToField.md +++ b/src/pages/docs/reference/common/functions/prefixToField.md @@ -12,7 +12,7 @@ title: prefixToField > **prefixToField**(`prefix`): `Field` -Defined in: [packages/common/src/utils.ts:145](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L145) +Defined in: [packages/common/src/utils.ts:145](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L145) ## Parameters diff --git a/src/pages/docs/reference/common/functions/provableMethod.md b/src/pages/docs/reference/common/functions/provableMethod.md index db76aac..7d41395 100644 --- a/src/pages/docs/reference/common/functions/provableMethod.md +++ b/src/pages/docs/reference/common/functions/provableMethod.md @@ -12,7 +12,7 @@ title: provableMethod > **provableMethod**(`isFirstParameterPublicInput`, `executionContext`): \<`Target`\>(`target`, `methodName`, `descriptor`) => `TypedPropertyDescriptor`\<(...`args`) => `any`\> -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L70) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L70) Decorates a provable method on a 'prover class', depending on if proofs are enabled or not, either runs the respective zkProgram prover, diff --git a/src/pages/docs/reference/common/functions/range.md b/src/pages/docs/reference/common/functions/range.md index f6a6409..cb75f1b 100644 --- a/src/pages/docs/reference/common/functions/range.md +++ b/src/pages/docs/reference/common/functions/range.md @@ -12,7 +12,7 @@ title: range > **range**(`startOrEnd`, `endOrNothing`?): `number`[] -Defined in: [packages/common/src/utils.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L43) +Defined in: [packages/common/src/utils.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L43) ## Parameters diff --git a/src/pages/docs/reference/common/functions/reduceSequential.md b/src/pages/docs/reference/common/functions/reduceSequential.md index 8400211..63d7e6a 100644 --- a/src/pages/docs/reference/common/functions/reduceSequential.md +++ b/src/pages/docs/reference/common/functions/reduceSequential.md @@ -12,7 +12,7 @@ title: reduceSequential > **reduceSequential**\<`T`, `U`\>(`array`, `callbackfn`, `initialValue`): `Promise`\<`U`\> -Defined in: [packages/common/src/utils.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L56) +Defined in: [packages/common/src/utils.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L56) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/requireTrue.md b/src/pages/docs/reference/common/functions/requireTrue.md index 90670e1..b5b1bb2 100644 --- a/src/pages/docs/reference/common/functions/requireTrue.md +++ b/src/pages/docs/reference/common/functions/requireTrue.md @@ -12,7 +12,7 @@ title: requireTrue > **requireTrue**(`condition`, `errorOrFunction`): `void` -Defined in: [packages/common/src/utils.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L11) +Defined in: [packages/common/src/utils.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L11) ## Parameters diff --git a/src/pages/docs/reference/common/functions/safeParseJson.md b/src/pages/docs/reference/common/functions/safeParseJson.md index 52f7b61..dc90b95 100644 --- a/src/pages/docs/reference/common/functions/safeParseJson.md +++ b/src/pages/docs/reference/common/functions/safeParseJson.md @@ -12,7 +12,7 @@ title: safeParseJson > **safeParseJson**\<`T`\>(`json`): `T` -Defined in: [packages/common/src/utils.ts:197](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L197) +Defined in: [packages/common/src/utils.ts:197](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L197) ## Type Parameters diff --git a/src/pages/docs/reference/common/functions/sleep.md b/src/pages/docs/reference/common/functions/sleep.md index 6409a8a..abf5646 100644 --- a/src/pages/docs/reference/common/functions/sleep.md +++ b/src/pages/docs/reference/common/functions/sleep.md @@ -12,7 +12,7 @@ title: sleep > **sleep**(`ms`): `Promise`\<`void`\> -Defined in: [packages/common/src/utils.ts:126](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L126) +Defined in: [packages/common/src/utils.ts:126](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L126) ## Parameters diff --git a/src/pages/docs/reference/common/functions/splitArray.md b/src/pages/docs/reference/common/functions/splitArray.md index fd44893..98cde3c 100644 --- a/src/pages/docs/reference/common/functions/splitArray.md +++ b/src/pages/docs/reference/common/functions/splitArray.md @@ -12,7 +12,7 @@ title: splitArray > **splitArray**\<`T`, `K`\>(`arr`, `split`): `Record`\<`K`, `T`[] \| `undefined`\> -Defined in: [packages/common/src/utils.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L26) +Defined in: [packages/common/src/utils.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L26) Utility function to split an array of type T into a record based on a function T => K that determines the key of each record diff --git a/src/pages/docs/reference/common/functions/toProver.md b/src/pages/docs/reference/common/functions/toProver.md index 13504a2..8fa2183 100644 --- a/src/pages/docs/reference/common/functions/toProver.md +++ b/src/pages/docs/reference/common/functions/toProver.md @@ -12,7 +12,7 @@ title: toProver > **toProver**(`methodName`, `simulatedMethod`, `isFirstParameterPublicInput`, ...`args`): (`this`) => `Promise`\<`Proof`\<`any`, `any`\>\> -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L20) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L20) ## Parameters diff --git a/src/pages/docs/reference/common/functions/verifyToMockable.md b/src/pages/docs/reference/common/functions/verifyToMockable.md index 485ac24..180a889 100644 --- a/src/pages/docs/reference/common/functions/verifyToMockable.md +++ b/src/pages/docs/reference/common/functions/verifyToMockable.md @@ -12,7 +12,7 @@ title: verifyToMockable > **verifyToMockable**\<`PublicInput`, `PublicOutput`\>(`verify`, `__namedParameters`): (`proof`) => `Promise`\<`boolean`\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L59) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L59) ## Type Parameters diff --git a/src/pages/docs/reference/common/globals.md b/src/pages/docs/reference/common/globals.md deleted file mode 100644 index 3775e10..0000000 --- a/src/pages/docs/reference/common/globals.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -title: "@proto-kit/common" ---- - -[**@proto-kit/common**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/common - -# @proto-kit/common - -## Classes - -- [AtomicCompileHelper](classes/AtomicCompileHelper.md) -- [ChildVerificationKeyService](classes/ChildVerificationKeyService.md) -- [CompileRegistry](classes/CompileRegistry.md) -- [ConfigurableModule](classes/ConfigurableModule.md) -- [EventEmitter](classes/EventEmitter.md) -- [EventEmitterProxy](classes/EventEmitterProxy.md) -- [InMemoryMerkleTreeStorage](classes/InMemoryMerkleTreeStorage.md) -- [MockAsyncMerkleTreeStore](classes/MockAsyncMerkleTreeStore.md) -- [ModuleContainer](classes/ModuleContainer.md) -- [ProvableMethodExecutionContext](classes/ProvableMethodExecutionContext.md) -- [ProvableMethodExecutionResult](classes/ProvableMethodExecutionResult.md) -- [ReplayingSingleUseEventEmitter](classes/ReplayingSingleUseEventEmitter.md) -- [RollupMerkleTree](classes/RollupMerkleTree.md) -- [RollupMerkleTreeWitness](classes/RollupMerkleTreeWitness.md) -- [ZkProgrammable](classes/ZkProgrammable.md) - -## Interfaces - -- [AbstractMerkleTree](interfaces/AbstractMerkleTree.md) -- [AbstractMerkleTreeClass](interfaces/AbstractMerkleTreeClass.md) -- [AbstractMerkleWitness](interfaces/AbstractMerkleWitness.md) -- [AreProofsEnabled](interfaces/AreProofsEnabled.md) -- [BaseModuleInstanceType](interfaces/BaseModuleInstanceType.md) -- [ChildContainerCreatable](interfaces/ChildContainerCreatable.md) -- [ChildContainerProvider](interfaces/ChildContainerProvider.md) -- [CompilableModule](interfaces/CompilableModule.md) -- [Compile](interfaces/Compile.md) -- [CompileArtifact](interfaces/CompileArtifact.md) -- [Configurable](interfaces/Configurable.md) -- [DependencyFactory](interfaces/DependencyFactory.md) -- [EventEmittingComponent](interfaces/EventEmittingComponent.md) -- [EventEmittingContainer](interfaces/EventEmittingContainer.md) -- [MerkleTreeStore](interfaces/MerkleTreeStore.md) -- [ModuleContainerDefinition](interfaces/ModuleContainerDefinition.md) -- [ModulesRecord](interfaces/ModulesRecord.md) -- [PlainZkProgram](interfaces/PlainZkProgram.md) -- [StaticConfigurableModule](interfaces/StaticConfigurableModule.md) -- [ToFieldable](interfaces/ToFieldable.md) -- [ToFieldableStatic](interfaces/ToFieldableStatic.md) -- [ToJSONableStatic](interfaces/ToJSONableStatic.md) -- [Verify](interfaces/Verify.md) -- [WithZkProgrammable](interfaces/WithZkProgrammable.md) - -## Type Aliases - -- [ArgumentTypes](type-aliases/ArgumentTypes.md) -- [ArrayElement](type-aliases/ArrayElement.md) -- [ArtifactRecord](type-aliases/ArtifactRecord.md) -- [BaseModuleType](type-aliases/BaseModuleType.md) -- [CapitalizeAny](type-aliases/CapitalizeAny.md) -- [CastToEventsRecord](type-aliases/CastToEventsRecord.md) -- [CompileTarget](type-aliases/CompileTarget.md) -- [ContainerEvents](type-aliases/ContainerEvents.md) -- [DecoratedMethod](type-aliases/DecoratedMethod.md) -- [DependenciesFromModules](type-aliases/DependenciesFromModules.md) -- [DependencyDeclaration](type-aliases/DependencyDeclaration.md) -- [DependencyRecord](type-aliases/DependencyRecord.md) -- [EventListenable](type-aliases/EventListenable.md) -- [EventsRecord](type-aliases/EventsRecord.md) -- [FilterNeverValues](type-aliases/FilterNeverValues.md) -- [FlattenedContainerEvents](type-aliases/FlattenedContainerEvents.md) -- [FlattenObject](type-aliases/FlattenObject.md) -- [InferDependencies](type-aliases/InferDependencies.md) -- [InferProofBase](type-aliases/InferProofBase.md) -- [MapDependencyRecordToTypes](type-aliases/MapDependencyRecordToTypes.md) -- [MergeObjects](type-aliases/MergeObjects.md) -- [ModuleEvents](type-aliases/ModuleEvents.md) -- [ModulesConfig](type-aliases/ModulesConfig.md) -- [NoConfig](type-aliases/NoConfig.md) -- [NonMethods](type-aliases/NonMethods.md) -- [O1JSPrimitive](type-aliases/O1JSPrimitive.md) -- [OmitKeys](type-aliases/OmitKeys.md) -- [OverwriteObjectType](type-aliases/OverwriteObjectType.md) -- [Preset](type-aliases/Preset.md) -- [Presets](type-aliases/Presets.md) -- [ProofTypes](type-aliases/ProofTypes.md) -- [RecursivePartial](type-aliases/RecursivePartial.md) -- [ResolvableModules](type-aliases/ResolvableModules.md) -- [StringKeyOf](type-aliases/StringKeyOf.md) -- [TypedClass](type-aliases/TypedClass.md) -- [TypeFromDependencyDeclaration](type-aliases/TypeFromDependencyDeclaration.md) -- [UnionToIntersection](type-aliases/UnionToIntersection.md) -- [UnTypedClass](type-aliases/UnTypedClass.md) - -## Variables - -- [EMPTY\_PUBLICKEY](variables/EMPTY_PUBLICKEY.md) -- [EMPTY\_PUBLICKEY\_X](variables/EMPTY_PUBLICKEY_X.md) -- [injectAliasMetadataKey](variables/injectAliasMetadataKey.md) -- [log](variables/log.md) -- [MAX\_FIELD](variables/MAX_FIELD.md) -- [MOCK\_PROOF](variables/MOCK_PROOF.md) -- [MOCK\_VERIFICATION\_KEY](variables/MOCK_VERIFICATION_KEY.md) -- [ModuleContainerErrors](variables/ModuleContainerErrors.md) - -## Functions - -- [assertValidTextLogLevel](functions/assertValidTextLogLevel.md) -- [compileToMockable](functions/compileToMockable.md) -- [createMerkleTree](functions/createMerkleTree.md) -- [dummyValue](functions/dummyValue.md) -- [expectDefined](functions/expectDefined.md) -- [filterNonNull](functions/filterNonNull.md) -- [filterNonUndefined](functions/filterNonUndefined.md) -- [getInjectAliases](functions/getInjectAliases.md) -- [hashWithPrefix](functions/hashWithPrefix.md) -- [implement](functions/implement.md) -- [injectAlias](functions/injectAlias.md) -- [injectOptional](functions/injectOptional.md) -- [isSubtypeOfName](functions/isSubtypeOfName.md) -- [mapSequential](functions/mapSequential.md) -- [noop](functions/noop.md) -- [prefixToField](functions/prefixToField.md) -- [provableMethod](functions/provableMethod.md) -- [range](functions/range.md) -- [reduceSequential](functions/reduceSequential.md) -- [requireTrue](functions/requireTrue.md) -- [safeParseJson](functions/safeParseJson.md) -- [sleep](functions/sleep.md) -- [splitArray](functions/splitArray.md) -- [toProver](functions/toProver.md) -- [verifyToMockable](functions/verifyToMockable.md) diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md index 91495b2..e280113 100644 --- a/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md +++ b/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md @@ -10,7 +10,7 @@ title: AbstractMerkleTree # Interface: AbstractMerkleTree -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L41) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L41) ## Extended by @@ -26,7 +26,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:41](https://github.co > `readonly` **leafCount**: `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L43) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L43) *** @@ -34,7 +34,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.co > **store**: [`MerkleTreeStore`](MerkleTreeStore.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L42) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L42) ## Methods @@ -42,7 +42,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.co > **assertIndexRange**(`index`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L45) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L45) #### Parameters @@ -60,7 +60,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.co > **fill**(`leaves`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L81) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L81) Fills all leaves of the tree. @@ -82,7 +82,7 @@ Values to fill the leaves with. > **getNode**(`level`, `index`): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L53) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L53) Returns a node which lives at a given index and level. @@ -112,7 +112,7 @@ The data of the node. > **getRoot**(): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L59) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L59) Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). @@ -128,7 +128,7 @@ The root of the Merkle Tree. > **getWitness**(`index`): [`AbstractMerkleWitness`](AbstractMerkleWitness.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L75) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L75) Returns the witness (also known as [Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) @@ -154,7 +154,7 @@ The witness that belongs to the leaf. > **setLeaf**(`index`, `leaf`): `void` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L66) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L66) Sets the value of a leaf node at a given index to a given value. diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md index e654a08..1fc2c58 100644 --- a/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md +++ b/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md @@ -10,7 +10,7 @@ title: AbstractMerkleTreeClass # Interface: AbstractMerkleTreeClass -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L84) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L84) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:84](https://github.co > **new AbstractMerkleTreeClass**(`store`): [`AbstractMerkleTree`](AbstractMerkleTree.md) -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L85) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L85) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.co > **EMPTY\_ROOT**: `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L92) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L92) *** @@ -44,7 +44,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.co > **HEIGHT**: `number` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L90) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L90) *** @@ -52,7 +52,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.co > **WITNESS**: [`TypedClass`](../type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L87) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L87) #### Type declaration @@ -72,7 +72,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.co > **get** **leafCount**(): `bigint` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L94) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L94) ##### Returns diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md index fe2c72b..1bffa24 100644 --- a/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md +++ b/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md @@ -10,7 +10,7 @@ title: AbstractMerkleWitness # Interface: AbstractMerkleWitness -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L14) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L14) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:14](https://github.co > **isLeft**: `Bool`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L11) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L11) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.co > **path**: `Field`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L10) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L10) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.co > **calculateIndex**(): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L28) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L28) Calculates the index of the leaf node that belongs to this Witness. @@ -62,7 +62,7 @@ Index of the leaf. > **calculateRoot**(`hash`): `Field` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L22) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L22) Calculates a root depending on the leaf value. @@ -84,7 +84,7 @@ The calculated root. > **checkMembership**(`root`, `key`, `value`): `Bool` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L30) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L30) #### Parameters @@ -110,7 +110,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.co > **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L32) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L32) #### Parameters @@ -136,7 +136,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.co > **height**(): `number` -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L15) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L15) #### Returns @@ -148,7 +148,7 @@ Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.co > **toShortenedEntries**(): `string`[] -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/RollupMerkleTree.ts#L38) +Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L38) #### Returns diff --git a/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md b/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md index 513503c..1b986e8 100644 --- a/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md +++ b/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md @@ -10,7 +10,7 @@ title: AreProofsEnabled # Interface: AreProofsEnabled -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L23) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L23) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:23](https://gi > **areProofsEnabled**: `boolean` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L24) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L24) *** @@ -26,7 +26,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:24](https://gi > **setProofsEnabled**: (`areProofsEnabled`) => `void` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L25) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L25) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md b/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md index c74466d..0f3b43a 100644 --- a/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md +++ b/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md @@ -10,7 +10,7 @@ title: BaseModuleInstanceType # Interface: BaseModuleInstanceType -Defined in: [packages/common/src/config/ModuleContainer.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L73) +Defined in: [packages/common/src/config/ModuleContainer.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L73) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:73](https://github.co > **config**: `unknown` -Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L19) +Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L19) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github > **create**: (`childContainerProvider`) => `void` -Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ChildContainerCreatable.ts#L4) +Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ChildContainerCreatable.ts#L4) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md b/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md index 94a75b3..5d37ba1 100644 --- a/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md +++ b/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md @@ -10,7 +10,7 @@ title: ChildContainerCreatable # Interface: ChildContainerCreatable -Defined in: [packages/common/src/config/ChildContainerCreatable.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ChildContainerCreatable.ts#L3) +Defined in: [packages/common/src/config/ChildContainerCreatable.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ChildContainerCreatable.ts#L3) ## Extended by @@ -22,7 +22,7 @@ Defined in: [packages/common/src/config/ChildContainerCreatable.ts:3](https://gi > **create**: (`childContainerProvider`) => `void` -Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ChildContainerCreatable.ts#L4) +Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ChildContainerCreatable.ts#L4) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md b/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md index 5468650..10fb096 100644 --- a/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md +++ b/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md @@ -10,11 +10,11 @@ title: ChildContainerProvider # Interface: ChildContainerProvider() -Defined in: [packages/common/src/config/ChildContainerProvider.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ChildContainerProvider.ts#L3) +Defined in: [packages/common/src/config/ChildContainerProvider.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ChildContainerProvider.ts#L3) > **ChildContainerProvider**(): `DependencyContainer` -Defined in: [packages/common/src/config/ChildContainerProvider.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ChildContainerProvider.ts#L4) +Defined in: [packages/common/src/config/ChildContainerProvider.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ChildContainerProvider.ts#L4) ## Returns diff --git a/src/pages/docs/reference/common/interfaces/CompilableModule.md b/src/pages/docs/reference/common/interfaces/CompilableModule.md index 0eb61fe..b642ef2 100644 --- a/src/pages/docs/reference/common/interfaces/CompilableModule.md +++ b/src/pages/docs/reference/common/interfaces/CompilableModule.md @@ -10,7 +10,7 @@ title: CompilableModule # Interface: CompilableModule -Defined in: [packages/common/src/compiling/CompilableModule.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompilableModule.ts#L4) +Defined in: [packages/common/src/compiling/CompilableModule.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompilableModule.ts#L4) ## Extended by @@ -23,7 +23,7 @@ Defined in: [packages/common/src/compiling/CompilableModule.ts:4](https://github > **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../type-aliases/ArtifactRecord.md)\> -Defined in: [packages/common/src/compiling/CompilableModule.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/CompilableModule.ts#L5) +Defined in: [packages/common/src/compiling/CompilableModule.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompilableModule.ts#L5) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/Compile.md b/src/pages/docs/reference/common/interfaces/Compile.md index 58c2008..861085b 100644 --- a/src/pages/docs/reference/common/interfaces/Compile.md +++ b/src/pages/docs/reference/common/interfaces/Compile.md @@ -10,11 +10,11 @@ title: Compile # Interface: Compile() -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L32) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L32) > **Compile**(): `Promise`\<[`CompileArtifact`](CompileArtifact.md)\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L33) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L33) ## Returns diff --git a/src/pages/docs/reference/common/interfaces/CompileArtifact.md b/src/pages/docs/reference/common/interfaces/CompileArtifact.md index 255c3fa..5cdda97 100644 --- a/src/pages/docs/reference/common/interfaces/CompileArtifact.md +++ b/src/pages/docs/reference/common/interfaces/CompileArtifact.md @@ -10,7 +10,7 @@ title: CompileArtifact # Interface: CompileArtifact -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L16) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L16) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:16](https://gi > **verificationKey**: `object` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L17) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L17) #### data diff --git a/src/pages/docs/reference/common/interfaces/Configurable.md b/src/pages/docs/reference/common/interfaces/Configurable.md index 4a56958..171c4ad 100644 --- a/src/pages/docs/reference/common/interfaces/Configurable.md +++ b/src/pages/docs/reference/common/interfaces/Configurable.md @@ -10,7 +10,7 @@ title: Configurable # Interface: Configurable\ -Defined in: [packages/common/src/config/ConfigurableModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L18) +Defined in: [packages/common/src/config/ConfigurableModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L18) ## Extended by @@ -26,4 +26,4 @@ Defined in: [packages/common/src/config/ConfigurableModule.ts:18](https://github > **config**: `Config` -Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L19) +Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L19) diff --git a/src/pages/docs/reference/common/interfaces/DependencyFactory.md b/src/pages/docs/reference/common/interfaces/DependencyFactory.md index 14b17d1..b015e54 100644 --- a/src/pages/docs/reference/common/interfaces/DependencyFactory.md +++ b/src/pages/docs/reference/common/interfaces/DependencyFactory.md @@ -10,7 +10,7 @@ title: DependencyFactory # Interface: DependencyFactory -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L34) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L34) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -34,7 +34,7 @@ deps that are necessary for the sequencer to work. > **dependencies**: () => [`DependencyRecord`](../type-aliases/DependencyRecord.md) -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L35) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L35) #### Returns diff --git a/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md b/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md index ff34064..6367180 100644 --- a/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md +++ b/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md @@ -10,7 +10,7 @@ title: EventEmittingComponent # Interface: EventEmittingComponent\ -Defined in: [packages/common/src/events/EventEmittingComponent.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmittingComponent.ts#L5) +Defined in: [packages/common/src/events/EventEmittingComponent.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmittingComponent.ts#L5) ## Extended by @@ -26,4 +26,4 @@ Defined in: [packages/common/src/events/EventEmittingComponent.ts:5](https://git > **events**: [`EventEmitter`](../classes/EventEmitter.md)\<`Events`\> -Defined in: [packages/common/src/events/EventEmittingComponent.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmittingComponent.ts#L6) +Defined in: [packages/common/src/events/EventEmittingComponent.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmittingComponent.ts#L6) diff --git a/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md b/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md index eccdfac..86f99f9 100644 --- a/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md +++ b/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md @@ -10,7 +10,7 @@ title: EventEmittingContainer # Interface: EventEmittingContainer\ -Defined in: [packages/common/src/events/EventEmittingComponent.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmittingComponent.ts#L9) +Defined in: [packages/common/src/events/EventEmittingComponent.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmittingComponent.ts#L9) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [packages/common/src/events/EventEmittingComponent.ts:9](https://git > **containerEvents**: [`EventEmitter`](../classes/EventEmitter.md)\<`Events`\> -Defined in: [packages/common/src/events/EventEmittingComponent.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmittingComponent.ts#L10) +Defined in: [packages/common/src/events/EventEmittingComponent.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmittingComponent.ts#L10) diff --git a/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md b/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md index 2272515..9df5a97 100644 --- a/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md +++ b/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md @@ -10,7 +10,7 @@ title: MerkleTreeStore # Interface: MerkleTreeStore -Defined in: [packages/common/src/trees/MerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MerkleTreeStore.ts#L1) +Defined in: [packages/common/src/trees/MerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MerkleTreeStore.ts#L1) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/trees/MerkleTreeStore.ts:1](https://github.com/ > **getNode**: (`key`, `level`) => `undefined` \| `bigint` -Defined in: [packages/common/src/trees/MerkleTreeStore.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MerkleTreeStore.ts#L4) +Defined in: [packages/common/src/trees/MerkleTreeStore.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MerkleTreeStore.ts#L4) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/common/src/trees/MerkleTreeStore.ts:4](https://github.com/ > **setNode**: (`key`, `level`, `value`) => `void` -Defined in: [packages/common/src/trees/MerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/trees/MerkleTreeStore.ts#L2) +Defined in: [packages/common/src/trees/MerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MerkleTreeStore.ts#L2) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md b/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md index 9072730..7d325a1 100644 --- a/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md +++ b/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md @@ -10,7 +10,7 @@ title: ModuleContainerDefinition # Interface: ModuleContainerDefinition\ -Defined in: [packages/common/src/config/ModuleContainer.ts:115](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L115) +Defined in: [packages/common/src/config/ModuleContainer.ts:115](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L115) Parameters required when creating a module container instance @@ -24,7 +24,7 @@ Parameters required when creating a module container instance > `optional` **config**: [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:121](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L121) +Defined in: [packages/common/src/config/ModuleContainer.ts:121](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L121) #### Deprecated @@ -34,4 +34,4 @@ Defined in: [packages/common/src/config/ModuleContainer.ts:121](https://github.c > **modules**: `Modules` -Defined in: [packages/common/src/config/ModuleContainer.ts:116](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L116) +Defined in: [packages/common/src/config/ModuleContainer.ts:116](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L116) diff --git a/src/pages/docs/reference/common/interfaces/ModulesRecord.md b/src/pages/docs/reference/common/interfaces/ModulesRecord.md index 6f4a136..1b53685 100644 --- a/src/pages/docs/reference/common/interfaces/ModulesRecord.md +++ b/src/pages/docs/reference/common/interfaces/ModulesRecord.md @@ -10,7 +10,7 @@ title: ModulesRecord # Interface: ModulesRecord\ -Defined in: [packages/common/src/config/ModuleContainer.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L81) +Defined in: [packages/common/src/config/ModuleContainer.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L81) ## Type Parameters diff --git a/src/pages/docs/reference/common/interfaces/PlainZkProgram.md b/src/pages/docs/reference/common/interfaces/PlainZkProgram.md index 5c77368..154cf2e 100644 --- a/src/pages/docs/reference/common/interfaces/PlainZkProgram.md +++ b/src/pages/docs/reference/common/interfaces/PlainZkProgram.md @@ -10,7 +10,7 @@ title: PlainZkProgram # Interface: PlainZkProgram\ -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L36) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L36) ## Type Parameters @@ -24,7 +24,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:36](https://gi > **analyzeMethods**: () => `Promise`\<`Record`\<`string`, \{ `digest`: `string`; `gates`: `Gate`[]; `publicInputSize`: `number`; `rows`: `number`; `print`: `void`; `summary`: `Partial`\<`Record`\<`GateType` \| `"Total rows"`, `number`\>\>; \}\>\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L54) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L54) #### Returns @@ -36,7 +36,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:54](https://gi > **compile**: [`Compile`](Compile.md) -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L38) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L38) *** @@ -44,7 +44,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:38](https://gi > **methods**: `Record`\<`string`, (...`args`) => `Promise`\<`Proof`\<`PublicInput`, `PublicOutput`\>\> \| (`publicInput`, ...`args`) => `Promise`\<`Proof`\<`PublicInput`, `PublicOutput`\>\>\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L46) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L46) *** @@ -52,7 +52,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:46](https://gi > **name**: `string` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L37) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L37) *** @@ -60,7 +60,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:37](https://gi > **Proof**: (`__namedParameters`) => `object` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L40) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L40) #### Parameters @@ -234,4 +234,4 @@ must match your ZkProgram. `maxProofsVerified` is the maximum number of proofs t > **verify**: [`Verify`](Verify.md)\<`PublicInput`, `PublicOutput`\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L39) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L39) diff --git a/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md b/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md index 718692b..de82ab9 100644 --- a/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md +++ b/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md @@ -10,7 +10,7 @@ title: StaticConfigurableModule # Interface: StaticConfigurableModule\ -Defined in: [packages/common/src/config/ConfigurableModule.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L55) +Defined in: [packages/common/src/config/ConfigurableModule.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L55) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [packages/common/src/config/ConfigurableModule.ts:55](https://github > **presets**: [`Presets`](../type-aliases/Presets.md)\<`Config`\> -Defined in: [packages/common/src/config/ConfigurableModule.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L56) +Defined in: [packages/common/src/config/ConfigurableModule.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L56) diff --git a/src/pages/docs/reference/common/interfaces/ToFieldable.md b/src/pages/docs/reference/common/interfaces/ToFieldable.md index 9f442be..969e8a9 100644 --- a/src/pages/docs/reference/common/interfaces/ToFieldable.md +++ b/src/pages/docs/reference/common/interfaces/ToFieldable.md @@ -10,7 +10,7 @@ title: ToFieldable # Interface: ToFieldable -Defined in: [packages/common/src/utils.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L105) +Defined in: [packages/common/src/utils.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L105) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/utils.ts:105](https://github.com/proto-kit/fram > **toFields**: () => `Field`[] -Defined in: [packages/common/src/utils.ts:106](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L106) +Defined in: [packages/common/src/utils.ts:106](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L106) #### Returns diff --git a/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md b/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md index 81c4b8e..45ecb23 100644 --- a/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md +++ b/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md @@ -10,7 +10,7 @@ title: ToFieldableStatic # Interface: ToFieldableStatic -Defined in: [packages/common/src/utils.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L109) +Defined in: [packages/common/src/utils.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L109) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/utils.ts:109](https://github.com/proto-kit/fram > **toFields**: (`value`) => `Field`[] -Defined in: [packages/common/src/utils.ts:110](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L110) +Defined in: [packages/common/src/utils.ts:110](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L110) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md b/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md index f47addd..9bd0372 100644 --- a/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md +++ b/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md @@ -10,7 +10,7 @@ title: ToJSONableStatic # Interface: ToJSONableStatic -Defined in: [packages/common/src/utils.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L113) +Defined in: [packages/common/src/utils.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L113) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/common/src/utils.ts:113](https://github.com/proto-kit/fram > **toJSON**: (`value`) => `any` -Defined in: [packages/common/src/utils.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L114) +Defined in: [packages/common/src/utils.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L114) #### Parameters diff --git a/src/pages/docs/reference/common/interfaces/Verify.md b/src/pages/docs/reference/common/interfaces/Verify.md index f312f88..a7426bf 100644 --- a/src/pages/docs/reference/common/interfaces/Verify.md +++ b/src/pages/docs/reference/common/interfaces/Verify.md @@ -10,7 +10,7 @@ title: Verify # Interface: Verify()\ -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L28) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L28) ## Type Parameters @@ -20,7 +20,7 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:28](https://gi > **Verify**(`proof`): `Promise`\<`boolean`\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L29) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L29) ## Parameters diff --git a/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md b/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md index 4bcafe7..bd04531 100644 --- a/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md +++ b/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md @@ -10,7 +10,7 @@ title: WithZkProgrammable # Interface: WithZkProgrammable\ -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:146](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L146) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:146](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L146) ## Extended by @@ -30,4 +30,4 @@ Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:146](https://g > **zkProgrammable**: [`ZkProgrammable`](../classes/ZkProgrammable.md)\<`PublicInput`, `PublicOutput`\> -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:150](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L150) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:150](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L150) diff --git a/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md b/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md index 4473998..3a1e06b 100644 --- a/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md +++ b/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md @@ -12,4 +12,4 @@ title: ArgumentTypes > **ArgumentTypes**: ([`O1JSPrimitive`](O1JSPrimitive.md) \| `Proof`\<`unknown`, `unknown`\> \| `DynamicProof`\<`unknown`, `unknown`\>)[] -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L9) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L9) diff --git a/src/pages/docs/reference/common/type-aliases/ArrayElement.md b/src/pages/docs/reference/common/type-aliases/ArrayElement.md index 22b7726..d92b1a5 100644 --- a/src/pages/docs/reference/common/type-aliases/ArrayElement.md +++ b/src/pages/docs/reference/common/type-aliases/ArrayElement.md @@ -12,7 +12,7 @@ title: ArrayElement > **ArrayElement**\<`ArrayType`\>: `ArrayType` *extends* readonly infer ElementType[] ? `ElementType` : `never` -Defined in: [packages/common/src/types.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L18) +Defined in: [packages/common/src/types.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L18) Utility type to infer element type from an array type diff --git a/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md b/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md index 363b552..f366ad1 100644 --- a/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md +++ b/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md @@ -12,4 +12,4 @@ title: ArtifactRecord > **ArtifactRecord**: `Record`\<`string`, [`CompileArtifact`](../interfaces/CompileArtifact.md)\> -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/AtomicCompileHelper.ts#L10) +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/AtomicCompileHelper.ts#L10) diff --git a/src/pages/docs/reference/common/type-aliases/BaseModuleType.md b/src/pages/docs/reference/common/type-aliases/BaseModuleType.md index 4389249..85b0e1b 100644 --- a/src/pages/docs/reference/common/type-aliases/BaseModuleType.md +++ b/src/pages/docs/reference/common/type-aliases/BaseModuleType.md @@ -12,4 +12,4 @@ title: BaseModuleType > **BaseModuleType**: [`TypedClass`](TypedClass.md)\<[`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md)\> -Defined in: [packages/common/src/config/ModuleContainer.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L78) +Defined in: [packages/common/src/config/ModuleContainer.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L78) diff --git a/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md b/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md index d24d635..c29bca9 100644 --- a/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md +++ b/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md @@ -12,7 +12,7 @@ title: CapitalizeAny > **CapitalizeAny**\<`Key`\>: `Key` *extends* `string` ? `Capitalize`\<`Key`\> : `Key` -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L45) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L45) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md b/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md index 602814f..107f650 100644 --- a/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md +++ b/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md @@ -12,7 +12,7 @@ title: CastToEventsRecord > **CastToEventsRecord**\<`Record`\>: `Record` *extends* [`EventsRecord`](EventsRecord.md) ? `Record` : `object` -Defined in: [packages/common/src/events/EventEmitterProxy.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L15) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L15) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/CompileTarget.md b/src/pages/docs/reference/common/type-aliases/CompileTarget.md index 3da3a67..8c6fffc 100644 --- a/src/pages/docs/reference/common/type-aliases/CompileTarget.md +++ b/src/pages/docs/reference/common/type-aliases/CompileTarget.md @@ -12,7 +12,7 @@ title: CompileTarget > **CompileTarget**: `object` -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/compiling/AtomicCompileHelper.ts#L12) +Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/AtomicCompileHelper.ts#L12) ## Type declaration diff --git a/src/pages/docs/reference/common/type-aliases/ContainerEvents.md b/src/pages/docs/reference/common/type-aliases/ContainerEvents.md index 60d6843..adc977a 100644 --- a/src/pages/docs/reference/common/type-aliases/ContainerEvents.md +++ b/src/pages/docs/reference/common/type-aliases/ContainerEvents.md @@ -12,7 +12,7 @@ title: ContainerEvents > **ContainerEvents**\<`Modules`\>: `{ [Key in StringKeyOf]: ModuleEvents }` -Defined in: [packages/common/src/events/EventEmitterProxy.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L32) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L32) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md b/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md index e7d3374..da41624 100644 --- a/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md +++ b/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md @@ -12,7 +12,7 @@ title: DecoratedMethod > **DecoratedMethod**: (...`args`) => `Promise`\<`unknown`\> -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L15) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L15) ## Parameters diff --git a/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md b/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md index 6556377..4aff5c2 100644 --- a/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md +++ b/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md @@ -12,7 +12,7 @@ title: DependenciesFromModules > **DependenciesFromModules**\<`Modules`\>: [`FilterNeverValues`](FilterNeverValues.md)\<`{ [Key in keyof Modules]: Modules[Key] extends TypedClass ? InferDependencies> : never }`\> -Defined in: [packages/common/src/config/ModuleContainer.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L129) +Defined in: [packages/common/src/config/ModuleContainer.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L129) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md b/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md index 0e50601..575b402 100644 --- a/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md +++ b/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md @@ -12,7 +12,7 @@ title: DependencyDeclaration > **DependencyDeclaration**\<`Dependency`\>: `ClassProvider`\<`Dependency`\> \| `FactoryProvider`\<`Dependency`\> \| `TokenProvider`\<`Dependency`\> \| `ValueProvider`\<`Dependency`\> -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L11) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L11) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/DependencyRecord.md b/src/pages/docs/reference/common/type-aliases/DependencyRecord.md index fa84fea..4491936 100644 --- a/src/pages/docs/reference/common/type-aliases/DependencyRecord.md +++ b/src/pages/docs/reference/common/type-aliases/DependencyRecord.md @@ -12,4 +12,4 @@ title: DependencyRecord > **DependencyRecord**: `Record`\<`string`, [`DependencyDeclaration`](DependencyDeclaration.md)\<`unknown`\> & `object`\> -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L17) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L17) diff --git a/src/pages/docs/reference/common/type-aliases/EventListenable.md b/src/pages/docs/reference/common/type-aliases/EventListenable.md index 0eb7889..e1e80ce 100644 --- a/src/pages/docs/reference/common/type-aliases/EventListenable.md +++ b/src/pages/docs/reference/common/type-aliases/EventListenable.md @@ -12,7 +12,7 @@ title: EventListenable > **EventListenable**\<`Events`\>: `Pick`\<[`EventEmitter`](../classes/EventEmitter.md)\<`Events`\>, `"on"` \| `"onAll"` \| `"off"`\> -Defined in: [packages/common/src/events/EventEmitter.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitter.ts#L58) +Defined in: [packages/common/src/events/EventEmitter.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L58) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/EventsRecord.md b/src/pages/docs/reference/common/type-aliases/EventsRecord.md index 46bd682..1493ed2 100644 --- a/src/pages/docs/reference/common/type-aliases/EventsRecord.md +++ b/src/pages/docs/reference/common/type-aliases/EventsRecord.md @@ -12,4 +12,4 @@ title: EventsRecord > **EventsRecord**: `Record`\<`string`, `unknown`[]\> -Defined in: [packages/common/src/events/EventEmittingComponent.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmittingComponent.ts#L3) +Defined in: [packages/common/src/events/EventEmittingComponent.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmittingComponent.ts#L3) diff --git a/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md b/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md index c60e388..5465185 100644 --- a/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md +++ b/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md @@ -12,7 +12,7 @@ title: FilterNeverValues > **FilterNeverValues**\<`Type`\>: `{ [Key in keyof Type as Type[Key] extends never ? never : Key]: Type[Key] }` -Defined in: [packages/common/src/config/ModuleContainer.ts:125](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L125) +Defined in: [packages/common/src/config/ModuleContainer.ts:125](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L125) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/FlattenObject.md b/src/pages/docs/reference/common/type-aliases/FlattenObject.md index 3e69548..79bb820 100644 --- a/src/pages/docs/reference/common/type-aliases/FlattenObject.md +++ b/src/pages/docs/reference/common/type-aliases/FlattenObject.md @@ -12,7 +12,7 @@ title: FlattenObject > **FlattenObject**\<`Target`\>: [`UnionToIntersection`](UnionToIntersection.md)\<`Target`\[keyof `Target`\]\> -Defined in: [packages/common/src/events/EventEmitterProxy.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L36) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L36) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md b/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md index dcf3a98..8c74b24 100644 --- a/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md +++ b/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md @@ -12,7 +12,7 @@ title: FlattenedContainerEvents > **FlattenedContainerEvents**\<`Modules`\>: [`FlattenObject`](FlattenObject.md)\<[`ContainerEvents`](ContainerEvents.md)\<`Modules`\>\> -Defined in: [packages/common/src/events/EventEmitterProxy.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L39) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L39) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/InferDependencies.md b/src/pages/docs/reference/common/type-aliases/InferDependencies.md index 22b3b26..489da77 100644 --- a/src/pages/docs/reference/common/type-aliases/InferDependencies.md +++ b/src/pages/docs/reference/common/type-aliases/InferDependencies.md @@ -12,7 +12,7 @@ title: InferDependencies > **InferDependencies**\<`Class`\>: `Class` *extends* [`DependencyFactory`](../interfaces/DependencyFactory.md) ? [`MapDependencyRecordToTypes`](MapDependencyRecordToTypes.md)\<`ReturnType`\<`Class`\[`"dependencies"`\]\>\> : `never` -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L54) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L54) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/InferProofBase.md b/src/pages/docs/reference/common/type-aliases/InferProofBase.md index 178ea69..76e0342 100644 --- a/src/pages/docs/reference/common/type-aliases/InferProofBase.md +++ b/src/pages/docs/reference/common/type-aliases/InferProofBase.md @@ -12,7 +12,7 @@ title: InferProofBase > **InferProofBase**\<`ProofType`\>: `ProofType` *extends* `Proof`\ ? `ProofBase`\<`PI`, `PO`\> : `ProofType` *extends* `DynamicProof`\ ? `ProofBase`\<`PI`, `PO`\> : `undefined` -Defined in: [packages/common/src/types.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L51) +Defined in: [packages/common/src/types.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L51) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md b/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md index 757f4d7..29a0634 100644 --- a/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md +++ b/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md @@ -12,7 +12,7 @@ title: MapDependencyRecordToTypes > **MapDependencyRecordToTypes**\<`Record`\>: `{ [Key in keyof Record as CapitalizeAny]: TypedClass> }` -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L48) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L48) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/MergeObjects.md b/src/pages/docs/reference/common/type-aliases/MergeObjects.md index e04ece1..b3161b6 100644 --- a/src/pages/docs/reference/common/type-aliases/MergeObjects.md +++ b/src/pages/docs/reference/common/type-aliases/MergeObjects.md @@ -12,7 +12,7 @@ title: MergeObjects > **MergeObjects**\<`Input`\>: [`UnionToIntersection`](UnionToIntersection.md)\<`Input`\[keyof `Input`\]\> -Defined in: [packages/common/src/types.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L30) +Defined in: [packages/common/src/types.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L30) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/ModuleEvents.md b/src/pages/docs/reference/common/type-aliases/ModuleEvents.md index ea63f4d..098cb72 100644 --- a/src/pages/docs/reference/common/type-aliases/ModuleEvents.md +++ b/src/pages/docs/reference/common/type-aliases/ModuleEvents.md @@ -12,7 +12,7 @@ title: ModuleEvents > **ModuleEvents**\<`ModuleType`\>: `InstanceType`\<`ModuleType`\> *extends* [`EventEmittingComponent`](../interfaces/EventEmittingComponent.md)\ ? `Events` : `InstanceType`\<`ModuleType`\> *extends* [`ModuleContainer`](../classes/ModuleContainer.md)\ ? [`CastToEventsRecord`](CastToEventsRecord.md)\<[`ContainerEvents`](ContainerEvents.md)\<`NestedModules`\>\> : [`EventsRecord`](EventsRecord.md) -Defined in: [packages/common/src/events/EventEmitterProxy.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/events/EventEmitterProxy.ts#L19) +Defined in: [packages/common/src/events/EventEmitterProxy.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L19) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/ModulesConfig.md b/src/pages/docs/reference/common/type-aliases/ModulesConfig.md index 9e50e44..60268b3 100644 --- a/src/pages/docs/reference/common/type-aliases/ModulesConfig.md +++ b/src/pages/docs/reference/common/type-aliases/ModulesConfig.md @@ -12,7 +12,7 @@ title: ModulesConfig > **ModulesConfig**\<`Modules`\>: \{ \[ConfigKey in StringKeyOf\\]: InstanceType\ extends Configurable\ ? Config extends NoConfig ? Config \| undefined : Config : never \} -Defined in: [packages/common/src/config/ModuleContainer.ts:89](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L89) +Defined in: [packages/common/src/config/ModuleContainer.ts:89](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L89) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/NoConfig.md b/src/pages/docs/reference/common/type-aliases/NoConfig.md index ca91c5a..8fe0393 100644 --- a/src/pages/docs/reference/common/type-aliases/NoConfig.md +++ b/src/pages/docs/reference/common/type-aliases/NoConfig.md @@ -12,4 +12,4 @@ title: NoConfig > **NoConfig**: `Record`\<`never`, `never`\> -Defined in: [packages/common/src/config/ConfigurableModule.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L22) +Defined in: [packages/common/src/config/ConfigurableModule.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L22) diff --git a/src/pages/docs/reference/common/type-aliases/NonMethods.md b/src/pages/docs/reference/common/type-aliases/NonMethods.md index cc3e15f..ddd6ae9 100644 --- a/src/pages/docs/reference/common/type-aliases/NonMethods.md +++ b/src/pages/docs/reference/common/type-aliases/NonMethods.md @@ -12,7 +12,7 @@ title: NonMethods > **NonMethods**\<`Type`\>: `Pick`\<`Type`, `NonMethodKeys`\<`Type`\>\> -Defined in: [packages/common/src/utils.ts:172](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L172) +Defined in: [packages/common/src/utils.ts:172](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L172) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md b/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md index 68b716b..a592eee 100644 --- a/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md +++ b/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md @@ -12,4 +12,4 @@ title: O1JSPrimitive > **O1JSPrimitive**: `object` \| `string` \| `boolean` \| `number` -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L8) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L8) diff --git a/src/pages/docs/reference/common/type-aliases/OmitKeys.md b/src/pages/docs/reference/common/type-aliases/OmitKeys.md index 3769dfe..fa11db3 100644 --- a/src/pages/docs/reference/common/type-aliases/OmitKeys.md +++ b/src/pages/docs/reference/common/type-aliases/OmitKeys.md @@ -12,7 +12,7 @@ title: OmitKeys > **OmitKeys**\<`Record`, `Keys`\>: `{ [Key in keyof Record as Key extends Keys ? never : Key]: Record[Key] }` -Defined in: [packages/common/src/types.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L33) +Defined in: [packages/common/src/types.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L33) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md b/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md index 7efb4f6..812115c 100644 --- a/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md +++ b/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md @@ -12,7 +12,7 @@ title: OverwriteObjectType > **OverwriteObjectType**\<`Base`, `New`\>: `{ [Key in keyof Base]: Key extends keyof New ? New[Key] : Base[Key] }` & `New` -Defined in: [packages/common/src/types.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L47) +Defined in: [packages/common/src/types.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L47) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/Preset.md b/src/pages/docs/reference/common/type-aliases/Preset.md index d63cddb..3f7f83e 100644 --- a/src/pages/docs/reference/common/type-aliases/Preset.md +++ b/src/pages/docs/reference/common/type-aliases/Preset.md @@ -12,7 +12,7 @@ title: Preset > **Preset**\<`Config`\>: `Config` \| (...`args`) => `Config` -Defined in: [packages/common/src/config/ConfigurableModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L14) +Defined in: [packages/common/src/config/ConfigurableModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L14) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/Presets.md b/src/pages/docs/reference/common/type-aliases/Presets.md index 5c97b3a..ac68130 100644 --- a/src/pages/docs/reference/common/type-aliases/Presets.md +++ b/src/pages/docs/reference/common/type-aliases/Presets.md @@ -12,7 +12,7 @@ title: Presets > **Presets**\<`Config`\>: `Record`\<`string`, [`Preset`](Preset.md)\<`Config`\>\> -Defined in: [packages/common/src/config/ConfigurableModule.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ConfigurableModule.ts#L15) +Defined in: [packages/common/src/config/ConfigurableModule.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L15) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/ProofTypes.md b/src/pages/docs/reference/common/type-aliases/ProofTypes.md index b4fc4d9..f4d6bd0 100644 --- a/src/pages/docs/reference/common/type-aliases/ProofTypes.md +++ b/src/pages/docs/reference/common/type-aliases/ProofTypes.md @@ -12,4 +12,4 @@ title: ProofTypes > **ProofTypes**: *typeof* `Proof` \| *typeof* `DynamicProof` -Defined in: [packages/common/src/utils.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L122) +Defined in: [packages/common/src/utils.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L122) diff --git a/src/pages/docs/reference/common/type-aliases/RecursivePartial.md b/src/pages/docs/reference/common/type-aliases/RecursivePartial.md index 1ec4988..bf100e9 100644 --- a/src/pages/docs/reference/common/type-aliases/RecursivePartial.md +++ b/src/pages/docs/reference/common/type-aliases/RecursivePartial.md @@ -12,7 +12,7 @@ title: RecursivePartial > **RecursivePartial**\<`T`\>: `{ [Key in keyof T]?: Partial }` -Defined in: [packages/common/src/config/ModuleContainer.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L108) +Defined in: [packages/common/src/config/ModuleContainer.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L108) This type make any config partial (i.e. optional) up to the first level So { Module: { a: { b: string } } } diff --git a/src/pages/docs/reference/common/type-aliases/ResolvableModules.md b/src/pages/docs/reference/common/type-aliases/ResolvableModules.md index 640ffb9..78f44a6 100644 --- a/src/pages/docs/reference/common/type-aliases/ResolvableModules.md +++ b/src/pages/docs/reference/common/type-aliases/ResolvableModules.md @@ -12,7 +12,7 @@ title: ResolvableModules > **ResolvableModules**\<`Modules`\>: [`MergeObjects`](MergeObjects.md)\<[`DependenciesFromModules`](DependenciesFromModules.md)\<`Modules`\>\> & `Modules` -Defined in: [packages/common/src/config/ModuleContainer.ts:136](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L136) +Defined in: [packages/common/src/config/ModuleContainer.ts:136](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L136) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/StringKeyOf.md b/src/pages/docs/reference/common/type-aliases/StringKeyOf.md index 3b6b6cf..2c8c72f 100644 --- a/src/pages/docs/reference/common/type-aliases/StringKeyOf.md +++ b/src/pages/docs/reference/common/type-aliases/StringKeyOf.md @@ -12,7 +12,7 @@ title: StringKeyOf > **StringKeyOf**\<`Target`\>: `Extract`\ & `string` -Defined in: [packages/common/src/types.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L12) +Defined in: [packages/common/src/types.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L12) Using simple `keyof Target` would result into the key being `string | number | symbol`, but we want just a `string` diff --git a/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md b/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md index 0f88c4c..137d2eb 100644 --- a/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md +++ b/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md @@ -12,7 +12,7 @@ title: TypeFromDependencyDeclaration > **TypeFromDependencyDeclaration**\<`Declaration`\>: `Declaration` *extends* [`DependencyDeclaration`](DependencyDeclaration.md)\ ? `Dependency` : `never` -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/dependencyFactory/DependencyFactory.ts#L38) +Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L38) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/TypedClass.md b/src/pages/docs/reference/common/type-aliases/TypedClass.md index 5e746f9..d3b6cf3 100644 --- a/src/pages/docs/reference/common/type-aliases/TypedClass.md +++ b/src/pages/docs/reference/common/type-aliases/TypedClass.md @@ -12,7 +12,7 @@ title: TypedClass > **TypedClass**\<`Class`\>: (...`args`) => `Class` -Defined in: [packages/common/src/types.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L4) +Defined in: [packages/common/src/types.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L4) ## Type Parameters diff --git a/src/pages/docs/reference/common/type-aliases/UnTypedClass.md b/src/pages/docs/reference/common/type-aliases/UnTypedClass.md index ee7e664..c249369 100644 --- a/src/pages/docs/reference/common/type-aliases/UnTypedClass.md +++ b/src/pages/docs/reference/common/type-aliases/UnTypedClass.md @@ -12,7 +12,7 @@ title: UnTypedClass > **UnTypedClass**: (...`args`) => `unknown` -Defined in: [packages/common/src/types.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L6) +Defined in: [packages/common/src/types.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L6) ## Parameters diff --git a/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md b/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md index f00ab64..ffa13c4 100644 --- a/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md +++ b/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md @@ -12,7 +12,7 @@ title: UnionToIntersection > **UnionToIntersection**\<`Union`\>: `Union` *extends* `any` ? (`x`) => `void` : `never` *extends* (`x`) => `void` ? `Intersection` : `never` -Defined in: [packages/common/src/types.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L24) +Defined in: [packages/common/src/types.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L24) Transforms X | Y => X & Y diff --git a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md index f918c17..f5bb8c2 100644 --- a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md +++ b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md @@ -12,4 +12,4 @@ title: EMPTY_PUBLICKEY > `const` **EMPTY\_PUBLICKEY**: `PublicKey` -Defined in: [packages/common/src/types.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L42) +Defined in: [packages/common/src/types.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L42) diff --git a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md index 465563f..5e4116d 100644 --- a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md +++ b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md @@ -12,4 +12,4 @@ title: EMPTY_PUBLICKEY_X > `const` **EMPTY\_PUBLICKEY\_X**: `Field` -Defined in: [packages/common/src/types.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/types.ts#L41) +Defined in: [packages/common/src/types.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L41) diff --git a/src/pages/docs/reference/common/variables/MAX_FIELD.md b/src/pages/docs/reference/common/variables/MAX_FIELD.md index bf52ad0..f9bd76b 100644 --- a/src/pages/docs/reference/common/variables/MAX_FIELD.md +++ b/src/pages/docs/reference/common/variables/MAX_FIELD.md @@ -12,4 +12,4 @@ title: MAX_FIELD > `const` **MAX\_FIELD**: `Field` -Defined in: [packages/common/src/utils.ts:174](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/utils.ts#L174) +Defined in: [packages/common/src/utils.ts:174](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L174) diff --git a/src/pages/docs/reference/common/variables/MOCK_PROOF.md b/src/pages/docs/reference/common/variables/MOCK_PROOF.md index f156cf5..8031810 100644 --- a/src/pages/docs/reference/common/variables/MOCK_PROOF.md +++ b/src/pages/docs/reference/common/variables/MOCK_PROOF.md @@ -12,4 +12,4 @@ title: MOCK_PROOF > `const` **MOCK\_PROOF**: `"mock-proof"` = `"mock-proof"` -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/provableMethod.ts#L17) +Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L17) diff --git a/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md b/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md index 2e16fcf..c760760 100644 --- a/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md +++ b/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md @@ -12,4 +12,4 @@ title: MOCK_VERIFICATION_KEY > `const` **MOCK\_VERIFICATION\_KEY**: `VerificationKey` -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/zkProgrammable/ZkProgrammable.ts#L82) +Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L82) diff --git a/src/pages/docs/reference/common/variables/ModuleContainerErrors.md b/src/pages/docs/reference/common/variables/ModuleContainerErrors.md index 42f465b..1195835 100644 --- a/src/pages/docs/reference/common/variables/ModuleContainerErrors.md +++ b/src/pages/docs/reference/common/variables/ModuleContainerErrors.md @@ -12,7 +12,7 @@ title: ModuleContainerErrors > `const` **ModuleContainerErrors**: `object` = `errors` -Defined in: [packages/common/src/config/ModuleContainer.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/ModuleContainer.ts#L71) +Defined in: [packages/common/src/config/ModuleContainer.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L71) ## Type declaration diff --git a/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md b/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md index 891c4c7..6ae233f 100644 --- a/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md +++ b/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md @@ -12,4 +12,4 @@ title: injectAliasMetadataKey > `const` **injectAliasMetadataKey**: `"protokit-inject-alias"` = `"protokit-inject-alias"` -Defined in: [packages/common/src/config/injectAlias.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/config/injectAlias.ts#L3) +Defined in: [packages/common/src/config/injectAlias.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/injectAlias.ts#L3) diff --git a/src/pages/docs/reference/common/variables/log.md b/src/pages/docs/reference/common/variables/log.md index b65ae40..724b6db 100644 --- a/src/pages/docs/reference/common/variables/log.md +++ b/src/pages/docs/reference/common/variables/log.md @@ -12,7 +12,7 @@ title: log > `const` **log**: `object` -Defined in: [packages/common/src/log.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/common/src/log.ts#L53) +Defined in: [packages/common/src/log.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/log.ts#L53) ## Type declaration diff --git a/src/pages/docs/reference/deployment/classes/BullQueue.md b/src/pages/docs/reference/deployment/classes/BullQueue.md index 6bd6b83..611935a 100644 --- a/src/pages/docs/reference/deployment/classes/BullQueue.md +++ b/src/pages/docs/reference/deployment/classes/BullQueue.md @@ -10,7 +10,7 @@ title: BullQueue # Class: BullQueue -Defined in: [deployment/src/queue/BullQueue.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L29) +Defined in: [deployment/src/queue/BullQueue.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L29) TaskQueue implementation for BullMQ @@ -116,7 +116,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **close**(): `Promise`\<`void`\> -Defined in: [deployment/src/queue/BullQueue.ts:107](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L107) +Defined in: [deployment/src/queue/BullQueue.ts:107](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L107) #### Returns @@ -196,7 +196,7 @@ Defined in: sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:5 > **createWorker**(`name`, `executor`, `options`?): [`Closeable`](../../sequencer/interfaces/Closeable.md) -Defined in: [deployment/src/queue/BullQueue.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L35) +Defined in: [deployment/src/queue/BullQueue.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L35) #### Parameters @@ -228,7 +228,7 @@ Defined in: [deployment/src/queue/BullQueue.ts:35](https://github.com/proto-kit/ > **getQueue**(`queueName`): `Promise`\<[`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md)\> -Defined in: [deployment/src/queue/BullQueue.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L88) +Defined in: [deployment/src/queue/BullQueue.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L88) #### Parameters @@ -250,7 +250,7 @@ Defined in: [deployment/src/queue/BullQueue.ts:88](https://github.com/proto-kit/ > **start**(): `Promise`\<`void`\> -Defined in: [deployment/src/queue/BullQueue.ts:103](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L103) +Defined in: [deployment/src/queue/BullQueue.ts:103](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L103) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/deployment/classes/Environment.md b/src/pages/docs/reference/deployment/classes/Environment.md index ca322a0..5a5748f 100644 --- a/src/pages/docs/reference/deployment/classes/Environment.md +++ b/src/pages/docs/reference/deployment/classes/Environment.md @@ -10,7 +10,7 @@ title: Environment # Class: Environment\ -Defined in: [deployment/src/environment/Environment.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L12) +Defined in: [deployment/src/environment/Environment.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L12) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [deployment/src/environment/Environment.ts:12](https://github.com/pr > **new Environment**\<`T`\>(`configurations`): [`Environment`](Environment.md)\<`T`\> -Defined in: [deployment/src/environment/Environment.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L13) +Defined in: [deployment/src/environment/Environment.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L13) #### Parameters @@ -40,7 +40,7 @@ Defined in: [deployment/src/environment/Environment.ts:13](https://github.com/pr > **getConfiguration**(`configurationName`): `T` -Defined in: [deployment/src/environment/Environment.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L31) +Defined in: [deployment/src/environment/Environment.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L31) #### Parameters @@ -58,7 +58,7 @@ Defined in: [deployment/src/environment/Environment.ts:31](https://github.com/pr > **hasConfiguration**(`configurationName`): `configurationName is string` -Defined in: [deployment/src/environment/Environment.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L17) +Defined in: [deployment/src/environment/Environment.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L17) #### Parameters @@ -76,7 +76,7 @@ Defined in: [deployment/src/environment/Environment.ts:17](https://github.com/pr > **start**(): `Promise`\<`void`\> -Defined in: [deployment/src/environment/Environment.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L42) +Defined in: [deployment/src/environment/Environment.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L42) #### Returns @@ -88,7 +88,7 @@ Defined in: [deployment/src/environment/Environment.ts:42](https://github.com/pr > `static` **from**\<`T`\>(`configurations`): [`Environment`](Environment.md)\<`T`\> -Defined in: [deployment/src/environment/Environment.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L36) +Defined in: [deployment/src/environment/Environment.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L36) #### Type Parameters diff --git a/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md b/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md index dd5e7d6..5c5d63e 100644 --- a/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md +++ b/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md @@ -10,7 +10,7 @@ title: BullQueueConfig # Interface: BullQueueConfig -Defined in: [deployment/src/queue/BullQueue.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L14) +Defined in: [deployment/src/queue/BullQueue.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L14) ## Properties @@ -18,7 +18,7 @@ Defined in: [deployment/src/queue/BullQueue.ts:14](https://github.com/proto-kit/ > **redis**: `object` -Defined in: [deployment/src/queue/BullQueue.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L15) +Defined in: [deployment/src/queue/BullQueue.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L15) #### db? @@ -46,4 +46,4 @@ Defined in: [deployment/src/queue/BullQueue.ts:15](https://github.com/proto-kit/ > `optional` **retryAttempts**: `number` -Defined in: [deployment/src/queue/BullQueue.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/queue/BullQueue.ts#L22) +Defined in: [deployment/src/queue/BullQueue.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L22) diff --git a/src/pages/docs/reference/deployment/interfaces/Startable.md b/src/pages/docs/reference/deployment/interfaces/Startable.md index 167638e..cbbb590 100644 --- a/src/pages/docs/reference/deployment/interfaces/Startable.md +++ b/src/pages/docs/reference/deployment/interfaces/Startable.md @@ -10,7 +10,7 @@ title: Startable # Interface: Startable -Defined in: [deployment/src/environment/Environment.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L6) +Defined in: [deployment/src/environment/Environment.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L6) ## Methods @@ -18,7 +18,7 @@ Defined in: [deployment/src/environment/Environment.ts:6](https://github.com/pro > **start**(): `Promise`\<`void`\> -Defined in: [deployment/src/environment/Environment.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L7) +Defined in: [deployment/src/environment/Environment.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L7) #### Returns diff --git a/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md b/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md index 7246ae9..a232406 100644 --- a/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md +++ b/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md @@ -12,7 +12,7 @@ title: StartableEnvironment > **StartableEnvironment**\<`T`\>: `Record`\<`string`, `T`\> -Defined in: [deployment/src/environment/Environment.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/deployment/src/environment/Environment.ts#L10) +Defined in: [deployment/src/environment/Environment.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L10) ## Type Parameters diff --git a/src/pages/docs/reference/indexer/_meta.tsx b/src/pages/docs/reference/indexer/_meta.tsx index b6944c5..a31554d 100644 --- a/src/pages/docs/reference/indexer/_meta.tsx +++ b/src/pages/docs/reference/indexer/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases" + "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" }; \ No newline at end of file diff --git a/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md b/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md index bd1add4..cc065da 100644 --- a/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md +++ b/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md @@ -10,7 +10,7 @@ title: GeneratedResolverFactoryGraphqlModule # Class: GeneratedResolverFactoryGraphqlModule -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L83) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L83) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new GeneratedResolverFactoryGraphqlModule**(`graphqlServer`): [`GeneratedResolverFactoryGraphqlModule`](GeneratedResolverFactoryGraphqlModule.md) -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L84) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L84) #### Parameters @@ -61,7 +61,7 @@ checks when retrieving it via the getter > **graphqlServer**: [`GraphqlServer`](../../api/classes/GraphqlServer.md) -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L85) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L85) ## Accessors @@ -125,7 +125,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **initializePrismaClient**(): `Promise`\<`PrismaClient`\<`never`\>\> -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:90](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L90) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:90](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L90) #### Returns @@ -137,7 +137,7 @@ Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:90](https: > **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:101](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L101) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:101](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L101) #### Returns diff --git a/src/pages/docs/reference/indexer/classes/IndexBlockTask.md b/src/pages/docs/reference/indexer/classes/IndexBlockTask.md index b40517f..c525006 100644 --- a/src/pages/docs/reference/indexer/classes/IndexBlockTask.md +++ b/src/pages/docs/reference/indexer/classes/IndexBlockTask.md @@ -10,7 +10,7 @@ title: IndexBlockTask # Class: IndexBlockTask -Defined in: [indexer/src/tasks/IndexBlockTask.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L16) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L16) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new IndexBlockTask**(`taskSerializer`, `blockStorage`): [`IndexBlockTask`](IndexBlockTask.md) -Defined in: [indexer/src/tasks/IndexBlockTask.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L22) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L22) #### Parameters @@ -54,7 +54,7 @@ Defined in: [indexer/src/tasks/IndexBlockTask.ts:22](https://github.com/proto-ki > **blockStorage**: [`BlockQueue`](../../sequencer/interfaces/BlockQueue.md) -Defined in: [indexer/src/tasks/IndexBlockTask.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L25) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L25) *** @@ -77,7 +77,7 @@ checks when retrieving it via the getter > **name**: `string` = `"index-block"` -Defined in: [indexer/src/tasks/IndexBlockTask.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L20) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L20) #### Implementation of @@ -89,7 +89,7 @@ Defined in: [indexer/src/tasks/IndexBlockTask.ts:20](https://github.com/proto-ki > **taskSerializer**: [`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) -Defined in: [indexer/src/tasks/IndexBlockTask.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L23) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L23) ## Accessors @@ -131,7 +131,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<`void`\> -Defined in: [indexer/src/tasks/IndexBlockTask.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L33) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L33) #### Parameters @@ -175,7 +175,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md)\> -Defined in: [indexer/src/tasks/IndexBlockTask.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L45) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L45) #### Returns @@ -191,7 +191,7 @@ Defined in: [indexer/src/tasks/IndexBlockTask.ts:45](https://github.com/proto-ki > **prepare**(): `Promise`\<`void`\> -Defined in: [indexer/src/tasks/IndexBlockTask.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L31) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L31) #### Returns @@ -207,7 +207,7 @@ Defined in: [indexer/src/tasks/IndexBlockTask.ts:31](https://github.com/proto-ki > **resultSerializer**(): [`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<`void`\> -Defined in: [indexer/src/tasks/IndexBlockTask.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTask.ts#L49) +Defined in: [indexer/src/tasks/IndexBlockTask.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L49) #### Returns diff --git a/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md b/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md index e4aea8b..63d9b29 100644 --- a/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md +++ b/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md @@ -10,7 +10,7 @@ title: IndexBlockTaskParametersSerializer # Class: IndexBlockTaskParametersSerializer -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L12) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L12) ## Constructors @@ -18,7 +18,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:12](https://github.co > **new IndexBlockTaskParametersSerializer**(`blockMapper`, `blockResultMapper`, `transactionResultMapper`): [`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L13) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L13) #### Parameters @@ -44,7 +44,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:13](https://github.co > **blockMapper**: [`BlockMapper`](../../persistance/classes/BlockMapper.md) -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L14) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L14) *** @@ -52,7 +52,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:14](https://github.co > **blockResultMapper**: [`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L15) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L15) *** @@ -60,7 +60,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:15](https://github.co > **transactionResultMapper**: [`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L16) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L16) ## Methods @@ -68,7 +68,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:16](https://github.co > **fromJSON**(`json`): [`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md) -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L29) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L29) #### Parameters @@ -86,7 +86,7 @@ Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:29](https://github.co > **toJSON**(`parameters`): `string` -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L19) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L19) #### Parameters diff --git a/src/pages/docs/reference/indexer/classes/Indexer.md b/src/pages/docs/reference/indexer/classes/Indexer.md index 966217a..3d8f814 100644 --- a/src/pages/docs/reference/indexer/classes/Indexer.md +++ b/src/pages/docs/reference/indexer/classes/Indexer.md @@ -10,7 +10,7 @@ title: Indexer # Class: Indexer\ -Defined in: [indexer/src/Indexer.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/Indexer.ts#L15) +Defined in: [indexer/src/Indexer.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/Indexer.ts#L15) Reusable module container facilitating registration, resolution configuration, decoration and validation of modules @@ -170,7 +170,7 @@ list of module names > **get** **taskQueue**(): `InstanceType`\<`Modules`\[`"TaskQueue"`\]\> -Defined in: [indexer/src/Indexer.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/Indexer.ts#L24) +Defined in: [indexer/src/Indexer.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/Indexer.ts#L24) ##### Returns @@ -574,7 +574,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [indexer/src/Indexer.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/Indexer.ts#L28) +Defined in: [indexer/src/Indexer.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/Indexer.ts#L28) #### Returns @@ -615,7 +615,7 @@ such as only injecting other known modules. > `static` **from**\<`Modules`\>(`definition`): [`Indexer`](Indexer.md)\<`Modules`\> -Defined in: [indexer/src/Indexer.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/Indexer.ts#L18) +Defined in: [indexer/src/Indexer.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/Indexer.ts#L18) #### Type Parameters diff --git a/src/pages/docs/reference/indexer/classes/IndexerModule.md b/src/pages/docs/reference/indexer/classes/IndexerModule.md index 34e802c..8f97922 100644 --- a/src/pages/docs/reference/indexer/classes/IndexerModule.md +++ b/src/pages/docs/reference/indexer/classes/IndexerModule.md @@ -10,7 +10,7 @@ title: IndexerModule # Class: `abstract` IndexerModule\ -Defined in: [indexer/src/IndexerModule.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerModule.ts#L3) +Defined in: [indexer/src/IndexerModule.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerModule.ts#L3) Used by various module sub-types that may need to be configured @@ -113,7 +113,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > `abstract` **start**(): `Promise`\<`void`\> -Defined in: [indexer/src/IndexerModule.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerModule.ts#L4) +Defined in: [indexer/src/IndexerModule.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerModule.ts#L4) #### Returns diff --git a/src/pages/docs/reference/indexer/classes/IndexerNotifier.md b/src/pages/docs/reference/indexer/classes/IndexerNotifier.md index 9e04122..32ac78e 100644 --- a/src/pages/docs/reference/indexer/classes/IndexerNotifier.md +++ b/src/pages/docs/reference/indexer/classes/IndexerNotifier.md @@ -10,7 +10,7 @@ title: IndexerNotifier # Class: IndexerNotifier -Defined in: [indexer/src/IndexerNotifier.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L19) +Defined in: [indexer/src/IndexerNotifier.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L19) Lifecycle of a SequencerModule @@ -26,7 +26,7 @@ start(): Executed to execute any logic required to start the module > **new IndexerNotifier**(`sequencer`, `taskQueue`, `indexBlockTask`): [`IndexerNotifier`](IndexerNotifier.md) -Defined in: [indexer/src/IndexerNotifier.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L20) +Defined in: [indexer/src/IndexerNotifier.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L20) #### Parameters @@ -71,7 +71,7 @@ checks when retrieving it via the getter > **indexBlockTask**: [`IndexBlockTask`](IndexBlockTask.md) -Defined in: [indexer/src/IndexerNotifier.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L25) +Defined in: [indexer/src/IndexerNotifier.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L25) *** @@ -79,7 +79,7 @@ Defined in: [indexer/src/IndexerNotifier.ts:25](https://github.com/proto-kit/fra > **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`NotifierMandatorySequencerModules`](../type-aliases/NotifierMandatorySequencerModules.md)\> -Defined in: [indexer/src/IndexerNotifier.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L22) +Defined in: [indexer/src/IndexerNotifier.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L22) *** @@ -87,7 +87,7 @@ Defined in: [indexer/src/IndexerNotifier.ts:22](https://github.com/proto-kit/fra > **taskQueue**: [`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) -Defined in: [indexer/src/IndexerNotifier.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L24) +Defined in: [indexer/src/IndexerNotifier.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L24) *** @@ -163,7 +163,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **propagateEventsAsTasks**(): `Promise`\<`void`\> -Defined in: [indexer/src/IndexerNotifier.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L30) +Defined in: [indexer/src/IndexerNotifier.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L30) #### Returns @@ -175,7 +175,7 @@ Defined in: [indexer/src/IndexerNotifier.ts:30](https://github.com/proto-kit/fra > **start**(): `Promise`\<`void`\> -Defined in: [indexer/src/IndexerNotifier.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L51) +Defined in: [indexer/src/IndexerNotifier.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L51) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md b/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md index a1cac1a..6124369 100644 --- a/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md +++ b/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md @@ -12,7 +12,7 @@ title: ValidateTakeArg > **ValidateTakeArg**(): `MethodDecorator` -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L68) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L68) ## Returns diff --git a/src/pages/docs/reference/indexer/functions/cleanResolvers.md b/src/pages/docs/reference/indexer/functions/cleanResolvers.md index 8ae5814..1b293e6 100644 --- a/src/pages/docs/reference/indexer/functions/cleanResolvers.md +++ b/src/pages/docs/reference/indexer/functions/cleanResolvers.md @@ -12,7 +12,7 @@ title: cleanResolvers > **cleanResolvers**(`resolvers`): `Function`[] -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L47) +Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L47) ## Parameters diff --git a/src/pages/docs/reference/indexer/globals.md b/src/pages/docs/reference/indexer/globals.md deleted file mode 100644 index 2aac8b5..0000000 --- a/src/pages/docs/reference/indexer/globals.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "@proto-kit/indexer" ---- - -[**@proto-kit/indexer**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/indexer - -# @proto-kit/indexer - -## Classes - -- [GeneratedResolverFactoryGraphqlModule](classes/GeneratedResolverFactoryGraphqlModule.md) -- [IndexBlockTask](classes/IndexBlockTask.md) -- [IndexBlockTaskParametersSerializer](classes/IndexBlockTaskParametersSerializer.md) -- [Indexer](classes/Indexer.md) -- [IndexerModule](classes/IndexerModule.md) -- [IndexerNotifier](classes/IndexerNotifier.md) - -## Interfaces - -- [IndexBlockTaskParameters](interfaces/IndexBlockTaskParameters.md) - -## Type Aliases - -- [IndexerModulesRecord](type-aliases/IndexerModulesRecord.md) -- [NotifierMandatorySequencerModules](type-aliases/NotifierMandatorySequencerModules.md) - -## Functions - -- [cleanResolvers](functions/cleanResolvers.md) -- [ValidateTakeArg](functions/ValidateTakeArg.md) diff --git a/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md b/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md index 60bcbd8..6094a12 100644 --- a/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md +++ b/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md @@ -10,7 +10,7 @@ title: IndexBlockTaskParameters # Interface: IndexBlockTaskParameters -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L9) +Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L9) ## Extends diff --git a/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md b/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md index 9dd0247..ca00996 100644 --- a/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md +++ b/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md @@ -12,4 +12,4 @@ title: IndexerModulesRecord > **IndexerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`IndexerModule`](../classes/IndexerModule.md)\<`unknown`\>\>\> -Defined in: [indexer/src/Indexer.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/Indexer.ts#L11) +Defined in: [indexer/src/Indexer.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/Indexer.ts#L11) diff --git a/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md b/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md index 5f55dc4..3d2a693 100644 --- a/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md +++ b/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md @@ -12,7 +12,7 @@ title: NotifierMandatorySequencerModules > **NotifierMandatorySequencerModules**: `object` -Defined in: [indexer/src/IndexerNotifier.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/indexer/src/IndexerNotifier.ts#L14) +Defined in: [indexer/src/IndexerNotifier.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L14) ## Type declaration diff --git a/src/pages/docs/reference/library/_meta.tsx b/src/pages/docs/reference/library/_meta.tsx index c639525..48a0c5e 100644 --- a/src/pages/docs/reference/library/_meta.tsx +++ b/src/pages/docs/reference/library/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" + "README": "Overview","classes": "Classes","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" }; \ No newline at end of file diff --git a/src/pages/docs/reference/library/classes/Balance.md b/src/pages/docs/reference/library/classes/Balance.md index bb8e010..b02f2d0 100644 --- a/src/pages/docs/reference/library/classes/Balance.md +++ b/src/pages/docs/reference/library/classes/Balance.md @@ -10,7 +10,7 @@ title: Balance # Class: Balance -Defined in: [packages/library/src/runtime/Balances.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L28) +Defined in: [packages/library/src/runtime/Balances.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L28) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -28,7 +28,7 @@ static methods from interface UIntConstructor > **new Balance**(`value`): [`Balance`](Balance.md) -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -76,7 +76,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -190,7 +190,7 @@ Convert provable type from a normal JS type. > `static` **Safe**: `object` -Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L12) +Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L12) #### fromField() @@ -367,7 +367,7 @@ Convert provable type to a normal JS type. > `static` **Unsafe**: `object` -Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L6) +Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L6) #### fromField() @@ -393,7 +393,7 @@ Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit > **get** `static` **max**(): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L35) +Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L35) ##### Returns @@ -411,7 +411,7 @@ Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-ki > **get** `static` **zero**(): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L31) +Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L31) ##### Returns @@ -427,7 +427,7 @@ Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-ki > **add**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -451,7 +451,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -479,7 +479,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -507,7 +507,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -535,7 +535,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -563,7 +563,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -591,7 +591,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> -Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L39) +Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L39) #### Returns @@ -607,7 +607,7 @@ Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-ki > **div**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) Integer division. @@ -634,7 +634,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -668,7 +668,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -692,7 +692,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -716,7 +716,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -740,7 +740,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -764,7 +764,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -788,7 +788,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -815,7 +815,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -839,7 +839,7 @@ Multiplication with overflow checking. > **numBits**(): `64` -Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L43) +Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L43) #### Returns @@ -855,7 +855,7 @@ Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-ki > **sqrtFloor**(): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -873,7 +873,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -912,7 +912,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -936,7 +936,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -954,7 +954,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -972,7 +972,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -991,7 +991,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -1009,7 +1009,7 @@ Turns the [UInt](UInt.md) into a string. > `static` **check**(`x`): `void` -Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L20) +Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L20) Add assertions to the proof to check if `value` is a valid member of type `T`. This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. @@ -1038,7 +1038,7 @@ For instance, calling check function on the type Bool asserts that the value of > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -1064,7 +1064,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **from**(`x`): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L24) +Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L24) #### Parameters @@ -1086,7 +1086,7 @@ Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-ki > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/Balances.md b/src/pages/docs/reference/library/classes/Balances.md index f26c19d..dcc7b7a 100644 --- a/src/pages/docs/reference/library/classes/Balances.md +++ b/src/pages/docs/reference/library/classes/Balances.md @@ -10,7 +10,7 @@ title: Balances # Class: Balances\ -Defined in: [packages/library/src/runtime/Balances.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L45) +Defined in: [packages/library/src/runtime/Balances.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L45) Base class for runtime modules providing the necessary utilities. @@ -52,7 +52,7 @@ Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:31 > **balances**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`BalancesKey`](BalancesKey.md), [`Balance`](Balance.md)\> -Defined in: [packages/library/src/runtime/Balances.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L49) +Defined in: [packages/library/src/runtime/Balances.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L49) #### Implementation of @@ -227,7 +227,7 @@ Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:33 > **burn**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Balances.ts:99](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L99) +Defined in: [packages/library/src/runtime/Balances.ts:99](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L99) #### Parameters @@ -275,7 +275,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **getBalance**(`tokenId`, `address`): `Promise`\<[`Balance`](Balance.md)\> -Defined in: [packages/library/src/runtime/Balances.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L54) +Defined in: [packages/library/src/runtime/Balances.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L54) #### Parameters @@ -313,7 +313,7 @@ Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:32 > **mint**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Balances.ts:93](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L93) +Defined in: [packages/library/src/runtime/Balances.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L93) #### Parameters @@ -339,7 +339,7 @@ Defined in: [packages/library/src/runtime/Balances.ts:93](https://github.com/pro > **setBalance**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Balances.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L63) +Defined in: [packages/library/src/runtime/Balances.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L63) #### Parameters @@ -365,7 +365,7 @@ Defined in: [packages/library/src/runtime/Balances.ts:63](https://github.com/pro > **transfer**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Balances.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L72) +Defined in: [packages/library/src/runtime/Balances.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L72) #### Parameters @@ -399,7 +399,7 @@ Defined in: [packages/library/src/runtime/Balances.ts:72](https://github.com/pro > **transferSigned**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Balances.ts:107](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L107) +Defined in: [packages/library/src/runtime/Balances.ts:107](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L107) #### Parameters diff --git a/src/pages/docs/reference/library/classes/BalancesKey.md b/src/pages/docs/reference/library/classes/BalancesKey.md index b4504ab..e7245d6 100644 --- a/src/pages/docs/reference/library/classes/BalancesKey.md +++ b/src/pages/docs/reference/library/classes/BalancesKey.md @@ -10,7 +10,7 @@ title: BalancesKey # Class: BalancesKey -Defined in: [packages/library/src/runtime/Balances.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L19) +Defined in: [packages/library/src/runtime/Balances.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L19) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **address**: `PublicKey` = `PublicKey` -Defined in: [packages/library/src/runtime/Balances.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L21) +Defined in: [packages/library/src/runtime/Balances.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L21) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/library/src/runtime/Balances.ts:21](https://github.com/pro > **tokenId**: [`TokenId`](TokenId.md) = `TokenId` -Defined in: [packages/library/src/runtime/Balances.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L20) +Defined in: [packages/library/src/runtime/Balances.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L20) #### Inherited from @@ -414,7 +414,7 @@ Convert provable type to a normal JS type. > `static` **from**(`tokenId`, `address`): [`BalancesKey`](BalancesKey.md) -Defined in: [packages/library/src/runtime/Balances.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L23) +Defined in: [packages/library/src/runtime/Balances.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L23) #### Parameters diff --git a/src/pages/docs/reference/library/classes/FeeTree.md b/src/pages/docs/reference/library/classes/FeeTree.md index 5545f57..4216dca 100644 --- a/src/pages/docs/reference/library/classes/FeeTree.md +++ b/src/pages/docs/reference/library/classes/FeeTree.md @@ -10,7 +10,7 @@ title: FeeTree # Class: FeeTree -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L44) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L44) ## Extends diff --git a/src/pages/docs/reference/library/classes/InMemorySequencerModules.md b/src/pages/docs/reference/library/classes/InMemorySequencerModules.md index de50de0..35e9eff 100644 --- a/src/pages/docs/reference/library/classes/InMemorySequencerModules.md +++ b/src/pages/docs/reference/library/classes/InMemorySequencerModules.md @@ -10,7 +10,7 @@ title: InMemorySequencerModules # Class: InMemorySequencerModules -Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/InMemorySequencerModules.ts#L31) +Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/InMemorySequencerModules.ts#L33) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:31](http > `static` **with**\<`SequencerModules`\>(`additionalModules`): `object` & `SequencerModules` -Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/InMemorySequencerModules.ts#L32) +Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/InMemorySequencerModules.ts#L34) #### Type Parameters diff --git a/src/pages/docs/reference/library/classes/MethodFeeConfigData.md b/src/pages/docs/reference/library/classes/MethodFeeConfigData.md index 8b17478..70abdc2 100644 --- a/src/pages/docs/reference/library/classes/MethodFeeConfigData.md +++ b/src/pages/docs/reference/library/classes/MethodFeeConfigData.md @@ -10,7 +10,7 @@ title: MethodFeeConfigData # Class: MethodFeeConfigData -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L32) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L32) ## Extends @@ -58,7 +58,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **baseFee**: [`UInt64`](UInt64.md) = `UInt64` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L34) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L34) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:34](https:/ > **methodId**: `Field` = `Field` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L33) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L33) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:33](https:/ > **perWeightUnitFee**: [`UInt64`](UInt64.md) = `UInt64` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L35) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L35) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:35](https:/ > **weight**: [`UInt64`](UInt64.md) = `UInt64` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L36) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L36) #### Inherited from @@ -570,7 +570,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L38) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L38) #### Returns diff --git a/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md b/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md index d4ccf89..d790f3d 100644 --- a/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md +++ b/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md @@ -10,7 +10,7 @@ title: RuntimeFeeAnalyzerService # Class: RuntimeFeeAnalyzerService -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L56) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L56) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new RuntimeFeeAnalyzerService**(`runtime`): [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L67) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L67) #### Parameters @@ -61,7 +61,7 @@ checks when retrieving it via the getter > **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L68) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L68) ## Accessors @@ -125,7 +125,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **getFeeConfig**(`methodId`): [`MethodFeeConfigData`](MethodFeeConfigData.md) -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:169](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L169) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:169](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L169) #### Parameters @@ -143,7 +143,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:169](https: > **getFeeTree**(): `object` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:161](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L161) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:161](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L161) #### Returns @@ -167,7 +167,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:161](https: > **getRoot**(): `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:185](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L185) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:185](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L185) #### Returns @@ -179,7 +179,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:185](https: > **getWitness**(`methodId`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:180](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L180) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:180](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L180) #### Parameters @@ -197,7 +197,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:180](https: > **initializeFeeTree**(): `Promise`\<`void`\> -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L73) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L73) #### Returns @@ -209,7 +209,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:73](https:/ > `static` **getWitnessType**(): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L57) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L57) #### Returns diff --git a/src/pages/docs/reference/library/classes/SimpleSequencerModules.md b/src/pages/docs/reference/library/classes/SimpleSequencerModules.md index 7b4c933..90b3cb7 100644 --- a/src/pages/docs/reference/library/classes/SimpleSequencerModules.md +++ b/src/pages/docs/reference/library/classes/SimpleSequencerModules.md @@ -10,7 +10,7 @@ title: SimpleSequencerModules # Class: SimpleSequencerModules -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L46) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L46) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:46](https: > `static` **defaultConfig**(): `object` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:97](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L97) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:97](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L97) #### Returns @@ -60,7 +60,7 @@ Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:97](https: > `static` **defaultWorkerConfig**(): `object` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L109) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L109) #### Returns @@ -74,10 +74,6 @@ Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:109](https > **LocalTaskWorkerModule.BlockBuildingTask**: `object` -###### LocalTaskWorkerModule.BlockProvingTask - -> **LocalTaskWorkerModule.BlockProvingTask**: `object` - ###### LocalTaskWorkerModule.BlockReductionTask > **LocalTaskWorkerModule.BlockReductionTask**: `object` @@ -116,7 +112,7 @@ Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:109](https > `static` **with**\<`SequencerModules`\>(`additionalModules`): `object` & `Omit`\<`SequencerModules`, `"Database"` \| `"BlockTrigger"` \| `"TaskQueue"` \| `"BaseLayer"` \| `"DatabasePruneModule"`\> & `object` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L60) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L60) #### Type Parameters @@ -138,7 +134,7 @@ Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:60](https: > `static` **worker**\<`QueueModule`, `SequencerModules`\>(`queue`, `additionalModules`): `object` & `SequencerModules` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L47) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L47) #### Type Parameters diff --git a/src/pages/docs/reference/library/classes/TokenId.md b/src/pages/docs/reference/library/classes/TokenId.md index ab7d912..0194d26 100644 --- a/src/pages/docs/reference/library/classes/TokenId.md +++ b/src/pages/docs/reference/library/classes/TokenId.md @@ -10,7 +10,7 @@ title: TokenId # Class: TokenId -Defined in: [packages/library/src/runtime/Balances.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L18) +Defined in: [packages/library/src/runtime/Balances.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L18) ## Extends diff --git a/src/pages/docs/reference/library/classes/TransactionFeeHook.md b/src/pages/docs/reference/library/classes/TransactionFeeHook.md index 422e1b3..20df290 100644 --- a/src/pages/docs/reference/library/classes/TransactionFeeHook.md +++ b/src/pages/docs/reference/library/classes/TransactionFeeHook.md @@ -10,7 +10,7 @@ title: TransactionFeeHook # Class: TransactionFeeHook -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L51) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L51) Transaction hook for deducting transaction fees from the sender's balance. @@ -22,9 +22,9 @@ Transaction hook for deducting transaction fees from the sender's balance. ### new TransactionFeeHook() -> **new TransactionFeeHook**(`runtime`): [`TransactionFeeHook`](TransactionFeeHook.md) +> **new TransactionFeeHook**(`runtime`, `balances`): [`TransactionFeeHook`](TransactionFeeHook.md) -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L52) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L52) #### Parameters @@ -32,6 +32,10 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:52](https://github [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> +##### balances + +`Balances` + #### Returns [`TransactionFeeHook`](TransactionFeeHook.md) @@ -42,6 +46,14 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:52](https://github ## Properties +### balances + +> **balances**: `Balances` + +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L55) + +*** + ### currentConfig > `protected` **currentConfig**: `undefined` \| [`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) @@ -73,7 +85,7 @@ Defined in: packages/protocol/dist/protocol/TransitioningProtocolModule.d.ts:8 > `protected` **persistedFeeAnalyzer**: `undefined` \| [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) = `undefined` -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L59) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L60) *** @@ -93,7 +105,7 @@ Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:4 > **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L54) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L54) ## Accessors @@ -115,27 +127,13 @@ Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:5 *** -### balances - -#### Get Signature - -> **get** **balances**(): `Balances` - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L94) - -##### Returns - -`Balances` - -*** - ### config #### Get Signature > **get** **config**(): [`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L85) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L86) ##### Returns @@ -145,7 +143,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:85](https://github > **set** **config**(`value`): `void` -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:90](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L90) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:91](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L91) ##### Parameters @@ -169,7 +167,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:90](https://github > **get** **feeAnalyzer**(): [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L98) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:95](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L95) ##### Returns @@ -203,7 +201,7 @@ Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:6 > **getFee**(`feeConfig`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L114) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:111](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L111) #### Parameters @@ -221,7 +219,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:114](https://githu > **onTransaction**(`executionData`): `Promise`\<`void`\> -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:128](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L128) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:125](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L125) Determine the transaction fee for the given transaction, and transfer it from the transaction sender to the fee recipient. @@ -246,7 +244,7 @@ from the transaction sender to the fee recipient. > **start**(): `Promise`\<`void`\> -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L79) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L80) #### Returns @@ -262,7 +260,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:79](https://github > **transferFee**(`from`, `fee`): `Promise`\<`void`\> -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L105) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L102) #### Parameters @@ -284,7 +282,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:105](https://githu > **verifyConfig**(): `void` -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L64) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L65) #### Returns diff --git a/src/pages/docs/reference/library/classes/UInt.md b/src/pages/docs/reference/library/classes/UInt.md index 637509c..2a54c0b 100644 --- a/src/pages/docs/reference/library/classes/UInt.md +++ b/src/pages/docs/reference/library/classes/UInt.md @@ -10,7 +10,7 @@ title: UInt # Class: `abstract` UInt\ -Defined in: [packages/library/src/math/UInt.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L45) +Defined in: [packages/library/src/math/UInt.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L45) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -39,7 +39,7 @@ static methods from interface UIntConstructor > **new UInt**\<`BITS`\>(`value`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -63,7 +63,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -87,7 +87,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -381,7 +381,7 @@ Convert provable type to a normal JS type. > **add**(`y`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -401,7 +401,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -425,7 +425,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -449,7 +449,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -473,7 +473,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -497,7 +497,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -521,7 +521,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > `abstract` **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:91](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L91) +Defined in: [packages/library/src/math/UInt.ts:91](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L91) #### Returns @@ -533,7 +533,7 @@ Defined in: [packages/library/src/math/UInt.ts:91](https://github.com/proto-kit/ > **div**(`y`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) Integer division. @@ -556,7 +556,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -586,7 +586,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -606,7 +606,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -626,7 +626,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -646,7 +646,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -666,7 +666,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -686,7 +686,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -709,7 +709,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -729,7 +729,7 @@ Multiplication with overflow checking. > `abstract` **numBits**(): `BITS` -Defined in: [packages/library/src/math/UInt.ts:89](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L89) +Defined in: [packages/library/src/math/UInt.ts:89](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L89) #### Returns @@ -741,7 +741,7 @@ Defined in: [packages/library/src/math/UInt.ts:89](https://github.com/proto-kit/ > **sqrtFloor**(): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -755,7 +755,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -790,7 +790,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`BITS`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -810,7 +810,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -824,7 +824,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -838,7 +838,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -853,7 +853,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -867,7 +867,7 @@ Turns the [UInt](UInt.md) into a string. > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -889,7 +889,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/UInt112.md b/src/pages/docs/reference/library/classes/UInt112.md index c2a5479..778b5b2 100644 --- a/src/pages/docs/reference/library/classes/UInt112.md +++ b/src/pages/docs/reference/library/classes/UInt112.md @@ -10,7 +10,7 @@ title: UInt112 # Class: UInt112 -Defined in: [packages/library/src/math/UInt112.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L6) +Defined in: [packages/library/src/math/UInt112.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L6) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -28,7 +28,7 @@ static methods from interface UIntConstructor > **new UInt112**(`value`): [`UInt112`](UInt112.md) -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -76,7 +76,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -190,7 +190,7 @@ Convert provable type from a normal JS type. > `static` **Safe**: `object` -Defined in: [packages/library/src/math/UInt112.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L13) +Defined in: [packages/library/src/math/UInt112.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L13) #### fromField() @@ -363,7 +363,7 @@ Convert provable type to a normal JS type. > `static` **Unsafe**: `object` -Defined in: [packages/library/src/math/UInt112.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L7) +Defined in: [packages/library/src/math/UInt112.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L7) #### fromField() @@ -385,7 +385,7 @@ Defined in: [packages/library/src/math/UInt112.ts:7](https://github.com/proto-ki > **get** `static` **max**(): [`UInt112`](UInt112.md) -Defined in: [packages/library/src/math/UInt112.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L36) +Defined in: [packages/library/src/math/UInt112.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L36) ##### Returns @@ -399,7 +399,7 @@ Defined in: [packages/library/src/math/UInt112.ts:36](https://github.com/proto-k > **get** `static` **zero**(): [`UInt112`](UInt112.md) -Defined in: [packages/library/src/math/UInt112.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L32) +Defined in: [packages/library/src/math/UInt112.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L32) ##### Returns @@ -411,7 +411,7 @@ Defined in: [packages/library/src/math/UInt112.ts:32](https://github.com/proto-k > **add**(`y`): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -435,7 +435,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -463,7 +463,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -491,7 +491,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -519,7 +519,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -547,7 +547,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -575,7 +575,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`112`\> -Defined in: [packages/library/src/math/UInt112.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L40) +Defined in: [packages/library/src/math/UInt112.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L40) #### Returns @@ -591,7 +591,7 @@ Defined in: [packages/library/src/math/UInt112.ts:40](https://github.com/proto-k > **div**(`y`): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) Integer division. @@ -618,7 +618,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -652,7 +652,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -676,7 +676,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -700,7 +700,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -724,7 +724,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -748,7 +748,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -772,7 +772,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -799,7 +799,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -823,7 +823,7 @@ Multiplication with overflow checking. > **numBits**(): `112` -Defined in: [packages/library/src/math/UInt112.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L44) +Defined in: [packages/library/src/math/UInt112.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L44) #### Returns @@ -839,7 +839,7 @@ Defined in: [packages/library/src/math/UInt112.ts:44](https://github.com/proto-k > **sqrtFloor**(): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -857,7 +857,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -896,7 +896,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`112`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -920,7 +920,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -938,7 +938,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -956,7 +956,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -975,7 +975,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -993,7 +993,7 @@ Turns the [UInt](UInt.md) into a string. > **toUInt224**(): [`UInt224`](UInt224.md) -Defined in: [packages/library/src/math/UInt112.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L48) +Defined in: [packages/library/src/math/UInt112.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L48) #### Returns @@ -1005,7 +1005,7 @@ Defined in: [packages/library/src/math/UInt112.ts:48](https://github.com/proto-k > `static` **check**(`x`): `void` -Defined in: [packages/library/src/math/UInt112.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L21) +Defined in: [packages/library/src/math/UInt112.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L21) Add assertions to the proof to check if `value` is a valid member of type `T`. This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. @@ -1034,7 +1034,7 @@ For instance, calling check function on the type Bool asserts that the value of > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -1060,7 +1060,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **from**(`x`): [`UInt112`](UInt112.md) -Defined in: [packages/library/src/math/UInt112.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt112.ts#L25) +Defined in: [packages/library/src/math/UInt112.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L25) #### Parameters @@ -1078,7 +1078,7 @@ Defined in: [packages/library/src/math/UInt112.ts:25](https://github.com/proto-k > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/UInt224.md b/src/pages/docs/reference/library/classes/UInt224.md index af1a02b..27fe2b4 100644 --- a/src/pages/docs/reference/library/classes/UInt224.md +++ b/src/pages/docs/reference/library/classes/UInt224.md @@ -10,7 +10,7 @@ title: UInt224 # Class: UInt224 -Defined in: [packages/library/src/math/UInt224.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L5) +Defined in: [packages/library/src/math/UInt224.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L5) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -28,7 +28,7 @@ static methods from interface UIntConstructor > **new UInt224**(`value`): [`UInt224`](UInt224.md) -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -76,7 +76,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -190,7 +190,7 @@ Convert provable type from a normal JS type. > `static` **Safe**: `object` -Defined in: [packages/library/src/math/UInt224.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L12) +Defined in: [packages/library/src/math/UInt224.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L12) #### fromField() @@ -363,7 +363,7 @@ Convert provable type to a normal JS type. > `static` **Unsafe**: `object` -Defined in: [packages/library/src/math/UInt224.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L6) +Defined in: [packages/library/src/math/UInt224.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L6) #### fromField() @@ -385,7 +385,7 @@ Defined in: [packages/library/src/math/UInt224.ts:6](https://github.com/proto-ki > **get** `static` **max**(): [`UInt224`](UInt224.md) -Defined in: [packages/library/src/math/UInt224.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L35) +Defined in: [packages/library/src/math/UInt224.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L35) ##### Returns @@ -399,7 +399,7 @@ Defined in: [packages/library/src/math/UInt224.ts:35](https://github.com/proto-k > **get** `static` **zero**(): [`UInt224`](UInt224.md) -Defined in: [packages/library/src/math/UInt224.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L31) +Defined in: [packages/library/src/math/UInt224.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L31) ##### Returns @@ -411,7 +411,7 @@ Defined in: [packages/library/src/math/UInt224.ts:31](https://github.com/proto-k > **add**(`y`): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -435,7 +435,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -463,7 +463,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -491,7 +491,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -519,7 +519,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -547,7 +547,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -575,7 +575,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`224`\> -Defined in: [packages/library/src/math/UInt224.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L39) +Defined in: [packages/library/src/math/UInt224.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L39) #### Returns @@ -591,7 +591,7 @@ Defined in: [packages/library/src/math/UInt224.ts:39](https://github.com/proto-k > **div**(`y`): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) Integer division. @@ -618,7 +618,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -652,7 +652,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -676,7 +676,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -700,7 +700,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -724,7 +724,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -748,7 +748,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -772,7 +772,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -799,7 +799,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -823,7 +823,7 @@ Multiplication with overflow checking. > **numBits**(): `224` -Defined in: [packages/library/src/math/UInt224.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L43) +Defined in: [packages/library/src/math/UInt224.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L43) #### Returns @@ -839,7 +839,7 @@ Defined in: [packages/library/src/math/UInt224.ts:43](https://github.com/proto-k > **sqrtFloor**(): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -857,7 +857,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -896,7 +896,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`224`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -920,7 +920,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -938,7 +938,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -956,7 +956,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -975,7 +975,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -993,7 +993,7 @@ Turns the [UInt](UInt.md) into a string. > `static` **check**(`x`): `void` -Defined in: [packages/library/src/math/UInt224.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L20) +Defined in: [packages/library/src/math/UInt224.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L20) Add assertions to the proof to check if `value` is a valid member of type `T`. This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. @@ -1022,7 +1022,7 @@ For instance, calling check function on the type Bool asserts that the value of > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -1048,7 +1048,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **from**(`x`): [`UInt224`](UInt224.md) -Defined in: [packages/library/src/math/UInt224.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt224.ts#L24) +Defined in: [packages/library/src/math/UInt224.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L24) #### Parameters @@ -1066,7 +1066,7 @@ Defined in: [packages/library/src/math/UInt224.ts:24](https://github.com/proto-k > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/UInt32.md b/src/pages/docs/reference/library/classes/UInt32.md index e65825e..ee43ae5 100644 --- a/src/pages/docs/reference/library/classes/UInt32.md +++ b/src/pages/docs/reference/library/classes/UInt32.md @@ -10,7 +10,7 @@ title: UInt32 # Class: UInt32 -Defined in: [packages/library/src/math/UInt32.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L6) +Defined in: [packages/library/src/math/UInt32.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L6) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -28,7 +28,7 @@ static methods from interface UIntConstructor > **new UInt32**(`value`): [`UInt32`](UInt32.md) -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -76,7 +76,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -190,7 +190,7 @@ Convert provable type from a normal JS type. > `static` **Safe**: `object` -Defined in: [packages/library/src/math/UInt32.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L13) +Defined in: [packages/library/src/math/UInt32.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L13) #### fromField() @@ -363,7 +363,7 @@ Convert provable type to a normal JS type. > `static` **Unsafe**: `object` -Defined in: [packages/library/src/math/UInt32.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L7) +Defined in: [packages/library/src/math/UInt32.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L7) #### fromField() @@ -385,7 +385,7 @@ Defined in: [packages/library/src/math/UInt32.ts:7](https://github.com/proto-kit > **get** `static` **max**(): [`UInt32`](UInt32.md) -Defined in: [packages/library/src/math/UInt32.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L36) +Defined in: [packages/library/src/math/UInt32.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L36) ##### Returns @@ -399,7 +399,7 @@ Defined in: [packages/library/src/math/UInt32.ts:36](https://github.com/proto-ki > **get** `static` **zero**(): [`UInt32`](UInt32.md) -Defined in: [packages/library/src/math/UInt32.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L32) +Defined in: [packages/library/src/math/UInt32.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L32) ##### Returns @@ -411,7 +411,7 @@ Defined in: [packages/library/src/math/UInt32.ts:32](https://github.com/proto-ki > **add**(`y`): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -435,7 +435,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -463,7 +463,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -491,7 +491,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -519,7 +519,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -547,7 +547,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -575,7 +575,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`32`\> -Defined in: [packages/library/src/math/UInt32.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L40) +Defined in: [packages/library/src/math/UInt32.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L40) #### Returns @@ -591,7 +591,7 @@ Defined in: [packages/library/src/math/UInt32.ts:40](https://github.com/proto-ki > **div**(`y`): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) Integer division. @@ -618,7 +618,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -652,7 +652,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -676,7 +676,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -700,7 +700,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -724,7 +724,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -748,7 +748,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -772,7 +772,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -799,7 +799,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -823,7 +823,7 @@ Multiplication with overflow checking. > **numBits**(): `32` -Defined in: [packages/library/src/math/UInt32.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L44) +Defined in: [packages/library/src/math/UInt32.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L44) #### Returns @@ -839,7 +839,7 @@ Defined in: [packages/library/src/math/UInt32.ts:44](https://github.com/proto-ki > **sqrtFloor**(): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -857,7 +857,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -896,7 +896,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`32`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -920,7 +920,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -938,7 +938,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -956,7 +956,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -975,7 +975,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -993,7 +993,7 @@ Turns the [UInt](UInt.md) into a string. > **toUInt64**(): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt32.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L48) +Defined in: [packages/library/src/math/UInt32.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L48) #### Returns @@ -1005,7 +1005,7 @@ Defined in: [packages/library/src/math/UInt32.ts:48](https://github.com/proto-ki > `static` **check**(`x`): `void` -Defined in: [packages/library/src/math/UInt32.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L21) +Defined in: [packages/library/src/math/UInt32.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L21) Add assertions to the proof to check if `value` is a valid member of type `T`. This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. @@ -1034,7 +1034,7 @@ For instance, calling check function on the type Bool asserts that the value of > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -1060,7 +1060,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **from**(`x`): [`UInt32`](UInt32.md) -Defined in: [packages/library/src/math/UInt32.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt32.ts#L25) +Defined in: [packages/library/src/math/UInt32.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L25) #### Parameters @@ -1078,7 +1078,7 @@ Defined in: [packages/library/src/math/UInt32.ts:25](https://github.com/proto-ki > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/UInt64.md b/src/pages/docs/reference/library/classes/UInt64.md index b65c906..cf04e88 100644 --- a/src/pages/docs/reference/library/classes/UInt64.md +++ b/src/pages/docs/reference/library/classes/UInt64.md @@ -10,7 +10,7 @@ title: UInt64 # Class: UInt64 -Defined in: [packages/library/src/math/UInt64.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L5) +Defined in: [packages/library/src/math/UInt64.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L5) UInt is a base class for all soft-failing UInt* implementations. It has to be overridden for every bitlength that should be available. @@ -32,7 +32,7 @@ static methods from interface UIntConstructor > **new UInt64**(`value`): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L74) +Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) #### Parameters @@ -56,7 +56,7 @@ Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/ > **value**: `Field` = `Field` -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L46) +Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) #### Inherited from @@ -80,7 +80,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 > `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L48) +Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) #### Parameters @@ -194,7 +194,7 @@ Convert provable type from a normal JS type. > `static` **Safe**: `object` -Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L12) +Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L12) #### fromField() @@ -367,7 +367,7 @@ Convert provable type to a normal JS type. > `static` **Unsafe**: `object` -Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L6) +Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L6) #### fromField() @@ -389,7 +389,7 @@ Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit > **get** `static` **max**(): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L35) +Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L35) ##### Returns @@ -403,7 +403,7 @@ Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-ki > **get** `static` **zero**(): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L31) +Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L31) ##### Returns @@ -415,7 +415,7 @@ Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-ki > **add**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L301) +Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) Addition with overflow checking. @@ -439,7 +439,7 @@ Addition with overflow checking. > **assertEquals**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L413) +Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) Asserts that a [UInt](UInt.md) is equal to another one. @@ -467,7 +467,7 @@ Asserts that a [UInt](UInt.md) is equal to another one. > **assertGreaterThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L385) +Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) Asserts that a [UInt](UInt.md) is greater than another one. @@ -495,7 +495,7 @@ Asserts that a [UInt](UInt.md) is greater than another one. > **assertGreaterThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L399) +Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) Asserts that a [UInt](UInt.md) is greater than or equal to another one. @@ -523,7 +523,7 @@ Asserts that a [UInt](UInt.md) is greater than or equal to another one. > **assertLessThan**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L371) +Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) Asserts that a [UInt](UInt.md) is less than another one. @@ -551,7 +551,7 @@ Asserts that a [UInt](UInt.md) is less than another one. > **assertLessThanOrEqual**(`y`, `message`?): `void` -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L341) +Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) Asserts that a [UInt](UInt.md) is less than or equal to another one. @@ -579,7 +579,7 @@ Asserts that a [UInt](UInt.md) is less than or equal to another one. > **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> -Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L39) +Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L39) #### Returns @@ -595,7 +595,7 @@ Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-ki > **div**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L183) +Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) Integer division. @@ -622,7 +622,7 @@ Integer division. > **divMod**(`divisor`): `object` -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L122) +Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) Integer division with remainder. @@ -656,7 +656,7 @@ Integer division with remainder. > **equals**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L406) +Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) Checks if a [UInt](UInt.md) is equal to another one. @@ -680,7 +680,7 @@ Checks if a [UInt](UInt.md) is equal to another one. > **greaterThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L378) +Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) Checks if a [UInt](UInt.md) is greater than another one. @@ -704,7 +704,7 @@ Checks if a [UInt](UInt.md) is greater than another one. > **greaterThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L392) +Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) Checks if a [UInt](UInt.md) is greater than or equal to another one. @@ -728,7 +728,7 @@ Checks if a [UInt](UInt.md) is greater than or equal to another one. > **lessThan**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L364) +Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) Checks if a [UInt](UInt.md) is less than another one. @@ -752,7 +752,7 @@ Checks if a [UInt](UInt.md) is less than another one. > **lessThanOrEqual**(`y`): `Bool` -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L325) +Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) Checks if a [UInt](UInt.md) is less than or equal to another one. @@ -776,7 +776,7 @@ Checks if a [UInt](UInt.md) is less than or equal to another one. > **mod**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L275) +Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) Integer remainder. @@ -803,7 +803,7 @@ Integer remainder. > **mul**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L282) +Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) Multiplication with overflow checking. @@ -827,7 +827,7 @@ Multiplication with overflow checking. > **numBits**(): `64` -Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L43) +Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L43) #### Returns @@ -843,7 +843,7 @@ Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-ki > **sqrtFloor**(): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L265) +Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) Wraps sqrtMod() by only returning the sqrt and omitting the rest field. @@ -861,7 +861,7 @@ Wraps sqrtMod() by only returning the sqrt and omitting the rest field. > **sqrtMod**(): `object` -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L202) +Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) Implements a non-overflowing square-root with rest. Normal Field.sqrt() provides the sqrt as it is defined by the finite @@ -900,7 +900,7 @@ is from the "real" sqrt > **sub**(`y`): [`UInt`](UInt.md)\<`64`\> -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L313) +Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) Subtraction with underflow checking. @@ -924,7 +924,7 @@ Subtraction with underflow checking. > **toBigInt**(): `bigint` -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L113) +Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) Turns the [UInt](UInt.md) into a BigInt. @@ -942,7 +942,7 @@ Turns the [UInt](UInt.md) into a BigInt. > **toO1UInt64**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L420) +Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. @@ -960,7 +960,7 @@ Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fit > **toO1UInt64Clamped**(): `UInt64` -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L430) +Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), clamping to the 64 bits range if it's too large. @@ -979,7 +979,7 @@ clamping to the 64 bits range if it's too large. > **toString**(): `string` -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L105) +Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) Turns the [UInt](UInt.md) into a string. @@ -997,7 +997,7 @@ Turns the [UInt](UInt.md) into a string. > `static` **check**(`x`): `void` -Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L20) +Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L20) Add assertions to the proof to check if `value` is a valid member of type `T`. This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. @@ -1026,7 +1026,7 @@ For instance, calling check function on the type Bool asserts that the value of > `static` **checkConstant**(`x`, `numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L54) +Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) #### Parameters @@ -1052,7 +1052,7 @@ Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/ > `static` **from**(`x`): [`UInt64`](UInt64.md) -Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt64.ts#L24) +Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L24) #### Parameters @@ -1070,7 +1070,7 @@ Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-ki > `static` **maxIntField**(`numBits`): `Field` -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L70) +Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. diff --git a/src/pages/docs/reference/library/classes/VanillaProtocolModules.md b/src/pages/docs/reference/library/classes/VanillaProtocolModules.md index 3110662..2c890a7 100644 --- a/src/pages/docs/reference/library/classes/VanillaProtocolModules.md +++ b/src/pages/docs/reference/library/classes/VanillaProtocolModules.md @@ -10,7 +10,7 @@ title: VanillaProtocolModules # Class: VanillaProtocolModules -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L18) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L18) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:18](https:/ > `static` **defaultConfig**(): `object` -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L51) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L51) #### Returns @@ -84,7 +84,7 @@ Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:51](https:/ > `static` **mandatoryConfig**(): `object` -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L41) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L41) #### Returns @@ -116,7 +116,7 @@ Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:41](https:/ > `static` **mandatoryModules**\<`ProtocolModules`\>(`additionalModules`): [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `ProtocolModules` -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L19) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L19) #### Type Parameters @@ -138,7 +138,7 @@ Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:19](https:/ > `static` **with**\<`ProtocolModules`\>(`additionalModules`): [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object` & `ProtocolModules` -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L32) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L32) #### Type Parameters diff --git a/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md b/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md index 10be53f..d82a742 100644 --- a/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md +++ b/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md @@ -10,7 +10,7 @@ title: VanillaRuntimeModules # Class: VanillaRuntimeModules -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/VanillaRuntimeModules.ts#L10) +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/VanillaRuntimeModules.ts#L10) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:10](https://g > `static` **defaultConfig**(): `object` -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/VanillaRuntimeModules.ts#L20) +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/VanillaRuntimeModules.ts#L20) #### Returns @@ -44,7 +44,7 @@ Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:20](https://g > `static` **with**\<`RuntimeModules`\>(`additionalModules`): `object` & `RuntimeModules` -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/VanillaRuntimeModules.ts#L11) +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/VanillaRuntimeModules.ts#L11) #### Type Parameters diff --git a/src/pages/docs/reference/library/classes/WithdrawalEvent.md b/src/pages/docs/reference/library/classes/WithdrawalEvent.md index 160765b..ffa9f02 100644 --- a/src/pages/docs/reference/library/classes/WithdrawalEvent.md +++ b/src/pages/docs/reference/library/classes/WithdrawalEvent.md @@ -10,7 +10,7 @@ title: WithdrawalEvent # Class: WithdrawalEvent -Defined in: [packages/library/src/runtime/Withdrawals.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L20) +Defined in: [packages/library/src/runtime/Withdrawals.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L20) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` -Defined in: [packages/library/src/runtime/Withdrawals.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L21) +Defined in: [packages/library/src/runtime/Withdrawals.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L21) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/library/src/runtime/Withdrawals.ts:21](https://github.com/ > **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` -Defined in: [packages/library/src/runtime/Withdrawals.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L22) +Defined in: [packages/library/src/runtime/Withdrawals.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L22) #### Inherited from diff --git a/src/pages/docs/reference/library/classes/WithdrawalKey.md b/src/pages/docs/reference/library/classes/WithdrawalKey.md index 5acf2b2..2035287 100644 --- a/src/pages/docs/reference/library/classes/WithdrawalKey.md +++ b/src/pages/docs/reference/library/classes/WithdrawalKey.md @@ -10,7 +10,7 @@ title: WithdrawalKey # Class: WithdrawalKey -Defined in: [packages/library/src/runtime/Withdrawals.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L15) +Defined in: [packages/library/src/runtime/Withdrawals.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L15) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **index**: `Field` = `Field` -Defined in: [packages/library/src/runtime/Withdrawals.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L16) +Defined in: [packages/library/src/runtime/Withdrawals.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L16) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/library/src/runtime/Withdrawals.ts:16](https://github.com/ > **tokenId**: `Field` = `Field` -Defined in: [packages/library/src/runtime/Withdrawals.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L17) +Defined in: [packages/library/src/runtime/Withdrawals.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L17) #### Inherited from diff --git a/src/pages/docs/reference/library/classes/Withdrawals.md b/src/pages/docs/reference/library/classes/Withdrawals.md index ecacd5e..c66cbdb 100644 --- a/src/pages/docs/reference/library/classes/Withdrawals.md +++ b/src/pages/docs/reference/library/classes/Withdrawals.md @@ -10,7 +10,7 @@ title: Withdrawals # Class: Withdrawals -Defined in: [packages/library/src/runtime/Withdrawals.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L26) +Defined in: [packages/library/src/runtime/Withdrawals.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L26) Base class for runtime modules providing the necessary utilities. @@ -24,7 +24,7 @@ Base class for runtime modules providing the necessary utilities. > **new Withdrawals**(`balances`): [`Withdrawals`](Withdrawals.md) -Defined in: [packages/library/src/runtime/Withdrawals.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L38) +Defined in: [packages/library/src/runtime/Withdrawals.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L38) #### Parameters @@ -61,7 +61,7 @@ checks when retrieving it via the getter > **events**: [`RuntimeEvents`](../../module/classes/RuntimeEvents.md)\<\{ `withdrawal`: *typeof* [`WithdrawalEvent`](WithdrawalEvent.md); \}\> -Defined in: [packages/library/src/runtime/Withdrawals.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L27) +Defined in: [packages/library/src/runtime/Withdrawals.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L27) #### Overrides @@ -127,7 +127,7 @@ Holds all method names that are callable throw transactions > **withdrawalCounters**: [`StateMap`](../../protocol/classes/StateMap.md)\<`Field`, `Field`\> -Defined in: [packages/library/src/runtime/Withdrawals.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L31) +Defined in: [packages/library/src/runtime/Withdrawals.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L31) *** @@ -135,7 +135,7 @@ Defined in: [packages/library/src/runtime/Withdrawals.ts:31](https://github.com/ > **withdrawals**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`WithdrawalKey`](WithdrawalKey.md), [`Withdrawal`](../../protocol/classes/Withdrawal.md)\> -Defined in: [packages/library/src/runtime/Withdrawals.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L33) +Defined in: [packages/library/src/runtime/Withdrawals.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L33) *** @@ -263,7 +263,7 @@ Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:32 > `protected` **queueWithdrawal**(`withdrawal`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Withdrawals.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L42) +Defined in: [packages/library/src/runtime/Withdrawals.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L42) #### Parameters @@ -281,7 +281,7 @@ Defined in: [packages/library/src/runtime/Withdrawals.ts:42](https://github.com/ > **withdraw**(`address`, `amount`, `tokenId`): `Promise`\<`void`\> -Defined in: [packages/library/src/runtime/Withdrawals.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Withdrawals.ts#L59) +Defined in: [packages/library/src/runtime/Withdrawals.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L59) #### Parameters diff --git a/src/pages/docs/reference/library/globals.md b/src/pages/docs/reference/library/globals.md deleted file mode 100644 index d12c654..0000000 --- a/src/pages/docs/reference/library/globals.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "@proto-kit/library" ---- - -[**@proto-kit/library**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/library - -# @proto-kit/library - -## Classes - -- [Balance](classes/Balance.md) -- [Balances](classes/Balances.md) -- [BalancesKey](classes/BalancesKey.md) -- [FeeTree](classes/FeeTree.md) -- [InMemorySequencerModules](classes/InMemorySequencerModules.md) -- [MethodFeeConfigData](classes/MethodFeeConfigData.md) -- [RuntimeFeeAnalyzerService](classes/RuntimeFeeAnalyzerService.md) -- [SimpleSequencerModules](classes/SimpleSequencerModules.md) -- [TokenId](classes/TokenId.md) -- [TransactionFeeHook](classes/TransactionFeeHook.md) -- [UInt](classes/UInt.md) -- [UInt112](classes/UInt112.md) -- [UInt224](classes/UInt224.md) -- [UInt32](classes/UInt32.md) -- [UInt64](classes/UInt64.md) -- [VanillaProtocolModules](classes/VanillaProtocolModules.md) -- [VanillaRuntimeModules](classes/VanillaRuntimeModules.md) -- [WithdrawalEvent](classes/WithdrawalEvent.md) -- [WithdrawalKey](classes/WithdrawalKey.md) -- [Withdrawals](classes/Withdrawals.md) - -## Interfaces - -- [BalancesEvents](interfaces/BalancesEvents.md) -- [FeeIndexes](interfaces/FeeIndexes.md) -- [FeeTreeValues](interfaces/FeeTreeValues.md) -- [MethodFeeConfig](interfaces/MethodFeeConfig.md) -- [RuntimeFeeAnalyzerServiceConfig](interfaces/RuntimeFeeAnalyzerServiceConfig.md) -- [TransactionFeeHookConfig](interfaces/TransactionFeeHookConfig.md) - -## Type Aliases - -- [AdditionalSequencerModules](type-aliases/AdditionalSequencerModules.md) -- [InMemorySequencerModulesRecord](type-aliases/InMemorySequencerModulesRecord.md) -- [MinimalBalances](type-aliases/MinimalBalances.md) -- [MinimumAdditionalSequencerModules](type-aliases/MinimumAdditionalSequencerModules.md) -- [SimpleSequencerModulesRecord](type-aliases/SimpleSequencerModulesRecord.md) -- [SimpleSequencerWorkerModulesRecord](type-aliases/SimpleSequencerWorkerModulesRecord.md) -- [UIntConstructor](type-aliases/UIntConstructor.md) -- [VanillaProtocolModulesRecord](type-aliases/VanillaProtocolModulesRecord.md) -- [VanillaRuntimeModulesRecord](type-aliases/VanillaRuntimeModulesRecord.md) - -## Variables - -- [errors](variables/errors.md) -- [treeFeeHeight](variables/treeFeeHeight.md) diff --git a/src/pages/docs/reference/library/interfaces/BalancesEvents.md b/src/pages/docs/reference/library/interfaces/BalancesEvents.md index d656754..3177a80 100644 --- a/src/pages/docs/reference/library/interfaces/BalancesEvents.md +++ b/src/pages/docs/reference/library/interfaces/BalancesEvents.md @@ -10,7 +10,7 @@ title: BalancesEvents # Interface: BalancesEvents -Defined in: [packages/library/src/runtime/Balances.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L30) +Defined in: [packages/library/src/runtime/Balances.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L30) ## Extends @@ -26,4 +26,4 @@ Defined in: [packages/library/src/runtime/Balances.ts:30](https://github.com/pro > **setBalance**: \[[`BalancesKey`](../classes/BalancesKey.md), [`Balance`](../classes/Balance.md)\] -Defined in: [packages/library/src/runtime/Balances.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L31) +Defined in: [packages/library/src/runtime/Balances.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L31) diff --git a/src/pages/docs/reference/library/interfaces/FeeIndexes.md b/src/pages/docs/reference/library/interfaces/FeeIndexes.md index 1e180d5..ba1276f 100644 --- a/src/pages/docs/reference/library/interfaces/FeeIndexes.md +++ b/src/pages/docs/reference/library/interfaces/FeeIndexes.md @@ -10,7 +10,7 @@ title: FeeIndexes # Interface: FeeIndexes -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L28) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L28) ## Indexable diff --git a/src/pages/docs/reference/library/interfaces/FeeTreeValues.md b/src/pages/docs/reference/library/interfaces/FeeTreeValues.md index 2451999..6ccd649 100644 --- a/src/pages/docs/reference/library/interfaces/FeeTreeValues.md +++ b/src/pages/docs/reference/library/interfaces/FeeTreeValues.md @@ -10,7 +10,7 @@ title: FeeTreeValues # Interface: FeeTreeValues -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L24) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L24) ## Indexable diff --git a/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md b/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md index 533c827..f28d685 100644 --- a/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md +++ b/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md @@ -10,7 +10,7 @@ title: MethodFeeConfig # Interface: MethodFeeConfig -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L17) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L17) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:17](https:/ > **baseFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L19) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L19) *** @@ -26,7 +26,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:19](https:/ > **methodId**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L18) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L18) *** @@ -34,7 +34,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:18](https:/ > **perWeightUnitFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L20) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L20) *** @@ -42,4 +42,4 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:20](https:/ > **weight**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L21) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L21) diff --git a/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md b/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md index b0135fc..43cce2c 100644 --- a/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md +++ b/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md @@ -10,7 +10,7 @@ title: RuntimeFeeAnalyzerServiceConfig # Interface: RuntimeFeeAnalyzerServiceConfig -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L46) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L46) ## Extended by @@ -22,7 +22,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:46](https:/ > **baseFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) *** @@ -30,7 +30,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https:/ > **feeRecipient**: `string` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) *** @@ -38,7 +38,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https:/ > **methods**: `object` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) #### Index Signature @@ -50,7 +50,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https:/ > **perWeightUnitFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) *** @@ -58,4 +58,4 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https:/ > **tokenId**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) diff --git a/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md b/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md index 476128b..a1a62f1 100644 --- a/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md +++ b/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md @@ -10,7 +10,7 @@ title: TransactionFeeHookConfig # Interface: TransactionFeeHookConfig -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/TransactionFeeHook.ts#L33) +Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L33) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:33](https://github > **baseFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https:/ > **feeRecipient**: `string` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https:/ > **methods**: `object` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) #### Index Signature @@ -62,7 +62,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https:/ > **perWeightUnitFee**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https:/ > **tokenId**: `bigint` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) #### Inherited from diff --git a/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md b/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md index 0abcc8b..b2206cd 100644 --- a/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md +++ b/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md @@ -12,4 +12,4 @@ title: AdditionalSequencerModules > **AdditionalSequencerModules**: [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) & [`MinimumAdditionalSequencerModules`](MinimumAdditionalSequencerModules.md) -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L36) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L36) diff --git a/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md index c491bb6..c6db9f6 100644 --- a/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md +++ b/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md @@ -12,7 +12,7 @@ title: InMemorySequencerModulesRecord > **InMemorySequencerModulesRecord**: `object` -Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/InMemorySequencerModules.ts#L16) +Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/InMemorySequencerModules.ts#L18) ## Type declaration diff --git a/src/pages/docs/reference/library/type-aliases/MinimalBalances.md b/src/pages/docs/reference/library/type-aliases/MinimalBalances.md index 05cc804..522dd42 100644 --- a/src/pages/docs/reference/library/type-aliases/MinimalBalances.md +++ b/src/pages/docs/reference/library/type-aliases/MinimalBalances.md @@ -12,7 +12,7 @@ title: MinimalBalances > **MinimalBalances**: `object` -Defined in: [packages/library/src/runtime/Balances.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L34) +Defined in: [packages/library/src/runtime/Balances.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L34) ## Type declaration diff --git a/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md b/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md index f072c75..e19a11e 100644 --- a/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md +++ b/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md @@ -12,7 +12,7 @@ title: MinimumAdditionalSequencerModules > **MinimumAdditionalSequencerModules**: `object` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L26) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L26) ## Type declaration diff --git a/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md index 4e73e0e..36c61a5 100644 --- a/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md +++ b/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md @@ -12,4 +12,4 @@ title: SimpleSequencerModulesRecord > **SimpleSequencerModulesRecord**: [`MinimumAdditionalSequencerModules`](MinimumAdditionalSequencerModules.md) & `PreconfiguredSimpleSequencerModulesRecord` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L33) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L33) diff --git a/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md index 613fdd8..61966e6 100644 --- a/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md +++ b/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md @@ -12,7 +12,7 @@ title: SimpleSequencerWorkerModulesRecord > **SimpleSequencerWorkerModulesRecord**: `object` -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/sequencer/SimpleSequencerModules.ts#L39) +Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L39) ## Type declaration diff --git a/src/pages/docs/reference/library/type-aliases/UIntConstructor.md b/src/pages/docs/reference/library/type-aliases/UIntConstructor.md index f0aa99e..e909b53 100644 --- a/src/pages/docs/reference/library/type-aliases/UIntConstructor.md +++ b/src/pages/docs/reference/library/type-aliases/UIntConstructor.md @@ -12,7 +12,7 @@ title: UIntConstructor > **UIntConstructor**\<`BITS`\>: `object` -Defined in: [packages/library/src/math/UInt.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/math/UInt.ts#L24) +Defined in: [packages/library/src/math/UInt.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L24) ## Type Parameters diff --git a/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md b/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md index f04fabf..eb301f0 100644 --- a/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md +++ b/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md @@ -12,7 +12,7 @@ title: VanillaProtocolModulesRecord > **VanillaProtocolModulesRecord**: [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object` -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/protocol/VanillaProtocolModules.ts#L14) +Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L14) ## Type declaration diff --git a/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md b/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md index 42b9657..76ce19a 100644 --- a/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md +++ b/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md @@ -12,7 +12,7 @@ title: VanillaRuntimeModulesRecord > **VanillaRuntimeModulesRecord**: `object` -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/VanillaRuntimeModules.ts#L6) +Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/VanillaRuntimeModules.ts#L6) ## Type declaration diff --git a/src/pages/docs/reference/library/variables/errors.md b/src/pages/docs/reference/library/variables/errors.md index 53f1690..82b8a73 100644 --- a/src/pages/docs/reference/library/variables/errors.md +++ b/src/pages/docs/reference/library/variables/errors.md @@ -12,7 +12,7 @@ title: errors > `const` **errors**: `object` -Defined in: [packages/library/src/runtime/Balances.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/runtime/Balances.ts#L13) +Defined in: [packages/library/src/runtime/Balances.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L13) ## Type declaration diff --git a/src/pages/docs/reference/library/variables/treeFeeHeight.md b/src/pages/docs/reference/library/variables/treeFeeHeight.md index dddaab2..496d19e 100644 --- a/src/pages/docs/reference/library/variables/treeFeeHeight.md +++ b/src/pages/docs/reference/library/variables/treeFeeHeight.md @@ -12,4 +12,4 @@ title: treeFeeHeight > `const` **treeFeeHeight**: `10` = `10` -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L43) +Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L43) diff --git a/src/pages/docs/reference/module/classes/InMemoryStateService.md b/src/pages/docs/reference/module/classes/InMemoryStateService.md index 22ef17f..f2ce134 100644 --- a/src/pages/docs/reference/module/classes/InMemoryStateService.md +++ b/src/pages/docs/reference/module/classes/InMemoryStateService.md @@ -10,7 +10,7 @@ title: InMemoryStateService # Class: InMemoryStateService -Defined in: [module/src/state/InMemoryStateService.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/state/InMemoryStateService.ts#L7) +Defined in: [module/src/state/InMemoryStateService.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/state/InMemoryStateService.ts#L7) Naive implementation of an in-memory variant of the StateService interface @@ -39,7 +39,7 @@ Naive implementation of an in-memory variant of the StateService interface > **values**: `Record`\<`string`, `null` \| `Field`[]\> = `{}` -Defined in: [module/src/state/InMemoryStateService.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/state/InMemoryStateService.ts#L12) +Defined in: [module/src/state/InMemoryStateService.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/state/InMemoryStateService.ts#L12) This mapping container null values if the specific entry has been deleted. This is used by the CachedState service to keep track of deletions @@ -50,7 +50,7 @@ This is used by the CachedState service to keep track of deletions > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [module/src/state/InMemoryStateService.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/state/InMemoryStateService.ts#L14) +Defined in: [module/src/state/InMemoryStateService.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/state/InMemoryStateService.ts#L14) #### Parameters @@ -72,7 +72,7 @@ Defined in: [module/src/state/InMemoryStateService.ts:14](https://github.com/pro > **set**(`key`, `value`): `Promise`\<`void`\> -Defined in: [module/src/state/InMemoryStateService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/state/InMemoryStateService.ts#L18) +Defined in: [module/src/state/InMemoryStateService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/state/InMemoryStateService.ts#L18) #### Parameters diff --git a/src/pages/docs/reference/module/classes/MethodIdFactory.md b/src/pages/docs/reference/module/classes/MethodIdFactory.md index 3216e10..b1e9ee0 100644 --- a/src/pages/docs/reference/module/classes/MethodIdFactory.md +++ b/src/pages/docs/reference/module/classes/MethodIdFactory.md @@ -10,7 +10,7 @@ title: MethodIdFactory # Class: MethodIdFactory -Defined in: [module/src/factories/MethodIdFactory.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/factories/MethodIdFactory.ts#L5) +Defined in: [module/src/factories/MethodIdFactory.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/factories/MethodIdFactory.ts#L5) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -43,7 +43,7 @@ deps that are necessary for the sequencer to work. > **dependencies**(): `object` -Defined in: [module/src/factories/MethodIdFactory.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/factories/MethodIdFactory.ts#L6) +Defined in: [module/src/factories/MethodIdFactory.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/factories/MethodIdFactory.ts#L6) #### Returns diff --git a/src/pages/docs/reference/module/classes/MethodIdResolver.md b/src/pages/docs/reference/module/classes/MethodIdResolver.md index 2ca298e..189934f 100644 --- a/src/pages/docs/reference/module/classes/MethodIdResolver.md +++ b/src/pages/docs/reference/module/classes/MethodIdResolver.md @@ -10,7 +10,7 @@ title: MethodIdResolver # Class: MethodIdResolver -Defined in: [module/src/runtime/MethodIdResolver.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/MethodIdResolver.ts#L18) +Defined in: [module/src/runtime/MethodIdResolver.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/MethodIdResolver.ts#L18) Please see `getMethodId` to learn more about methodId encoding @@ -21,7 +21,7 @@ methodId encoding > **new MethodIdResolver**(`runtime`): [`MethodIdResolver`](MethodIdResolver.md) -Defined in: [module/src/runtime/MethodIdResolver.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/MethodIdResolver.ts#L23) +Defined in: [module/src/runtime/MethodIdResolver.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/MethodIdResolver.ts#L23) #### Parameters @@ -39,7 +39,7 @@ Defined in: [module/src/runtime/MethodIdResolver.ts:23](https://github.com/proto > **getMethodId**(`moduleName`, `methodName`): `bigint` -Defined in: [module/src/runtime/MethodIdResolver.ts:100](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/MethodIdResolver.ts#L100) +Defined in: [module/src/runtime/MethodIdResolver.ts:100](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/MethodIdResolver.ts#L100) #### Parameters @@ -61,7 +61,7 @@ Defined in: [module/src/runtime/MethodIdResolver.ts:100](https://github.com/prot > **getMethodNameFromId**(`methodId`): `undefined` \| \[`string`, `string`\] -Defined in: [module/src/runtime/MethodIdResolver.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/MethodIdResolver.ts#L86) +Defined in: [module/src/runtime/MethodIdResolver.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/MethodIdResolver.ts#L86) #### Parameters @@ -79,7 +79,7 @@ Defined in: [module/src/runtime/MethodIdResolver.ts:86](https://github.com/proto > **methodIdMap**(): [`RuntimeMethodIdMapping`](../../protocol/type-aliases/RuntimeMethodIdMapping.md) -Defined in: [module/src/runtime/MethodIdResolver.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/MethodIdResolver.ts#L47) +Defined in: [module/src/runtime/MethodIdResolver.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/MethodIdResolver.ts#L47) The purpose of this method is to provide a dictionary where we can look up properties like methodId and invocationType diff --git a/src/pages/docs/reference/module/classes/MethodParameterEncoder.md b/src/pages/docs/reference/module/classes/MethodParameterEncoder.md index 5ab2176..a2033ee 100644 --- a/src/pages/docs/reference/module/classes/MethodParameterEncoder.md +++ b/src/pages/docs/reference/module/classes/MethodParameterEncoder.md @@ -10,7 +10,7 @@ title: MethodParameterEncoder # Class: MethodParameterEncoder -Defined in: [module/src/method/MethodParameterEncoder.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L76) +Defined in: [module/src/method/MethodParameterEncoder.ts:110](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L110) ## Constructors @@ -18,7 +18,7 @@ Defined in: [module/src/method/MethodParameterEncoder.ts:76](https://github.com/ > **new MethodParameterEncoder**(`types`): [`MethodParameterEncoder`](MethodParameterEncoder.md) -Defined in: [module/src/method/MethodParameterEncoder.ts:120](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L120) +Defined in: [module/src/method/MethodParameterEncoder.ts:128](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L128) #### Parameters @@ -36,7 +36,7 @@ Defined in: [module/src/method/MethodParameterEncoder.ts:120](https://github.com > **decode**(`fields`, `auxiliary`): `Promise`\<`ArgArray`\> -Defined in: [module/src/method/MethodParameterEncoder.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L122) +Defined in: [module/src/method/MethodParameterEncoder.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L130) #### Parameters @@ -58,7 +58,7 @@ Defined in: [module/src/method/MethodParameterEncoder.ts:122](https://github.com > **encode**(`args`): `object` -Defined in: [module/src/method/MethodParameterEncoder.ts:184](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L184) +Defined in: [module/src/method/MethodParameterEncoder.ts:192](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L192) Variant of encode() for provable code that skips the unprovable json encoding @@ -87,7 +87,7 @@ json encoding > **fieldSize**(): `number` -Defined in: [module/src/method/MethodParameterEncoder.ts:246](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L246) +Defined in: [module/src/method/MethodParameterEncoder.ts:254](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L254) #### Returns @@ -99,7 +99,7 @@ Defined in: [module/src/method/MethodParameterEncoder.ts:246](https://github.com > `static` **fieldSize**(`type`): `undefined` \| `number` -Defined in: [module/src/method/MethodParameterEncoder.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L109) +Defined in: [module/src/method/MethodParameterEncoder.ts:117](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L117) #### Parameters @@ -117,7 +117,7 @@ Defined in: [module/src/method/MethodParameterEncoder.ts:109](https://github.com > `static` **fromMethod**(`target`, `methodName`): [`MethodParameterEncoder`](MethodParameterEncoder.md) -Defined in: [module/src/method/MethodParameterEncoder.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/MethodParameterEncoder.ts#L77) +Defined in: [module/src/method/MethodParameterEncoder.ts:111](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L111) #### Parameters diff --git a/src/pages/docs/reference/module/classes/Runtime.md b/src/pages/docs/reference/module/classes/Runtime.md index fc0cd19..48a1eff 100644 --- a/src/pages/docs/reference/module/classes/Runtime.md +++ b/src/pages/docs/reference/module/classes/Runtime.md @@ -10,7 +10,7 @@ title: Runtime # Class: Runtime\ -Defined in: [module/src/runtime/Runtime.ts:270](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L270) +Defined in: [module/src/runtime/Runtime.ts:270](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L270) Wrapper for an application specific runtime, which helps orchestrate runtime modules into an interoperable runtime. @@ -34,7 +34,7 @@ runtime modules into an interoperable runtime. > **new Runtime**\<`Modules`\>(`definition`): [`Runtime`](Runtime.md)\<`Modules`\> -Defined in: [module/src/runtime/Runtime.ts:296](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L296) +Defined in: [module/src/runtime/Runtime.ts:296](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L296) Creates a new Runtime from the provided config @@ -73,7 +73,7 @@ checks when retrieving it via the getter > **definition**: [`RuntimeDefinition`](../interfaces/RuntimeDefinition.md)\<`Modules`\> -Defined in: [module/src/runtime/Runtime.ts:287](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L287) +Defined in: [module/src/runtime/Runtime.ts:287](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L287) #### Overrides @@ -85,7 +85,7 @@ Defined in: [module/src/runtime/Runtime.ts:287](https://github.com/proto-kit/fra > `optional` **program**: `any` -Defined in: [module/src/runtime/Runtime.ts:285](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L285) +Defined in: [module/src/runtime/Runtime.ts:285](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L285) *** @@ -93,7 +93,7 @@ Defined in: [module/src/runtime/Runtime.ts:285](https://github.com/proto-kit/fra > **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> -Defined in: [module/src/runtime/Runtime.ts:289](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L289) +Defined in: [module/src/runtime/Runtime.ts:289](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L289) #### Implementation of @@ -107,7 +107,7 @@ Defined in: [module/src/runtime/Runtime.ts:289](https://github.com/proto-kit/fra > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [module/src/runtime/Runtime.ts:309](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L309) +Defined in: [module/src/runtime/Runtime.ts:309](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L309) ##### Returns @@ -177,7 +177,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:81 > **get** **dependencyContainer**(): `DependencyContainer` -Defined in: [module/src/runtime/Runtime.ts:330](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L330) +Defined in: [module/src/runtime/Runtime.ts:330](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L330) ##### Returns @@ -211,7 +211,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:99 > **get** **methodIdResolver**(): [`MethodIdResolver`](MethodIdResolver.md) -Defined in: [module/src/runtime/Runtime.ts:323](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L323) +Defined in: [module/src/runtime/Runtime.ts:323](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L323) ##### Returns @@ -249,7 +249,7 @@ list of module names > **get** **runtimeModuleNames**(): `string`[] -Defined in: [module/src/runtime/Runtime.ts:382](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L382) +Defined in: [module/src/runtime/Runtime.ts:382](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L382) ##### Returns @@ -265,7 +265,7 @@ A list of names of all the registered module names > **get** **stateService**(): [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) -Defined in: [module/src/runtime/Runtime.ts:319](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L319) +Defined in: [module/src/runtime/Runtime.ts:319](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L319) ##### Returns @@ -283,7 +283,7 @@ Defined in: [module/src/runtime/Runtime.ts:319](https://github.com/proto-kit/fra > **get** **stateServiceProvider**(): [`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) -Defined in: [module/src/runtime/Runtime.ts:313](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L313) +Defined in: [module/src/runtime/Runtime.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L313) ##### Returns @@ -347,7 +347,7 @@ using e.g. a for loop. > **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> -Defined in: [module/src/runtime/Runtime.ts:386](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L386) +Defined in: [module/src/runtime/Runtime.ts:386](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L386) #### Parameters @@ -419,7 +419,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:115 > **create**(`childContainerProvider`): `void` -Defined in: [module/src/runtime/Runtime.ts:303](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L303) +Defined in: [module/src/runtime/Runtime.ts:303](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L303) This is a placeholder for individual modules to override. This method will be called whenever the underlying container fully @@ -445,7 +445,7 @@ initialized > **decorateModule**(`moduleName`, `containedModule`): `void` -Defined in: [module/src/runtime/Runtime.ts:369](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L369) +Defined in: [module/src/runtime/Runtime.ts:369](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L369) Add a name and other respective properties required by RuntimeModules, that come from the current Runtime @@ -476,7 +476,7 @@ Name of the runtime module to decorate > **getMethodById**(`methodId`): `undefined` \| (...`args`) => `Promise`\<`unknown`\> -Defined in: [module/src/runtime/Runtime.ts:338](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L338) +Defined in: [module/src/runtime/Runtime.ts:338](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L338) #### Parameters @@ -765,7 +765,7 @@ such as only injecting other known modules. > `static` **from**\<`Modules`\>(`definition`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](Runtime.md)\<`Modules`\>\> -Defined in: [module/src/runtime/Runtime.ts:274](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L274) +Defined in: [module/src/runtime/Runtime.ts:274](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L274) #### Type Parameters diff --git a/src/pages/docs/reference/module/classes/RuntimeEvents.md b/src/pages/docs/reference/module/classes/RuntimeEvents.md index f48c3c5..5b67010 100644 --- a/src/pages/docs/reference/module/classes/RuntimeEvents.md +++ b/src/pages/docs/reference/module/classes/RuntimeEvents.md @@ -10,7 +10,7 @@ title: RuntimeEvents # Class: RuntimeEvents\ -Defined in: [module/src/runtime/RuntimeModule.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L25) +Defined in: [module/src/runtime/RuntimeModule.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L25) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:25](https://github.com/proto-ki > **new RuntimeEvents**\<`Events`\>(`events`): [`RuntimeEvents`](RuntimeEvents.md)\<`Events`\> -Defined in: [module/src/runtime/RuntimeModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L26) +Defined in: [module/src/runtime/RuntimeModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L26) #### Parameters @@ -40,7 +40,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:26](https://github.com/proto-ki > **emit**\<`Key`\>(`eventName`, `event`): `void` -Defined in: [module/src/runtime/RuntimeModule.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L47) +Defined in: [module/src/runtime/RuntimeModule.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L47) #### Type Parameters @@ -66,7 +66,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:47](https://github.com/proto-ki > **emitIf**\<`Key`\>(`condition`, `eventName`, `event`): `void` -Defined in: [module/src/runtime/RuntimeModule.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L28) +Defined in: [module/src/runtime/RuntimeModule.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L28) #### Type Parameters diff --git a/src/pages/docs/reference/module/classes/RuntimeModule.md b/src/pages/docs/reference/module/classes/RuntimeModule.md index 9aeb25e..de5b8cc 100644 --- a/src/pages/docs/reference/module/classes/RuntimeModule.md +++ b/src/pages/docs/reference/module/classes/RuntimeModule.md @@ -10,7 +10,7 @@ title: RuntimeModule # Class: RuntimeModule\ -Defined in: [module/src/runtime/RuntimeModule.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L59) +Defined in: [module/src/runtime/RuntimeModule.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L59) Base class for runtime modules providing the necessary utilities. @@ -33,7 +33,7 @@ Base class for runtime modules providing the necessary utilities. > **new RuntimeModule**\<`Config`\>(): [`RuntimeModule`](RuntimeModule.md)\<`Config`\> -Defined in: [module/src/runtime/RuntimeModule.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L82) +Defined in: [module/src/runtime/RuntimeModule.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L82) #### Returns @@ -64,7 +64,7 @@ checks when retrieving it via the getter > `optional` **events**: [`RuntimeEvents`](RuntimeEvents.md)\<`any`\> = `undefined` -Defined in: [module/src/runtime/RuntimeModule.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L80) +Defined in: [module/src/runtime/RuntimeModule.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L80) *** @@ -72,7 +72,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:80](https://github.com/proto-ki > **isRuntimeModule**: `boolean` = `true` -Defined in: [module/src/runtime/RuntimeModule.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L74) +Defined in: [module/src/runtime/RuntimeModule.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L74) This property exists only to typecheck that the RuntimeModule was extended correctly in e.g. a decorator. We need at least @@ -84,7 +84,7 @@ one non-optional property in this class to make the typechecking work. > `optional` **name**: `string` -Defined in: [module/src/runtime/RuntimeModule.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L76) +Defined in: [module/src/runtime/RuntimeModule.ts:76](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L76) *** @@ -92,7 +92,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:76](https://github.com/proto-ki > `optional` **runtime**: [`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md) -Defined in: [module/src/runtime/RuntimeModule.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L78) +Defined in: [module/src/runtime/RuntimeModule.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L78) *** @@ -100,7 +100,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:78](https://github.com/proto-ki > `readonly` **runtimeMethodNames**: `string`[] = `[]` -Defined in: [module/src/runtime/RuntimeModule.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L67) +Defined in: [module/src/runtime/RuntimeModule.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L67) Holds all method names that are callable throw transactions @@ -110,7 +110,7 @@ Holds all method names that are callable throw transactions > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [module/src/runtime/RuntimeModule.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L62) +Defined in: [module/src/runtime/RuntimeModule.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L62) ## Accessors @@ -154,7 +154,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **get** **network**(): [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [module/src/runtime/RuntimeModule.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L109) +Defined in: [module/src/runtime/RuntimeModule.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L109) ##### Returns @@ -168,7 +168,7 @@ Defined in: [module/src/runtime/RuntimeModule.ts:109](https://github.com/proto-k > **get** **transaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) -Defined in: [module/src/runtime/RuntimeModule.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L105) +Defined in: [module/src/runtime/RuntimeModule.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L105) ##### Returns @@ -202,7 +202,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **getInputs**(): [`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) -Defined in: [module/src/runtime/RuntimeModule.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeModule.ts#L92) +Defined in: [module/src/runtime/RuntimeModule.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L92) #### Returns diff --git a/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md b/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md index 9c958d8..188e2b5 100644 --- a/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md +++ b/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md @@ -10,7 +10,7 @@ title: RuntimeZkProgrammable # Class: RuntimeZkProgrammable\ -Defined in: [module/src/runtime/Runtime.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L77) +Defined in: [module/src/runtime/Runtime.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L77) ## Extends @@ -26,7 +26,7 @@ Defined in: [module/src/runtime/Runtime.ts:77](https://github.com/proto-kit/fram > **new RuntimeZkProgrammable**\<`Modules`\>(`runtime`): [`RuntimeZkProgrammable`](RuntimeZkProgrammable.md)\<`Modules`\> -Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L80) +Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L80) #### Parameters @@ -48,7 +48,7 @@ Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/fram > **runtime**: [`Runtime`](Runtime.md)\<`Modules`\> -Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L80) +Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L80) ## Accessors @@ -58,7 +58,7 @@ Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/fram > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [module/src/runtime/Runtime.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L84) +Defined in: [module/src/runtime/Runtime.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L84) ##### Returns @@ -114,7 +114,7 @@ Defined in: common/dist/zkProgrammable/ZkProgrammable.d.ts:35 > **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\>[] -Defined in: [module/src/runtime/Runtime.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L88) +Defined in: [module/src/runtime/Runtime.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L88) #### Returns diff --git a/src/pages/docs/reference/module/functions/combineMethodName.md b/src/pages/docs/reference/module/functions/combineMethodName.md index 5e929c9..e1c6b70 100644 --- a/src/pages/docs/reference/module/functions/combineMethodName.md +++ b/src/pages/docs/reference/module/functions/combineMethodName.md @@ -12,7 +12,7 @@ title: combineMethodName > **combineMethodName**(`runtimeModuleName`, `methodName`): `string` -Defined in: [module/src/method/runtimeMethod.ts:163](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L163) +Defined in: [module/src/method/runtimeMethod.ts:166](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L166) ## Parameters diff --git a/src/pages/docs/reference/module/functions/getAllPropertyNames.md b/src/pages/docs/reference/module/functions/getAllPropertyNames.md index a6951ae..241d93a 100644 --- a/src/pages/docs/reference/module/functions/getAllPropertyNames.md +++ b/src/pages/docs/reference/module/functions/getAllPropertyNames.md @@ -12,7 +12,7 @@ title: getAllPropertyNames > **getAllPropertyNames**(`obj`): (`string` \| `symbol`)[] -Defined in: [module/src/runtime/Runtime.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L39) +Defined in: [module/src/runtime/Runtime.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L39) ## Parameters diff --git a/src/pages/docs/reference/module/functions/isRuntimeMethod.md b/src/pages/docs/reference/module/functions/isRuntimeMethod.md index bee55e9..7f0f7a6 100644 --- a/src/pages/docs/reference/module/functions/isRuntimeMethod.md +++ b/src/pages/docs/reference/module/functions/isRuntimeMethod.md @@ -12,7 +12,7 @@ title: isRuntimeMethod > **isRuntimeMethod**(`target`, `propertyKey`): `boolean` -Defined in: [module/src/method/runtimeMethod.ts:182](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L182) +Defined in: [module/src/method/runtimeMethod.ts:185](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L185) Checks the metadata of the provided runtime module and its method, to see if it has been decorated with @runtimeMethod() diff --git a/src/pages/docs/reference/module/functions/runtimeMessage.md b/src/pages/docs/reference/module/functions/runtimeMessage.md index 8feeac7..8f41ef7 100644 --- a/src/pages/docs/reference/module/functions/runtimeMessage.md +++ b/src/pages/docs/reference/module/functions/runtimeMessage.md @@ -12,7 +12,7 @@ title: runtimeMessage > **runtimeMessage**(): (`target`, `methodName`, `descriptor`) => `void` -Defined in: [module/src/method/runtimeMethod.ts:297](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L297) +Defined in: [module/src/method/runtimeMethod.ts:298](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L298) ## Returns diff --git a/src/pages/docs/reference/module/functions/runtimeMethod.md b/src/pages/docs/reference/module/functions/runtimeMethod.md index ad0ed78..783550e 100644 --- a/src/pages/docs/reference/module/functions/runtimeMethod.md +++ b/src/pages/docs/reference/module/functions/runtimeMethod.md @@ -12,7 +12,7 @@ title: runtimeMethod > **runtimeMethod**(): (`target`, `methodName`, `descriptor`) => `void` -Defined in: [module/src/method/runtimeMethod.ts:303](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L303) +Defined in: [module/src/method/runtimeMethod.ts:304](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L304) ## Returns diff --git a/src/pages/docs/reference/module/functions/runtimeModule.md b/src/pages/docs/reference/module/functions/runtimeModule.md index 95bdab2..e501704 100644 --- a/src/pages/docs/reference/module/functions/runtimeModule.md +++ b/src/pages/docs/reference/module/functions/runtimeModule.md @@ -12,7 +12,7 @@ title: runtimeModule > **runtimeModule**(): (`target`) => `void` -Defined in: [module/src/module/decorator.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/module/decorator.ts#L10) +Defined in: [module/src/module/decorator.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/module/decorator.ts#L10) Marks the decorated class as a runtime module, while also making it injectable with our dependency injection solution. diff --git a/src/pages/docs/reference/module/functions/state.md b/src/pages/docs/reference/module/functions/state.md index e6b5c64..a21e2c2 100644 --- a/src/pages/docs/reference/module/functions/state.md +++ b/src/pages/docs/reference/module/functions/state.md @@ -12,7 +12,7 @@ title: state > **state**(): \<`TargetRuntimeModule`\>(`target`, `propertyKey`) => `void` -Defined in: [module/src/state/decorator.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/state/decorator.ts#L23) +Defined in: [module/src/state/decorator.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/state/decorator.ts#L23) Decorates a runtime module property as state, passing down some underlying values to improve developer experience. diff --git a/src/pages/docs/reference/module/functions/toEventsHash.md b/src/pages/docs/reference/module/functions/toEventsHash.md index a0a1e9c..f79381a 100644 --- a/src/pages/docs/reference/module/functions/toEventsHash.md +++ b/src/pages/docs/reference/module/functions/toEventsHash.md @@ -12,7 +12,7 @@ title: toEventsHash > **toEventsHash**(`events`): `Field` -Defined in: [module/src/method/runtimeMethod.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L56) +Defined in: [module/src/method/runtimeMethod.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L59) ## Parameters diff --git a/src/pages/docs/reference/module/functions/toStateTransitionsHash.md b/src/pages/docs/reference/module/functions/toStateTransitionsHash.md index 1d15b32..9015968 100644 --- a/src/pages/docs/reference/module/functions/toStateTransitionsHash.md +++ b/src/pages/docs/reference/module/functions/toStateTransitionsHash.md @@ -12,7 +12,7 @@ title: toStateTransitionsHash > **toStateTransitionsHash**(`stateTransitions`): `Field` -Defined in: [module/src/method/runtimeMethod.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L39) +Defined in: [module/src/method/runtimeMethod.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L42) ## Parameters diff --git a/src/pages/docs/reference/module/functions/toWrappedMethod.md b/src/pages/docs/reference/module/functions/toWrappedMethod.md index 3dcaeca..ecc1982 100644 --- a/src/pages/docs/reference/module/functions/toWrappedMethod.md +++ b/src/pages/docs/reference/module/functions/toWrappedMethod.md @@ -12,7 +12,7 @@ title: toWrappedMethod > **toWrappedMethod**(`this`, `methodName`, `moduleMethod`, `options`): [`AsyncWrappedMethod`](../type-aliases/AsyncWrappedMethod.md) -Defined in: [module/src/method/runtimeMethod.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L76) +Defined in: [module/src/method/runtimeMethod.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L79) ## Parameters diff --git a/src/pages/docs/reference/module/globals.md b/src/pages/docs/reference/module/globals.md index f295080..0dfd984 100644 --- a/src/pages/docs/reference/module/globals.md +++ b/src/pages/docs/reference/module/globals.md @@ -41,8 +41,10 @@ title: "@proto-kit/module" ## Functions +- [checkArgsProvable](functions/checkArgsProvable.md) - [combineMethodName](functions/combineMethodName.md) - [getAllPropertyNames](functions/getAllPropertyNames.md) +- [isFlexibleProvablePure](functions/isFlexibleProvablePure.md) - [isRuntimeMethod](functions/isRuntimeMethod.md) - [runtimeMessage](functions/runtimeMessage.md) - [runtimeMethod](functions/runtimeMethod.md) diff --git a/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md b/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md index 0d8b0c4..cb83c1d 100644 --- a/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md +++ b/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md @@ -10,7 +10,7 @@ title: RuntimeDefinition # Interface: RuntimeDefinition\ -Defined in: [module/src/runtime/Runtime.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L72) +Defined in: [module/src/runtime/Runtime.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L72) Definition / required arguments for the Runtime class @@ -24,7 +24,7 @@ Definition / required arguments for the Runtime class > `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> -Defined in: [module/src/runtime/Runtime.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L74) +Defined in: [module/src/runtime/Runtime.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L74) *** @@ -32,4 +32,4 @@ Defined in: [module/src/runtime/Runtime.ts:74](https://github.com/proto-kit/fram > **modules**: `Modules` -Defined in: [module/src/runtime/Runtime.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L73) +Defined in: [module/src/runtime/Runtime.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L73) diff --git a/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md b/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md index ef07640..05a3c98 100644 --- a/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md +++ b/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md @@ -10,7 +10,7 @@ title: RuntimeEnvironment # Interface: RuntimeEnvironment -Defined in: [module/src/runtime/RuntimeEnvironment.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeEnvironment.ts#L10) +Defined in: [module/src/runtime/RuntimeEnvironment.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeEnvironment.ts#L10) ## Extends @@ -36,7 +36,7 @@ Defined in: common/dist/zkProgrammable/ZkProgrammable.d.ts:38 > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [module/src/runtime/RuntimeEnvironment.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeEnvironment.ts#L12) +Defined in: [module/src/runtime/RuntimeEnvironment.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeEnvironment.ts#L12) ##### Returns @@ -50,7 +50,7 @@ Defined in: [module/src/runtime/RuntimeEnvironment.ts:12](https://github.com/pro > **get** **methodIdResolver**(): [`MethodIdResolver`](../classes/MethodIdResolver.md) -Defined in: [module/src/runtime/RuntimeEnvironment.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeEnvironment.ts#L15) +Defined in: [module/src/runtime/RuntimeEnvironment.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeEnvironment.ts#L15) ##### Returns @@ -64,7 +64,7 @@ Defined in: [module/src/runtime/RuntimeEnvironment.ts:15](https://github.com/pro > **get** **stateService**(): [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) -Defined in: [module/src/runtime/RuntimeEnvironment.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeEnvironment.ts#L13) +Defined in: [module/src/runtime/RuntimeEnvironment.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeEnvironment.ts#L13) ##### Returns @@ -78,7 +78,7 @@ Defined in: [module/src/runtime/RuntimeEnvironment.ts:13](https://github.com/pro > **get** **stateServiceProvider**(): [`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) -Defined in: [module/src/runtime/RuntimeEnvironment.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/RuntimeEnvironment.ts#L14) +Defined in: [module/src/runtime/RuntimeEnvironment.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeEnvironment.ts#L14) ##### Returns diff --git a/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md b/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md index 65f9ddf..e273bca 100644 --- a/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md +++ b/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md @@ -12,7 +12,7 @@ title: AsyncWrappedMethod > **AsyncWrappedMethod**: (...`args`) => `Promise`\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> -Defined in: [module/src/method/runtimeMethod.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L72) +Defined in: [module/src/method/runtimeMethod.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L75) ## Parameters diff --git a/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md b/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md index 35b9cea..4905505 100644 --- a/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md +++ b/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md @@ -12,4 +12,4 @@ title: RuntimeMethodInvocationType > **RuntimeMethodInvocationType**: `"SIGNATURE"` \| `"INCOMING_MESSAGE"` -Defined in: [module/src/method/runtimeMethod.ts:191](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L191) +Defined in: [module/src/method/runtimeMethod.ts:194](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L194) diff --git a/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md b/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md index fc46ac7..dca01ad 100644 --- a/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md +++ b/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md @@ -12,7 +12,7 @@ title: RuntimeModulesRecord > **RuntimeModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\>\>\> -Defined in: [module/src/runtime/Runtime.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/runtime/Runtime.ts#L60) +Defined in: [module/src/runtime/Runtime.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L60) Record of modules accepted by the Runtime module container. diff --git a/src/pages/docs/reference/module/type-aliases/WrappedMethod.md b/src/pages/docs/reference/module/type-aliases/WrappedMethod.md index 184f65f..3133999 100644 --- a/src/pages/docs/reference/module/type-aliases/WrappedMethod.md +++ b/src/pages/docs/reference/module/type-aliases/WrappedMethod.md @@ -12,7 +12,7 @@ title: WrappedMethod > **WrappedMethod**: (...`args`) => [`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md) -Defined in: [module/src/method/runtimeMethod.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L71) +Defined in: [module/src/method/runtimeMethod.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L74) ## Parameters diff --git a/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md index 34d5e75..1f14745 100644 --- a/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md +++ b/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md @@ -12,4 +12,4 @@ title: runtimeMethodMetadataKey > `const` **runtimeMethodMetadataKey**: `"yab-method"` = `"yab-method"` -Defined in: [module/src/method/runtimeMethod.ts:170](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L170) +Defined in: [module/src/method/runtimeMethod.ts:173](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L173) diff --git a/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md index 33a0890..62c978e 100644 --- a/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md +++ b/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md @@ -12,4 +12,4 @@ title: runtimeMethodNamesMetadataKey > `const` **runtimeMethodNamesMetadataKey**: `"proto-kit-runtime-methods"` = `"proto-kit-runtime-methods"` -Defined in: [module/src/method/runtimeMethod.ts:171](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L171) +Defined in: [module/src/method/runtimeMethod.ts:174](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L174) diff --git a/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md index 8e155ad..c514ffc 100644 --- a/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md +++ b/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md @@ -12,4 +12,4 @@ title: runtimeMethodTypeMetadataKey > `const` **runtimeMethodTypeMetadataKey**: `"proto-kit-runtime-method-type"` = `"proto-kit-runtime-method-type"` -Defined in: [module/src/method/runtimeMethod.ts:172](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/module/src/method/runtimeMethod.ts#L172) +Defined in: [module/src/method/runtimeMethod.ts:175](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L175) diff --git a/src/pages/docs/reference/persistance/_meta.tsx b/src/pages/docs/reference/persistance/_meta.tsx index 9304eb2..62983bf 100644 --- a/src/pages/docs/reference/persistance/_meta.tsx +++ b/src/pages/docs/reference/persistance/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases" + "README": "Overview","classes": "Classes","interfaces": "Interfaces","type-aliases": "Type Aliases" }; \ No newline at end of file diff --git a/src/pages/docs/reference/persistance/classes/BatchMapper.md b/src/pages/docs/reference/persistance/classes/BatchMapper.md index ba15ea5..a08040b 100644 --- a/src/pages/docs/reference/persistance/classes/BatchMapper.md +++ b/src/pages/docs/reference/persistance/classes/BatchMapper.md @@ -10,7 +10,7 @@ title: BatchMapper # Class: BatchMapper -Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L9) +Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L9) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:9]( > **mapIn**(`input`): [`Batch`](../../sequencer/interfaces/Batch.md) -Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L12) +Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L12) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:12] > **mapOut**(`input`): \[\{ `height`: `number`; `proof`: `JsonValue`; `settlementTransactionHash`: `null` \| `string`; \}, `string`[]\] -Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L20) +Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L20) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/BlockMapper.md b/src/pages/docs/reference/persistance/classes/BlockMapper.md index 82e9f3d..efd4113 100644 --- a/src/pages/docs/reference/persistance/classes/BlockMapper.md +++ b/src/pages/docs/reference/persistance/classes/BlockMapper.md @@ -10,7 +10,7 @@ title: BlockMapper # Class: BlockMapper -Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L10) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L10) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:10] > **mapIn**(`input`): [`Block`](../../sequencer/interfaces/Block.md) -Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L11) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L11) #### Parameters @@ -100,7 +100,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:11] > **mapOut**(`input`): `object` -Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L40) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L40) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/BlockResultMapper.md b/src/pages/docs/reference/persistance/classes/BlockResultMapper.md index c527c47..9eeb038 100644 --- a/src/pages/docs/reference/persistance/classes/BlockResultMapper.md +++ b/src/pages/docs/reference/persistance/classes/BlockResultMapper.md @@ -10,7 +10,7 @@ title: BlockResultMapper # Class: BlockResultMapper -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L11) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L11) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper. > **new BlockResultMapper**(`stArrayMapper`): [`BlockResultMapper`](BlockResultMapper.md) -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L14) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L14) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper. > **mapIn**(`input`): [`BlockResult`](../../sequencer/interfaces/BlockResult.md) -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L18) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L18) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper. > **mapOut**(`input`): `object` -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L38) +Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L38) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/FieldMapper.md b/src/pages/docs/reference/persistance/classes/FieldMapper.md index 392fb2e..f397062 100644 --- a/src/pages/docs/reference/persistance/classes/FieldMapper.md +++ b/src/pages/docs/reference/persistance/classes/FieldMapper.md @@ -10,7 +10,7 @@ title: FieldMapper # Class: FieldMapper -Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L7) +Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L7) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:7]( > **mapIn**(`input`): `Field`[] -Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L8) +Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L8) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:8]( > **mapOut**(`input`): `string` -Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L12) +Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L12) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md b/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md index 2b4cd9c..13da3ce 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md +++ b/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md @@ -10,7 +10,7 @@ title: PrismaBatchStore # Class: PrismaBatchStore -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L14) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L14) ## Implements @@ -23,7 +23,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:14](ht > **new PrismaBatchStore**(`connection`, `batchMapper`): [`PrismaBatchStore`](PrismaBatchStore.md) -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L15) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L15) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:15](ht > **getBatchAt**(`height`): `Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L20) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L20) #### Parameters @@ -67,7 +67,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:20](ht > **getCurrentBatchHeight**(): `Promise`\<`number`\> -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L42) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L42) #### Returns @@ -83,7 +83,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:42](ht > **getLatestBatch**(): `Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L71) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L71) #### Returns @@ -99,7 +99,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:71](ht > **pushBatch**(`batch`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L51) +Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L51) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md b/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md index abcb480..4deef1c 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md +++ b/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md @@ -10,7 +10,7 @@ title: PrismaBlockStorage # Class: PrismaBlockStorage -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L30) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L30) ## Implements @@ -24,7 +24,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:30]( > **new PrismaBlockStorage**(`connection`, `transactionResultMapper`, `transactionMapper`, `blockResultMapper`, `blockMapper`): [`PrismaBlockStorage`](PrismaBlockStorage.md) -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L33) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L33) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:33]( > **getBlock**(`hash`): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L77) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L77) #### Parameters @@ -80,7 +80,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:77]( > **getBlockAt**(`height`): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L73) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L73) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:73]( > **getCurrentBlockHeight**(): `Promise`\<`number`\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:157](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L157) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:157](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L157) #### Returns @@ -118,7 +118,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:157] > **getLatestBlock**(): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:185](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L185) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:185](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L185) #### Returns @@ -134,7 +134,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:185] > **getLatestBlockAndResult**(): `Promise`\<`undefined` \| [`BlockWithMaybeResult`](../../sequencer/interfaces/BlockWithMaybeResult.md)\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:167](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L167) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:167](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L167) #### Returns @@ -150,7 +150,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:167] > **getNewBlocks**(): `Promise`\<[`BlockWithPreviousResult`](../../sequencer/interfaces/BlockWithPreviousResult.md)[]\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:201](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L201) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:201](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L201) #### Returns @@ -166,7 +166,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:201] > **pushBlock**(`block`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L81) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L81) #### Parameters @@ -188,7 +188,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:81]( > **pushResult**(`result`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:139](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L139) +Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:139](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L139) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md b/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md index 4b0d993..cb4e79a 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md +++ b/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md @@ -10,7 +10,7 @@ title: PrismaDatabaseConnection # Class: PrismaDatabaseConnection -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L37) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L37) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -115,7 +115,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **get** **prismaClient**(): `PrismaClient`\<`never`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L43) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L43) ##### Returns @@ -131,7 +131,7 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:43](https://gi > **close**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:137](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L137) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:137](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L137) #### Returns @@ -165,7 +165,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): [`OmitKeys`](../../common/type-aliases/OmitKeys.md)\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L50) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L50) #### Returns @@ -181,7 +181,7 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:50](https://gi > **executeInTransaction**(`f`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:141](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L141) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:141](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L141) #### Parameters @@ -199,7 +199,7 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:141](https://g > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L82) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L82) #### Returns @@ -211,7 +211,7 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:82](https://gi > **start**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:117](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L117) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:117](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L117) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md b/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md index ec1610a..d58e2d5 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md +++ b/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md @@ -10,7 +10,7 @@ title: PrismaMessageStorage # Class: PrismaMessageStorage -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L9) +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L9) Interface to store Messages previously fetched by a IncomingMessageadapter @@ -24,7 +24,7 @@ Interface to store Messages previously fetched by a IncomingMessageadapter > **new PrismaMessageStorage**(`connection`, `transactionMapper`): [`PrismaMessageStorage`](PrismaMessageStorage.md) -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L10) +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L10) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:10 > **getMessages**(`fromMessageHash`): `Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L15) +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L15) #### Parameters @@ -68,7 +68,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:15 > **pushMessages**(`fromMessageHash`, `toMessageHash`, `messages`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L44) +Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L44) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md b/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md index d530929..8bb7bb5 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md +++ b/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md @@ -10,7 +10,7 @@ title: PrismaRedisDatabase # Class: PrismaRedisDatabase -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L31) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L31) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -39,7 +39,7 @@ deps that are necessary for the sequencer to work. > **new PrismaRedisDatabase**(): [`PrismaRedisDatabase`](PrismaRedisDatabase.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L39) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L39) #### Returns @@ -70,7 +70,7 @@ checks when retrieving it via the getter > **prisma**: [`PrismaDatabaseConnection`](PrismaDatabaseConnection.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L35) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L35) *** @@ -78,7 +78,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:35](https://github. > **redis**: [`RedisConnectionModule`](RedisConnectionModule.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L37) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L37) *** @@ -134,7 +134,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L53) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L53) ##### Returns @@ -152,7 +152,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:53](https://github. > **get** **prismaClient**(): `PrismaClient`\<`never`\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L45) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L45) ##### Returns @@ -170,7 +170,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:45](https://github. > **get** **redisClient**(): `RedisClientType` -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L49) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L49) ##### Returns @@ -186,7 +186,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:49](https://github. > **close**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L78) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L78) #### Returns @@ -202,7 +202,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:78](https://github. > **create**(`childContainerProvider`): `void` -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L57) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L57) #### Parameters @@ -224,7 +224,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:57](https://github. > **dependencies**(): [`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L63) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L63) #### Returns @@ -240,7 +240,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:63](https://github. > **executeInTransaction**(`f`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L88) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L88) #### Parameters @@ -262,7 +262,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:88](https://github. > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L83) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L83) Prunes all data from the database connection. Note: This function should only be called immediately at startup, @@ -282,7 +282,7 @@ everything else will lead to unexpected behaviour and errors > **start**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L70) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L70) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md b/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md index 0c288f5..2326ab0 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md +++ b/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md @@ -10,7 +10,7 @@ title: PrismaSettlementStorage # Class: PrismaSettlementStorage -Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L9) +Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L9) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts > **new PrismaSettlementStorage**(`connection`, `settlementMapper`): [`PrismaSettlementStorage`](PrismaSettlementStorage.md) -Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L10) +Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L10) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts > **pushSettlement**(`settlement`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L15) +Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L15) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaStateService.md b/src/pages/docs/reference/persistance/classes/PrismaStateService.md index b0e7052..342cff8 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaStateService.md +++ b/src/pages/docs/reference/persistance/classes/PrismaStateService.md @@ -10,7 +10,7 @@ title: PrismaStateService # Class: PrismaStateService -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L16) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L16) This Interface should be implemented for services that store the state in an external storage (like a DB). This can be used in conjunction with @@ -26,7 +26,7 @@ CachedStateService to preload keys for In-Circuit usage. > **new PrismaStateService**(`connection`, `mask`): [`PrismaStateService`](PrismaStateService.md) -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L23) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L23) #### Parameters @@ -50,7 +50,7 @@ A indicator to which masking level the values belong > **commit**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L28) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L28) #### Returns @@ -66,7 +66,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:28]( > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L79) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L79) #### Parameters @@ -88,7 +88,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:79]( > **getMany**(`keys`): `Promise`\<[`StateEntry`](../../sequencer/interfaces/StateEntry.md)[]\> -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L54) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L54) #### Parameters @@ -110,7 +110,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:54]( > **openTransaction**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L75) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L75) #### Returns @@ -126,7 +126,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:75]( > **writeStates**(`entries`): `void` -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaStateService.ts#L84) +Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L84) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md b/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md index 497025c..e9d50ce 100644 --- a/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md +++ b/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md @@ -10,7 +10,7 @@ title: PrismaTransactionStorage # Class: PrismaTransactionStorage -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L9) +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L9) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.t > **new PrismaTransactionStorage**(`connection`, `transactionMapper`): [`PrismaTransactionStorage`](PrismaTransactionStorage.md) -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L10) +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L10) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.t > **findTransaction**(`hash`): `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md); \}\> -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L42) +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L42) Finds a transaction by its hash. It returns both pending transaction and already included transactions @@ -71,7 +71,7 @@ and batch number where applicable. > **getPendingUserTransactions**(): `Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L15) +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L15) #### Returns @@ -87,7 +87,7 @@ Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.t > **pushUserTransaction**(`tx`): `Promise`\<`boolean`\> -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L31) +Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L31) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md b/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md index 9ac8d4e..3b708e7 100644 --- a/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md +++ b/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md @@ -10,7 +10,7 @@ title: RedisConnectionModule # Class: RedisConnectionModule -Defined in: [packages/persistance/src/RedisConnection.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L24) +Defined in: [packages/persistance/src/RedisConnection.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L24) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -115,7 +115,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> -Defined in: [packages/persistance/src/RedisConnection.ts:91](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L91) +Defined in: [packages/persistance/src/RedisConnection.ts:91](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L91) ##### Returns @@ -133,7 +133,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:91](https://github.com/ > **get** **redisClient**(): `RedisClientType` -Defined in: [packages/persistance/src/RedisConnection.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L30) +Defined in: [packages/persistance/src/RedisConnection.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L30) ##### Returns @@ -149,7 +149,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:30](https://github.com/ > **clearDatabase**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L56) +Defined in: [packages/persistance/src/RedisConnection.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L56) #### Returns @@ -161,7 +161,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:56](https://github.com/ > **close**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L81) +Defined in: [packages/persistance/src/RedisConnection.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L81) #### Returns @@ -195,7 +195,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): `Pick`\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> -Defined in: [packages/persistance/src/RedisConnection.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L39) +Defined in: [packages/persistance/src/RedisConnection.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L39) #### Returns @@ -211,7 +211,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:39](https://github.com/ > **executeInTransaction**(`f`): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L98) +Defined in: [packages/persistance/src/RedisConnection.ts:98](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L98) #### Parameters @@ -229,7 +229,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:98](https://github.com/ > **init**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L60) +Defined in: [packages/persistance/src/RedisConnection.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L60) #### Returns @@ -241,7 +241,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:60](https://github.com/ > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L85) +Defined in: [packages/persistance/src/RedisConnection.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L85) #### Returns @@ -253,7 +253,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:85](https://github.com/ > **start**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/RedisConnection.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L77) +Defined in: [packages/persistance/src/RedisConnection.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L77) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md b/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md index a6edd2d..eefe398 100644 --- a/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md +++ b/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md @@ -10,7 +10,7 @@ title: RedisMerkleTreeStore # Class: RedisMerkleTreeStore -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L10) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L10) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:10] > **new RedisMerkleTreeStore**(`connection`, `mask`): [`RedisMerkleTreeStore`](RedisMerkleTreeStore.md) -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L13) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L13) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:13] > **commit**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L26) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L26) #### Returns @@ -60,7 +60,7 @@ Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:26] > **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L48) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L48) #### Parameters @@ -82,7 +82,7 @@ Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:48] > **openTransaction**(): `Promise`\<`void`\> -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L22) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L22) #### Returns @@ -98,7 +98,7 @@ Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:22] > **writeNodes**(`nodes`): `void` -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L62) +Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L62) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/SettlementMapper.md b/src/pages/docs/reference/persistance/classes/SettlementMapper.md index aa5ca7a..b3faeeb 100644 --- a/src/pages/docs/reference/persistance/classes/SettlementMapper.md +++ b/src/pages/docs/reference/persistance/classes/SettlementMapper.md @@ -10,7 +10,7 @@ title: SettlementMapper # Class: SettlementMapper -Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L8) +Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L8) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.t > **mapIn**(`input`): [`Settlement`](../../sequencer/interfaces/Settlement.md) -Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L11) +Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L11) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.t > **mapOut**(`input`): \[\{ `promisedMessagesHash`: `string`; `transactionHash`: `string`; \}, `number`[]\] -Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L21) +Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L21) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md b/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md index 28c3e00..9ac8518 100644 --- a/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md +++ b/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md @@ -10,7 +10,7 @@ title: StateTransitionArrayMapper # Class: StateTransitionArrayMapper -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L22) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L22) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMap > **new StateTransitionArrayMapper**(`stMapper`): [`StateTransitionArrayMapper`](StateTransitionArrayMapper.md) -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L26) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L26) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMap > **mapIn**(`input`): [`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md)[] -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L28) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L28) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMap > **mapOut**(`input`): `JsonValue` -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L39) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L39) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md b/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md index efd1ad2..71bb007 100644 --- a/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md +++ b/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md @@ -10,7 +10,7 @@ title: StateTransitionMapper # Class: StateTransitionMapper -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L8) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L8) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMap > **mapIn**(`input`): [`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md) -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L11) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L11) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMap > **mapOut**(`input`): `JsonObject` -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L16) +Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md b/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md index e14bfed..4fe9e0b 100644 --- a/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md +++ b/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md @@ -10,7 +10,7 @@ title: TransactionExecutionResultMapper # Class: TransactionExecutionResultMapper -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L49) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L49) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper. > **new TransactionExecutionResultMapper**(`transactionMapper`, `stArrayMapper`, `eventArrayMapper`): [`TransactionExecutionResultMapper`](TransactionExecutionResultMapper.md) -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L56) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L56) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper. > **mapIn**(`input`): [`TransactionExecutionResult`](../../sequencer/interfaces/TransactionExecutionResult.md) -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L62) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L62) #### Parameters @@ -70,7 +70,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper. > **mapOut**(`input`): \[`Omit`\<\{ `blockHash`: `string`; `events`: `JsonValue`; `protocolTransitions`: `JsonValue`; `stateTransitions`: `JsonValue`; `status`: `boolean`; `statusMessage`: `null` \| `string`; `txHash`: `string`; \}, `"blockHash"`\>, \{ `argsFields`: `string`[]; `auxiliaryData`: `string`[]; `hash`: `string`; `isMessage`: `boolean`; `methodId`: `string`; `nonce`: `string`; `sender`: `string`; `signature_r`: `string`; `signature_s`: `string`; \}\] -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L80) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L80) #### Parameters diff --git a/src/pages/docs/reference/persistance/classes/TransactionMapper.md b/src/pages/docs/reference/persistance/classes/TransactionMapper.md index ae7acc4..9e276c9 100644 --- a/src/pages/docs/reference/persistance/classes/TransactionMapper.md +++ b/src/pages/docs/reference/persistance/classes/TransactionMapper.md @@ -10,7 +10,7 @@ title: TransactionMapper # Class: TransactionMapper -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L19) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L19) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper. > **mapIn**(`input`): [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L22) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L22) #### Parameters @@ -88,7 +88,7 @@ Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper. > **mapOut**(`input`): `object` -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L32) +Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L32) #### Parameters diff --git a/src/pages/docs/reference/persistance/globals.md b/src/pages/docs/reference/persistance/globals.md deleted file mode 100644 index 4ad8e34..0000000 --- a/src/pages/docs/reference/persistance/globals.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "@proto-kit/persistance" ---- - -[**@proto-kit/persistance**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/persistance - -# @proto-kit/persistance - -## Classes - -- [BatchMapper](classes/BatchMapper.md) -- [BlockMapper](classes/BlockMapper.md) -- [BlockResultMapper](classes/BlockResultMapper.md) -- [FieldMapper](classes/FieldMapper.md) -- [PrismaBatchStore](classes/PrismaBatchStore.md) -- [PrismaBlockStorage](classes/PrismaBlockStorage.md) -- [PrismaDatabaseConnection](classes/PrismaDatabaseConnection.md) -- [PrismaMessageStorage](classes/PrismaMessageStorage.md) -- [PrismaRedisDatabase](classes/PrismaRedisDatabase.md) -- [PrismaSettlementStorage](classes/PrismaSettlementStorage.md) -- [PrismaStateService](classes/PrismaStateService.md) -- [PrismaTransactionStorage](classes/PrismaTransactionStorage.md) -- [RedisConnectionModule](classes/RedisConnectionModule.md) -- [RedisMerkleTreeStore](classes/RedisMerkleTreeStore.md) -- [SettlementMapper](classes/SettlementMapper.md) -- [StateTransitionArrayMapper](classes/StateTransitionArrayMapper.md) -- [StateTransitionMapper](classes/StateTransitionMapper.md) -- [TransactionExecutionResultMapper](classes/TransactionExecutionResultMapper.md) -- [TransactionMapper](classes/TransactionMapper.md) - -## Interfaces - -- [PrismaConnection](interfaces/PrismaConnection.md) -- [PrismaDatabaseConfig](interfaces/PrismaDatabaseConfig.md) -- [PrismaRedisCombinedConfig](interfaces/PrismaRedisCombinedConfig.md) -- [RedisConnection](interfaces/RedisConnection.md) -- [RedisConnectionConfig](interfaces/RedisConnectionConfig.md) - -## Type Aliases - -- [RedisTransaction](type-aliases/RedisTransaction.md) diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md b/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md index a6e230e..520e68a 100644 --- a/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md +++ b/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md @@ -10,7 +10,7 @@ title: PrismaConnection # Interface: PrismaConnection -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L32) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L32) ## Accessors @@ -20,7 +20,7 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:32](https://gi > **get** **prismaClient**(): `PrismaClient`\<`never`\> -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L33) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L33) ##### Returns diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md b/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md index e56a68e..bfdf8f2 100644 --- a/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md +++ b/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md @@ -10,7 +10,7 @@ title: PrismaDatabaseConfig # Interface: PrismaDatabaseConfig -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L16) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L16) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:16](https://gi > `optional` **connection**: `string` \| \{ `db`: \{ `name`: `string`; `schema`: `string`; \}; `host`: `string`; `password`: `string`; `port`: `number`; `username`: `string`; \} -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaDatabaseConnection.ts#L18) +Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L18) diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md b/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md index fb158ed..9349020 100644 --- a/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md +++ b/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md @@ -10,7 +10,7 @@ title: PrismaRedisCombinedConfig # Interface: PrismaRedisCombinedConfig -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L24) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L24) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:24](https://github. > **prisma**: [`PrismaDatabaseConfig`](PrismaDatabaseConfig.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L25) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L25) *** @@ -26,4 +26,4 @@ Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:25](https://github. > **redis**: [`RedisConnectionConfig`](RedisConnectionConfig.md) -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/PrismaRedisDatabase.ts#L26) +Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L26) diff --git a/src/pages/docs/reference/persistance/interfaces/RedisConnection.md b/src/pages/docs/reference/persistance/interfaces/RedisConnection.md index eca65b9..a3581e1 100644 --- a/src/pages/docs/reference/persistance/interfaces/RedisConnection.md +++ b/src/pages/docs/reference/persistance/interfaces/RedisConnection.md @@ -10,7 +10,7 @@ title: RedisConnection # Interface: RedisConnection -Defined in: [packages/persistance/src/RedisConnection.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L19) +Defined in: [packages/persistance/src/RedisConnection.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L19) ## Accessors @@ -20,7 +20,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:19](https://github.com/ > **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> -Defined in: [packages/persistance/src/RedisConnection.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L21) +Defined in: [packages/persistance/src/RedisConnection.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L21) ##### Returns @@ -34,7 +34,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:21](https://github.com/ > **get** **redisClient**(): `RedisClientType` -Defined in: [packages/persistance/src/RedisConnection.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L20) +Defined in: [packages/persistance/src/RedisConnection.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L20) ##### Returns diff --git a/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md b/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md index 1e2e23f..86ee13e 100644 --- a/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md +++ b/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md @@ -10,7 +10,7 @@ title: RedisConnectionConfig # Interface: RedisConnectionConfig -Defined in: [packages/persistance/src/RedisConnection.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L10) +Defined in: [packages/persistance/src/RedisConnection.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L10) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:10](https://github.com/ > **host**: `string` -Defined in: [packages/persistance/src/RedisConnection.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L11) +Defined in: [packages/persistance/src/RedisConnection.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L11) *** @@ -26,7 +26,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:11](https://github.com/ > `optional` **password**: `string` -Defined in: [packages/persistance/src/RedisConnection.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L12) +Defined in: [packages/persistance/src/RedisConnection.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L12) *** @@ -34,7 +34,7 @@ Defined in: [packages/persistance/src/RedisConnection.ts:12](https://github.com/ > `optional` **port**: `number` -Defined in: [packages/persistance/src/RedisConnection.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L13) +Defined in: [packages/persistance/src/RedisConnection.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L13) *** @@ -42,4 +42,4 @@ Defined in: [packages/persistance/src/RedisConnection.ts:13](https://github.com/ > `optional` **username**: `string` -Defined in: [packages/persistance/src/RedisConnection.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L14) +Defined in: [packages/persistance/src/RedisConnection.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L14) diff --git a/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md b/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md index 6c96173..f6f938c 100644 --- a/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md +++ b/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md @@ -12,4 +12,4 @@ title: RedisTransaction > **RedisTransaction**: `ReturnType`\<`RedisClientType`\[`"multi"`\]\> -Defined in: [packages/persistance/src/RedisConnection.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/persistance/src/RedisConnection.ts#L17) +Defined in: [packages/persistance/src/RedisConnection.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L17) diff --git a/src/pages/docs/reference/processor/_meta.tsx b/src/pages/docs/reference/processor/_meta.tsx index b6944c5..a31554d 100644 --- a/src/pages/docs/reference/processor/_meta.tsx +++ b/src/pages/docs/reference/processor/_meta.tsx @@ -1,3 +1,3 @@ export default { - "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases" + "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" }; \ No newline at end of file diff --git a/src/pages/docs/reference/processor/classes/BlockFetching.md b/src/pages/docs/reference/processor/classes/BlockFetching.md index cd2ff33..a523180 100644 --- a/src/pages/docs/reference/processor/classes/BlockFetching.md +++ b/src/pages/docs/reference/processor/classes/BlockFetching.md @@ -10,7 +10,7 @@ title: BlockFetching # Class: BlockFetching -Defined in: [packages/processor/src/indexer/BlockFetching.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L36) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L36) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new BlockFetching**(`blockMapper`, `blockResultMapper`, `transactionResultMapper`): [`BlockFetching`](BlockFetching.md) -Defined in: [packages/processor/src/indexer/BlockFetching.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L37) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L37) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/processor/src/indexer/BlockFetching.ts:37](https://github. > **blockMapper**: [`BlockMapper`](../../persistance/classes/BlockMapper.md) -Defined in: [packages/processor/src/indexer/BlockFetching.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L38) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L38) *** @@ -62,7 +62,7 @@ Defined in: [packages/processor/src/indexer/BlockFetching.ts:38](https://github. > **blockResultMapper**: [`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) -Defined in: [packages/processor/src/indexer/BlockFetching.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L39) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L39) *** @@ -85,7 +85,7 @@ checks when retrieving it via the getter > **transactionResultMapper**: [`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) -Defined in: [packages/processor/src/indexer/BlockFetching.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L40) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L40) ## Accessors @@ -149,7 +149,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **fetchBlock**(`height`): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> -Defined in: [packages/processor/src/indexer/BlockFetching.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L45) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L45) #### Parameters @@ -167,7 +167,7 @@ Defined in: [packages/processor/src/indexer/BlockFetching.ts:45](https://github. > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/indexer/BlockFetching.ts:146](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L146) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:146](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L146) #### Returns diff --git a/src/pages/docs/reference/processor/classes/Database.md b/src/pages/docs/reference/processor/classes/Database.md index 3967dc3..4d413a0 100644 --- a/src/pages/docs/reference/processor/classes/Database.md +++ b/src/pages/docs/reference/processor/classes/Database.md @@ -10,7 +10,7 @@ title: Database # Class: Database\ -Defined in: [packages/processor/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L11) +Defined in: [packages/processor/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L11) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -42,7 +42,7 @@ deps that are necessary for the sequencer to work. > **new Database**\<`PrismaClient`\>(`prismaClient`): [`Database`](Database.md)\<`PrismaClient`\> -Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L15) +Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L15) #### Parameters @@ -79,7 +79,7 @@ checks when retrieving it via the getter > **prismaClient**: `PrismaClient` -Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L15) +Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L15) #### Implementation of @@ -147,7 +147,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): `object` -Defined in: [packages/processor/src/storage/Database.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L29) +Defined in: [packages/processor/src/storage/Database.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L29) #### Returns @@ -171,7 +171,7 @@ Defined in: [packages/processor/src/storage/Database.ts:29](https://github.com/p > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/storage/Database.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L37) +Defined in: [packages/processor/src/storage/Database.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L37) #### Returns @@ -183,7 +183,7 @@ Defined in: [packages/processor/src/storage/Database.ts:37](https://github.com/p > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/storage/Database.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L50) +Defined in: [packages/processor/src/storage/Database.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L50) #### Returns @@ -199,7 +199,7 @@ Defined in: [packages/processor/src/storage/Database.ts:50](https://github.com/p > `static` **from**\<`PrismaClient`\>(`prismaClient`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Database`](Database.md)\<`PrismaClient`\>\> -Defined in: [packages/processor/src/storage/Database.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/Database.ts#L19) +Defined in: [packages/processor/src/storage/Database.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L19) #### Type Parameters diff --git a/src/pages/docs/reference/processor/classes/DatabasePruneModule.md b/src/pages/docs/reference/processor/classes/DatabasePruneModule.md index db3a1a5..aac2c5d 100644 --- a/src/pages/docs/reference/processor/classes/DatabasePruneModule.md +++ b/src/pages/docs/reference/processor/classes/DatabasePruneModule.md @@ -10,7 +10,7 @@ title: DatabasePruneModule # Class: DatabasePruneModule -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/DatabasePruneModule.ts#L14) +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/DatabasePruneModule.ts#L14) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new DatabasePruneModule**(`database`): [`DatabasePruneModule`](DatabasePruneModule.md) -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/DatabasePruneModule.ts#L15) +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/DatabasePruneModule.ts#L15) #### Parameters @@ -117,7 +117,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/DatabasePruneModule.ts#L21) +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/DatabasePruneModule.ts#L21) #### Returns diff --git a/src/pages/docs/reference/processor/classes/HandlersExecutor.md b/src/pages/docs/reference/processor/classes/HandlersExecutor.md index 5b92915..8fc6d2f 100644 --- a/src/pages/docs/reference/processor/classes/HandlersExecutor.md +++ b/src/pages/docs/reference/processor/classes/HandlersExecutor.md @@ -10,7 +10,7 @@ title: HandlersExecutor # Class: HandlersExecutor\ -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L28) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L28) Used by various module sub-types that may need to be configured @@ -59,7 +59,7 @@ checks when retrieving it via the getter > **database**: `undefined` \| `PrismaDatabaseConnection`\<`PrismaClient`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L36) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L36) *** @@ -67,7 +67,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:36](https://git > **handlers**: `undefined` \| `Handlers` -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L34) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L34) *** @@ -75,7 +75,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:34](https://git > **isExecuting**: `boolean` = `false` -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L32) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L32) ## Accessors @@ -117,7 +117,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **create**(`childContainerProvider`): `void` -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L38) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L38) #### Parameters @@ -139,7 +139,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:38](https://git > **execute**(`block`): `Promise`\<`void`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L83) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L83) #### Parameters @@ -157,7 +157,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:83](https://git > **onAfterHandlers**(`client`, `block`): `Promise`\<`void`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L72) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L72) #### Parameters @@ -179,7 +179,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:72](https://git > **onBlock**(`client`, `block`): `Promise`\<`void`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L60) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L60) #### Parameters @@ -201,7 +201,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:60](https://git > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L46) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L46) #### Returns @@ -217,7 +217,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:46](https://git > `static` **from**\<`PrismaClient`, `Handlers`\>(`handlers`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`HandlersExecutor`](HandlersExecutor.md)\<`PrismaClient`, `Handlers`\>\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L48) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L48) #### Type Parameters diff --git a/src/pages/docs/reference/processor/classes/Processor.md b/src/pages/docs/reference/processor/classes/Processor.md index de481af..7b1ca08 100644 --- a/src/pages/docs/reference/processor/classes/Processor.md +++ b/src/pages/docs/reference/processor/classes/Processor.md @@ -10,7 +10,7 @@ title: Processor # Class: Processor\ -Defined in: [packages/processor/src/Processor.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/Processor.ts#L15) +Defined in: [packages/processor/src/Processor.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/Processor.ts#L15) Reusable module container facilitating registration, resolution configuration, decoration and validation of modules @@ -560,7 +560,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/Processor.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/Processor.ts#L24) +Defined in: [packages/processor/src/Processor.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/Processor.ts#L24) #### Returns @@ -601,7 +601,7 @@ such as only injecting other known modules. > `static` **from**\<`Modules`\>(`definition`): [`Processor`](Processor.md)\<`Modules`\> -Defined in: [packages/processor/src/Processor.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/Processor.ts#L18) +Defined in: [packages/processor/src/Processor.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/Processor.ts#L18) #### Type Parameters diff --git a/src/pages/docs/reference/processor/classes/ProcessorModule.md b/src/pages/docs/reference/processor/classes/ProcessorModule.md index 4b65362..57dbf65 100644 --- a/src/pages/docs/reference/processor/classes/ProcessorModule.md +++ b/src/pages/docs/reference/processor/classes/ProcessorModule.md @@ -10,7 +10,7 @@ title: ProcessorModule # Class: `abstract` ProcessorModule\ -Defined in: [packages/processor/src/ProcessorModule.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/ProcessorModule.ts#L3) +Defined in: [packages/processor/src/ProcessorModule.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/ProcessorModule.ts#L3) Used by various module sub-types that may need to be configured @@ -121,7 +121,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `abstract` **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/ProcessorModule.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/ProcessorModule.ts#L6) +Defined in: [packages/processor/src/ProcessorModule.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/ProcessorModule.ts#L6) #### Returns diff --git a/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md b/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md index 8ed20a8..fae3674 100644 --- a/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md +++ b/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md @@ -10,7 +10,7 @@ title: ResolverFactoryGraphqlModule # Class: ResolverFactoryGraphqlModule\ -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L49) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L49) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new ResolverFactoryGraphqlModule**\<`PrismaClient`\>(`graphqlServer`): [`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\> -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) #### Parameters @@ -65,7 +65,7 @@ checks when retrieving it via the getter > **database**: `undefined` \| `PrismaDatabaseConnection`\<`PrismaClient`\> -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L62) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L62) *** @@ -73,7 +73,7 @@ Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:62](http > **graphqlServer**: [`GraphqlServer`](../../api/classes/GraphqlServer.md) -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) ## Accessors @@ -115,7 +115,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **create**(`childContainerProvider`): `void` -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L68) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L68) #### Parameters @@ -137,7 +137,7 @@ Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:68](http > **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L77) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L77) #### Returns @@ -153,7 +153,7 @@ Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:77](http > `static` **from**\<`PrismaClient`\>(`resolvers`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\>\> -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L52) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L52) #### Type Parameters diff --git a/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md b/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md index 47f5b0b..aa66cee 100644 --- a/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md +++ b/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md @@ -10,7 +10,7 @@ title: TimedProcessorTrigger # Class: TimedProcessorTrigger -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L15) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L15) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > **new TimedProcessorTrigger**(`blockStorage`, `blockFetching`, `handlersExecutor`): [`TimedProcessorTrigger`](TimedProcessorTrigger.md) -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L18) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L18) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:18](https: > **blockFetching**: [`BlockFetching`](BlockFetching.md) -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L20) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L20) *** @@ -62,7 +62,7 @@ Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:20](https: > **blockStorage**: `BlockStorage` -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L19) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L19) *** @@ -70,7 +70,7 @@ Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:19](https: > **catchingUp**: `boolean` = `false` -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L16) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L16) *** @@ -93,7 +93,7 @@ checks when retrieving it via the getter > **handlersExecutor**: [`HandlersExecutor`](HandlersExecutor.md)\<`BasePrismaClient`, [`HandlersRecord`](../interfaces/HandlersRecord.md)\<`BasePrismaClient`\>\> -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L22) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L22) ## Accessors @@ -135,7 +135,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **catchUp**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L61) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L61) #### Returns @@ -169,7 +169,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **processNextBlock**(): `Promise`\<`boolean`\> -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L30) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L30) #### Returns @@ -181,7 +181,7 @@ Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:30](https: > **start**(): `Promise`\<`void`\> -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L77) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L77) #### Returns diff --git a/src/pages/docs/reference/processor/functions/ValidateTakeArg.md b/src/pages/docs/reference/processor/functions/ValidateTakeArg.md index 8a002fb..91c2ad4 100644 --- a/src/pages/docs/reference/processor/functions/ValidateTakeArg.md +++ b/src/pages/docs/reference/processor/functions/ValidateTakeArg.md @@ -12,7 +12,7 @@ title: ValidateTakeArg > **ValidateTakeArg**(): `MethodDecorator` -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L34) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L34) ## Returns diff --git a/src/pages/docs/reference/processor/functions/cleanResolvers.md b/src/pages/docs/reference/processor/functions/cleanResolvers.md index 9b80f44..fda776b 100644 --- a/src/pages/docs/reference/processor/functions/cleanResolvers.md +++ b/src/pages/docs/reference/processor/functions/cleanResolvers.md @@ -12,7 +12,7 @@ title: cleanResolvers > **cleanResolvers**(`resolvers`): `NonEmptyArray`\<`Function`\> -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L12) +Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L12) ## Parameters diff --git a/src/pages/docs/reference/processor/globals.md b/src/pages/docs/reference/processor/globals.md deleted file mode 100644 index 1b6eb78..0000000 --- a/src/pages/docs/reference/processor/globals.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "@proto-kit/processor" ---- - -[**@proto-kit/processor**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/processor - -# @proto-kit/processor - -## Classes - -- [BlockFetching](classes/BlockFetching.md) -- [Database](classes/Database.md) -- [DatabasePruneModule](classes/DatabasePruneModule.md) -- [HandlersExecutor](classes/HandlersExecutor.md) -- [Processor](classes/Processor.md) -- [ProcessorModule](classes/ProcessorModule.md) -- [ResolverFactoryGraphqlModule](classes/ResolverFactoryGraphqlModule.md) -- [TimedProcessorTrigger](classes/TimedProcessorTrigger.md) - -## Interfaces - -- [BlockFetchingConfig](interfaces/BlockFetchingConfig.md) -- [BlockResponse](interfaces/BlockResponse.md) -- [DatabasePruneModuleConfig](interfaces/DatabasePruneModuleConfig.md) -- [HandlersExecutorConfig](interfaces/HandlersExecutorConfig.md) -- [HandlersRecord](interfaces/HandlersRecord.md) -- [TimedProcessorTriggerConfig](interfaces/TimedProcessorTriggerConfig.md) - -## Type Aliases - -- [BlockHandler](type-aliases/BlockHandler.md) -- [ClientTransaction](type-aliases/ClientTransaction.md) -- [ProcessorModulesRecord](type-aliases/ProcessorModulesRecord.md) - -## Functions - -- [cleanResolvers](functions/cleanResolvers.md) -- [ValidateTakeArg](functions/ValidateTakeArg.md) diff --git a/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md b/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md index d5cc853..524cfe6 100644 --- a/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md +++ b/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md @@ -10,7 +10,7 @@ title: BlockFetchingConfig # Interface: BlockFetchingConfig -Defined in: [packages/processor/src/indexer/BlockFetching.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L19) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L19) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/processor/src/indexer/BlockFetching.ts:19](https://github. > **url**: `string` -Defined in: [packages/processor/src/indexer/BlockFetching.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L20) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L20) diff --git a/src/pages/docs/reference/processor/interfaces/BlockResponse.md b/src/pages/docs/reference/processor/interfaces/BlockResponse.md index 2399c5f..629b908 100644 --- a/src/pages/docs/reference/processor/interfaces/BlockResponse.md +++ b/src/pages/docs/reference/processor/interfaces/BlockResponse.md @@ -10,7 +10,7 @@ title: BlockResponse # Interface: BlockResponse -Defined in: [packages/processor/src/indexer/BlockFetching.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L23) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L23) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/processor/src/indexer/BlockFetching.ts:23](https://github. > **data**: `object` -Defined in: [packages/processor/src/indexer/BlockFetching.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/indexer/BlockFetching.ts#L24) +Defined in: [packages/processor/src/indexer/BlockFetching.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L24) #### findFirstBlock diff --git a/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md b/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md index 28673a9..cdac755 100644 --- a/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md +++ b/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md @@ -10,7 +10,7 @@ title: DatabasePruneModuleConfig # Interface: DatabasePruneModuleConfig -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/DatabasePruneModule.ts#L9) +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/DatabasePruneModule.ts#L9) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:9](https://gi > `optional` **pruneOnStartup**: `boolean` -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/storage/DatabasePruneModule.ts#L10) +Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/DatabasePruneModule.ts#L10) diff --git a/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md b/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md index 1a0dfc3..8e71ed6 100644 --- a/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md +++ b/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md @@ -10,7 +10,7 @@ title: HandlersExecutorConfig # Interface: HandlersExecutorConfig -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L22) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L22) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:22](https://git > `optional` **maxWait**: `number` -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L23) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L23) *** @@ -26,4 +26,4 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:23](https://git > `optional` **timeout**: `number` -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L24) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L24) diff --git a/src/pages/docs/reference/processor/interfaces/HandlersRecord.md b/src/pages/docs/reference/processor/interfaces/HandlersRecord.md index 25b48be..122b371 100644 --- a/src/pages/docs/reference/processor/interfaces/HandlersRecord.md +++ b/src/pages/docs/reference/processor/interfaces/HandlersRecord.md @@ -10,7 +10,7 @@ title: HandlersRecord # Interface: HandlersRecord\ -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L18) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L18) ## Type Parameters @@ -22,4 +22,4 @@ Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:18](https://git > **onBlock**: [`BlockHandler`](../type-aliases/BlockHandler.md)\<`PrismaClient`\>[] -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L19) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L19) diff --git a/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md b/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md index 913c4ed..516b64c 100644 --- a/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md +++ b/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md @@ -10,7 +10,7 @@ title: TimedProcessorTriggerConfig # Interface: TimedProcessorTriggerConfig -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L10) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L10) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:10](https: > `optional` **interval**: `number` -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/triggers/TimedProcessorTrigger.ts#L11) +Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L11) diff --git a/src/pages/docs/reference/processor/type-aliases/BlockHandler.md b/src/pages/docs/reference/processor/type-aliases/BlockHandler.md index 940c119..36f3610 100644 --- a/src/pages/docs/reference/processor/type-aliases/BlockHandler.md +++ b/src/pages/docs/reference/processor/type-aliases/BlockHandler.md @@ -12,7 +12,7 @@ title: BlockHandler > **BlockHandler**\<`PrismaClient`\>: (`client`, `block`) => `Promise`\<`void`\> -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L13) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L13) ## Type Parameters diff --git a/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md b/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md index 84859bc..625e425 100644 --- a/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md +++ b/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md @@ -12,7 +12,7 @@ title: ClientTransaction > **ClientTransaction**\<`PrismaClient`\>: `Parameters`\<`Parameters`\<`PrismaClient`\[`"$transaction"`\]\>\[`0`\]\>\[`0`\] -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/handlers/HandlersExecutor.ts#L10) +Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L10) ## Type Parameters diff --git a/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md b/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md index b25b45e..987b870 100644 --- a/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md +++ b/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md @@ -12,4 +12,4 @@ title: ProcessorModulesRecord > **ProcessorModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ProcessorModule`](../classes/ProcessorModule.md)\<`unknown`\>\>\> -Defined in: [packages/processor/src/Processor.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/processor/src/Processor.ts#L11) +Defined in: [packages/processor/src/Processor.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/Processor.ts#L11) diff --git a/src/pages/docs/reference/protocol/classes/AccountState.md b/src/pages/docs/reference/protocol/classes/AccountState.md index 6b1cd3f..5796ac8 100644 --- a/src/pages/docs/reference/protocol/classes/AccountState.md +++ b/src/pages/docs/reference/protocol/classes/AccountState.md @@ -10,7 +10,7 @@ title: AccountState # Class: AccountState -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/AccountStateHook.ts#L10) +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/AccountStateHook.ts#L10) ## Extends @@ -46,7 +46,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **nonce**: `UInt64` = `UInt64` -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/AccountStateHook.ts#L11) +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/AccountStateHook.ts#L11) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/AccountStateHook.md b/src/pages/docs/reference/protocol/classes/AccountStateHook.md index d3073a0..e206cab 100644 --- a/src/pages/docs/reference/protocol/classes/AccountStateHook.md +++ b/src/pages/docs/reference/protocol/classes/AccountStateHook.md @@ -10,7 +10,7 @@ title: AccountStateHook # Class: AccountStateHook -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/AccountStateHook.ts#L15) +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/AccountStateHook.ts#L15) ## Extends @@ -36,7 +36,7 @@ Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:15](https://github. > **accountState**: [`StateMap`](StateMap.md)\<`PublicKey`, [`AccountState`](AccountState.md)\> -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/AccountStateHook.ts#L16) +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/AccountStateHook.ts#L16) *** @@ -59,7 +59,7 @@ checks when retrieving it via the getter > `optional` **name**: `string` -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) #### Inherited from @@ -71,7 +71,7 @@ Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](h > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -85,7 +85,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -135,7 +135,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -157,7 +157,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **onTransaction**(`__namedParameters`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/AccountStateHook.ts#L21) +Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/AccountStateHook.ts#L21) #### Parameters @@ -179,7 +179,7 @@ Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:21](https://github. > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md index e48d522..1eab434 100644 --- a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md +++ b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md @@ -10,7 +10,7 @@ title: BlockHashMerkleTree # Class: BlockHashMerkleTree -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L4) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L4) ## Extends diff --git a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md index 616401f..bcec56a 100644 --- a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md +++ b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md @@ -10,7 +10,7 @@ title: BlockHashMerkleTreeWitness # Class: BlockHashMerkleTreeWitness -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L5) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L5) ## Extends diff --git a/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md b/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md index ce56694..31fc41e 100644 --- a/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md +++ b/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md @@ -10,7 +10,7 @@ title: BlockHashTreeEntry # Class: BlockHashTreeEntry -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L7) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L7) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **blockHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L8) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L8) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTre > **closed**: `Bool` = `Bool` -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L9) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L9) #### Inherited from @@ -406,7 +406,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L13) +Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L13) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/BlockHeightHook.md b/src/pages/docs/reference/protocol/classes/BlockHeightHook.md index e699bc3..69f1468 100644 --- a/src/pages/docs/reference/protocol/classes/BlockHeightHook.md +++ b/src/pages/docs/reference/protocol/classes/BlockHeightHook.md @@ -10,7 +10,7 @@ title: BlockHeightHook # Class: BlockHeightHook -Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/BlockHeightHook.ts#L4) +Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/BlockHeightHook.ts#L4) ## Extends @@ -51,7 +51,7 @@ checks when retrieving it via the getter > `optional` **name**: `string` -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) #### Inherited from @@ -63,7 +63,7 @@ Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](h > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -127,7 +127,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **afterBlock**(`networkState`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/BlockHeightHook.ts#L5) +Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/BlockHeightHook.ts#L5) #### Parameters @@ -149,7 +149,7 @@ Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:5](https://github.co > **beforeBlock**(`networkState`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/BlockHeightHook.ts#L14) +Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/BlockHeightHook.ts#L14) #### Parameters @@ -171,7 +171,7 @@ Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:14](https://github.c > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -193,7 +193,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/BlockProver.md b/src/pages/docs/reference/protocol/classes/BlockProver.md index 30b965d..e31351e 100644 --- a/src/pages/docs/reference/protocol/classes/BlockProver.md +++ b/src/pages/docs/reference/protocol/classes/BlockProver.md @@ -10,7 +10,7 @@ title: BlockProver # Class: BlockProver -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:907](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L907) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:907](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L907) BlockProver class, which aggregates a AppChainProof and a StateTransitionProof into a single BlockProof, that can @@ -31,7 +31,7 @@ then be merged to be committed to the base-layer contract > **new BlockProver**(`stateTransitionProver`, `runtime`, `transactionHooks`, `blockHooks`, `verificationKeyService`): [`BlockProver`](BlockProver.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:913](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L913) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:913](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L913) #### Parameters @@ -84,7 +84,7 @@ checks when retrieving it via the getter > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -96,7 +96,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > `readonly` **runtime**: [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> & [`CompilableModule`](../../common/interfaces/CompilableModule.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:921](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L921) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:921](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L921) *** @@ -104,7 +104,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:921](https://gith > `readonly` **stateTransitionProver**: [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> & [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:915](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L915) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:915](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L915) *** @@ -112,7 +112,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:915](https://gith > **zkProgrammable**: [`BlockProverProgrammable`](BlockProverProgrammable.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:911](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L911) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:911](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L911) #### Implementation of @@ -126,7 +126,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:911](https://gith > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -176,7 +176,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compile**(`registry`): `Promise`\<`undefined` \| `Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:940](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L940) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:940](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L940) #### Parameters @@ -198,7 +198,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:940](https://gith > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -220,7 +220,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:983](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L983) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:983](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L983) #### Parameters @@ -250,7 +250,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:983](https://gith > **proveBlock**(`publicInput`, `networkState`, `blockWitness`, `transactionProof`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:967](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L967) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:967](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L967) #### Parameters @@ -284,7 +284,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:967](https://gith > **proveTransaction**(`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:951](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L951) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:951](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L951) #### Parameters @@ -322,7 +322,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:951](https://gith > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md b/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md index 465a189..840a338 100644 --- a/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md +++ b/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md @@ -10,7 +10,7 @@ title: BlockProverExecutionData # Class: BlockProverExecutionData -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L57) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L57) ## Extends @@ -54,7 +54,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L60) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L60) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:60](https://git > **signature**: `Signature` = `Signature` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L59) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L59) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:59](https://git > **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L58) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L58) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md b/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md index 9524682..d1c004e 100644 --- a/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md +++ b/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md @@ -10,7 +10,7 @@ title: BlockProverProgrammable # Class: BlockProverProgrammable -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:135](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L135) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:135](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L135) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:135](https://gith > **new BlockProverProgrammable**(`prover`, `stateTransitionProver`, `runtime`, `transactionHooks`, `blockHooks`, `verificationKeyService`): [`BlockProverProgrammable`](BlockProverProgrammable.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:139](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L139) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:139](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L139) #### Parameters @@ -64,7 +64,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:139](https://gith > **name**: `string` = `"BlockProver"` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:153](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L153) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:153](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L153) *** @@ -72,7 +72,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:153](https://gith > `readonly` **runtime**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:145](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L145) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:145](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L145) *** @@ -80,7 +80,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:145](https://gith > `readonly` **stateTransitionProver**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:141](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L141) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:141](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L141) ## Accessors @@ -90,7 +90,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:141](https://gith > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:155](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L155) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:155](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L155) ##### Returns @@ -124,7 +124,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:34 > **applyTransaction**(`state`, `stateTransitionProof`, `runtimeProof`, `executionData`, `verificationKey`): `Promise`\<[`BlockProverState`](../interfaces/BlockProverState.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:170](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L170) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:170](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L170) Applies and checks the two proofs and applies the corresponding state changes to the given state @@ -165,7 +165,7 @@ The new BlockProver-state to be used as public output > **assertProtocolTransitions**(`stateTransitionProof`, `executionData`, `runtimeProof`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:264](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L264) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:264](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L264) #### Parameters @@ -213,7 +213,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:35 > **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:656](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L656) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:656](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L656) #### Parameters @@ -239,7 +239,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:656](https://gith > **proveBlock**(`publicInput`, `networkState`, `blockWitness`, `transactionProof`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:482](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L482) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:482](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L482) #### Parameters @@ -269,7 +269,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:482](https://gith > **proveTransaction**(`publicInput`, `stateProof`, `runtimeProof`, `executionData`, `verificationKeyWitness`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:406](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L406) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L406) #### Parameters @@ -303,7 +303,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:406](https://gith > **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`BlockProverPublicInput`](BlockProverPublicInput.md), [`BlockProverPublicOutput`](BlockProverPublicOutput.md)\>[] -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:798](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L798) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:798](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L798) Creates the BlockProver ZkProgram. Recursive linking of proofs is done via the previously diff --git a/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md b/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md index b8b861f..4bcf8fa 100644 --- a/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md +++ b/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md @@ -10,7 +10,7 @@ title: BlockProverPublicInput # Class: BlockProverPublicInput -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L20) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L20) ## Extends @@ -70,7 +70,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **blockHashRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L24) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L24) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:24](https://git > **blockNumber**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L27) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L27) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:27](https://git > **eternalTransactionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L25) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L25) #### Inherited from @@ -106,7 +106,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:25](https://git > **incomingMessagesHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L26) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L26) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:26](https://git > **networkStateHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L23) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L23) #### Inherited from @@ -130,7 +130,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:23](https://git > **stateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L22) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L22) #### Inherited from @@ -142,7 +142,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:22](https://git > **transactionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L21) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L21) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md b/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md index a4c2bb2..fc6efe7 100644 --- a/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md +++ b/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md @@ -10,7 +10,7 @@ title: BlockProverPublicOutput # Class: BlockProverPublicOutput -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L30) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L30) ## Extends @@ -74,7 +74,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **blockHashRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L34) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L34) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:34](https://git > **blockNumber**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L38) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L38) #### Inherited from @@ -98,7 +98,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:38](https://git > **closed**: `Bool` = `Bool` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L37) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L37) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:37](https://git > **eternalTransactionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L35) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L35) #### Inherited from @@ -122,7 +122,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:35](https://git > **incomingMessagesHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L36) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L36) #### Inherited from @@ -134,7 +134,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:36](https://git > **networkStateHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L33) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L33) #### Inherited from @@ -146,7 +146,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:33](https://git > **stateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L32) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L32) #### Inherited from @@ -158,7 +158,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:32](https://git > **transactionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L31) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L31) #### Inherited from @@ -790,7 +790,7 @@ Convert provable type to a normal JS type. > **equals**(`input`, `closed`): `Bool` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L40) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L40) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/BridgeContract.md b/src/pages/docs/reference/protocol/classes/BridgeContract.md index 4438fc3..ae87938 100644 --- a/src/pages/docs/reference/protocol/classes/BridgeContract.md +++ b/src/pages/docs/reference/protocol/classes/BridgeContract.md @@ -10,7 +10,7 @@ title: BridgeContract # Class: BridgeContract -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:211](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L211) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:211](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L211) ## Extends @@ -82,7 +82,7 @@ A list of event types that can be emitted using this.emitEvent()`. > **outgoingMessageCursor**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:219](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L219) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:219](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L219) #### Implementation of @@ -163,7 +163,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > **settlementContractAddress**: `State`\<`PublicKey`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:215](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L215) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:215](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L215) #### Overrides @@ -175,7 +175,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:215](h > **stateRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:217](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L217) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:217](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L217) #### Implementation of @@ -271,7 +271,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) #### SettlementContract @@ -600,7 +600,7 @@ Approve a list of account updates (with arbitrarily many children). > **approveBase**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) #### Returns @@ -684,7 +684,7 @@ async deploy() { > **deployProvable**(`verificationKey`, `signedSettlement`, `permissions`, `settlementContractAddress`): `Promise`\<`AccountUpdate`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) Function to deploy the bridging contract in a provable way, so that it can be a provable process initiated by the settlement contract with a baked-in vk @@ -946,7 +946,7 @@ Same as `SmartContract.self` but explicitly creates a new AccountUpdate. > **redeem**(`additionUpdate`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:234](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L234) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:234](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L234) #### Parameters @@ -968,7 +968,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:234](h > `protected` **redeemBase**(`additionUpdate`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) #### Parameters @@ -1016,7 +1016,7 @@ with the only difference being that quick mock proofs are filled in instead of r > **rollupOutgoingMessages**(`batch`): `Promise`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:227](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L227) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:227](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L227) #### Parameters @@ -1038,7 +1038,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:227](h > **rollupOutgoingMessagesBase**(`batch`): `Promise`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) #### Parameters @@ -1143,7 +1143,7 @@ Transfer `amount` of tokens from `from` to `to`. > **updateStateRoot**(`root`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:222](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L222) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:222](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L222) #### Parameters @@ -1165,7 +1165,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:222](h > **updateStateRootBase**(`root`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/BridgeContractBase.md b/src/pages/docs/reference/protocol/classes/BridgeContractBase.md index 9943b86..c9b90e8 100644 --- a/src/pages/docs/reference/protocol/classes/BridgeContractBase.md +++ b/src/pages/docs/reference/protocol/classes/BridgeContractBase.md @@ -10,7 +10,7 @@ title: BridgeContractBase # Class: `abstract` BridgeContractBase -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L54) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L54) ## Extends @@ -82,7 +82,7 @@ A list of event types that can be emitted using this.emitEvent()`. > `abstract` **outgoingMessageCursor**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L66) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L66) *** @@ -155,7 +155,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > `abstract` **settlementContractAddress**: `State`\<`PublicKey`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L62) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L62) *** @@ -163,7 +163,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:62](ht > `abstract` **stateRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L64) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L64) *** @@ -251,7 +251,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) #### SettlementContract @@ -576,7 +576,7 @@ Approve a list of account updates (with arbitrarily many children). > **approveBase**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) #### Returns @@ -660,7 +660,7 @@ async deploy() { > **deployProvable**(`verificationKey`, `signedSettlement`, `permissions`, `settlementContractAddress`): `Promise`\<`AccountUpdate`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) Function to deploy the bridging contract in a provable way, so that it can be a provable process initiated by the settlement contract with a baked-in vk @@ -914,7 +914,7 @@ Same as `SmartContract.self` but explicitly creates a new AccountUpdate. > `protected` **redeemBase**(`additionUpdate`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) #### Parameters @@ -958,7 +958,7 @@ with the only difference being that quick mock proofs are filled in instead of r > **rollupOutgoingMessagesBase**(`batch`): `Promise`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) #### Parameters @@ -1059,7 +1059,7 @@ Transfer `amount` of tokens from `from` to `to`. > **updateStateRootBase**(`root`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md index ac8796d..2a81f56 100644 --- a/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md +++ b/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md @@ -10,7 +10,7 @@ title: BridgeContractProtocolModule # Class: BridgeContractProtocolModule -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L18) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L18) This module type is used to define a contract module that can be used to construct and inject smart contract instances. @@ -92,7 +92,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compile**(`registry`): `Promise`\<\{ `BridgeContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L38) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L38) #### Parameters @@ -114,7 +114,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolMo > **contractFactory**(): *typeof* [`BridgeContract`](BridgeContract.md) -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L22) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L22) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ContractModule.md b/src/pages/docs/reference/protocol/classes/ContractModule.md index 1833f55..f81fe40 100644 --- a/src/pages/docs/reference/protocol/classes/ContractModule.md +++ b/src/pages/docs/reference/protocol/classes/ContractModule.md @@ -10,7 +10,7 @@ title: ContractModule # Class: `abstract` ContractModule\ -Defined in: [packages/protocol/src/settlement/ContractModule.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/ContractModule.ts#L22) +Defined in: [packages/protocol/src/settlement/ContractModule.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/ContractModule.ts#L22) This module type is used to define a contract module that can be used to construct and inject smart contract instances. @@ -108,7 +108,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > `abstract` **compile**(`registry`): `Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> -Defined in: [packages/protocol/src/settlement/ContractModule.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/ContractModule.ts#L28) +Defined in: [packages/protocol/src/settlement/ContractModule.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/ContractModule.ts#L28) #### Parameters @@ -130,7 +130,7 @@ Defined in: [packages/protocol/src/settlement/ContractModule.ts:28](https://gith > `abstract` **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<`ContractType`\> -Defined in: [packages/protocol/src/settlement/ContractModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/ContractModule.ts#L26) +Defined in: [packages/protocol/src/settlement/ContractModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/ContractModule.ts#L26) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/CurrentBlock.md b/src/pages/docs/reference/protocol/classes/CurrentBlock.md index 833aac9..905db84 100644 --- a/src/pages/docs/reference/protocol/classes/CurrentBlock.md +++ b/src/pages/docs/reference/protocol/classes/CurrentBlock.md @@ -10,7 +10,7 @@ title: CurrentBlock # Class: CurrentBlock -Defined in: [packages/protocol/src/model/network/NetworkState.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L4) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L4) ## Extends @@ -46,7 +46,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **height**: `UInt64` = `UInt64` -Defined in: [packages/protocol/src/model/network/NetworkState.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L5) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L5) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md b/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md index 468331e..bf79c6a 100644 --- a/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md +++ b/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md @@ -10,7 +10,7 @@ title: DefaultProvableHashList # Class: DefaultProvableHashList\ -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L46) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L46) Utilities for creating a hash list from a given value type. @@ -28,7 +28,7 @@ Utilities for creating a hash list from a given value type. > **new DefaultProvableHashList**\<`Value`\>(`valueType`, `commitment`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L7) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L7) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.c > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L47) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L47) #### Parameters @@ -100,7 +100,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:47](https://github. > **push**(`value`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -129,7 +129,7 @@ Current hash list. > **pushIf**(`value`, `condition`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L29) #### Parameters @@ -155,7 +155,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github. > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/Deposit.md b/src/pages/docs/reference/protocol/classes/Deposit.md index 4c03376..2eb5185 100644 --- a/src/pages/docs/reference/protocol/classes/Deposit.md +++ b/src/pages/docs/reference/protocol/classes/Deposit.md @@ -10,7 +10,7 @@ title: Deposit # Class: Deposit -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Deposit.ts#L3) +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Deposit.ts#L3) ## Extends @@ -54,7 +54,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **address**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Deposit.ts#L5) +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Deposit.ts#L5) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:5](https://git > **amount**: `UInt64` = `UInt64` -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Deposit.ts#L6) +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Deposit.ts#L6) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:6](https://git > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Deposit.ts#L4) +Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Deposit.ts#L4) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md index 07b75e0..673016c 100644 --- a/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md +++ b/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md @@ -10,7 +10,7 @@ title: DispatchContractProtocolModule # Class: DispatchContractProtocolModule -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L22) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L22) This module type is used to define a contract module that can be used to construct and inject smart contract instances. @@ -29,7 +29,7 @@ ContractType generic. > **new DispatchContractProtocolModule**(`runtime`): [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L26) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L26) #### Parameters @@ -100,7 +100,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compile**(`registry`): `Promise`\<\{ `DispatchSmartContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L65) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L65) #### Parameters @@ -122,7 +122,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocol > **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md)\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L49) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L49) #### Returns @@ -160,7 +160,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **eventsDefinition**(): `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L30) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L30) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md b/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md index 3326396..ae118ae 100644 --- a/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md +++ b/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md @@ -10,7 +10,7 @@ title: DispatchSmartContract # Class: DispatchSmartContract -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:229](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L229) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:229](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L229) ## Extends @@ -64,7 +64,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 > **events**: `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) A list of event types that can be emitted using this.emitEvent()`. @@ -86,7 +86,7 @@ A list of event types that can be emitted using this.emitEvent()`. > **honoredMessagesHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:235](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L235) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:235](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L235) #### Overrides @@ -98,7 +98,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **promisedMessagesHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:233](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L233) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:233](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L233) #### Implementation of @@ -179,7 +179,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > **settlementContract**: `State`\<`PublicKey`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:237](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L237) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:237](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L237) #### Overrides @@ -191,7 +191,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **tokenBridgeCount**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:241](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L241) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:241](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L241) #### Overrides @@ -203,7 +203,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **tokenBridgeRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:239](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L239) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:239](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L239) #### Overrides @@ -295,7 +295,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) #### incomingMessagesPaths @@ -529,7 +529,7 @@ tx.sign([senderKey, zkAppKey]); > **deposit**(`amount`, `tokenId`, `bridgingContract`, `bridgingContractAttestation`, `l2Receiver`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:273](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L273) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:273](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L273) #### Parameters @@ -563,7 +563,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `protected` **dispatchMessage**\<`Type`\>(`methodId`, `value`, `valueType`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) #### Type Parameters @@ -667,7 +667,7 @@ Events will be emitted as a part of the transaction and can be collected by arch > **enableTokenDeposits**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:244](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L244) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:244](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L244) #### Parameters @@ -697,7 +697,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `protected` **enableTokenDepositsBase**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) #### Parameters @@ -804,7 +804,7 @@ class MyContract extends SmartContract { > **initialize**(`settlementContract`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:268](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L268) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:268](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L268) #### Parameters @@ -826,7 +826,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `protected` **initializeBase**(`settlementContract`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) #### Parameters @@ -949,7 +949,7 @@ authorization flow. > **updateMessagesHash**(`executedMessagesHash`, `newPromisedMessagesHash`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:257](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L257) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:257](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L257) #### Parameters @@ -975,7 +975,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `protected` **updateMessagesHashBase**(`executedMessagesHash`, `newPromisedMessagesHash`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md b/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md index 5c2f77a..ee89f04 100644 --- a/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md +++ b/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md @@ -10,7 +10,7 @@ title: DispatchSmartContractBase # Class: `abstract` DispatchSmartContractBase -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L59) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L59) ## Extends @@ -64,7 +64,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 > **events**: `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) A list of event types that can be emitted using this.emitEvent()`. @@ -86,7 +86,7 @@ A list of event types that can be emitted using this.emitEvent()`. > `abstract` **honoredMessagesHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L77) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L77) *** @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `abstract` **promisedMessagesHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L75) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L75) *** @@ -167,7 +167,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > `abstract` **settlementContract**: `State`\<`PublicKey`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L79) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L79) *** @@ -175,7 +175,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `abstract` **tokenBridgeCount**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L83) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L83) *** @@ -183,7 +183,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > `abstract` **tokenBridgeRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L81) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L81) *** @@ -271,7 +271,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) #### incomingMessagesPaths @@ -501,7 +501,7 @@ tx.sign([senderKey, zkAppKey]); > `protected` **dispatchMessage**\<`Type`\>(`methodId`, `value`, `valueType`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) #### Type Parameters @@ -601,7 +601,7 @@ Events will be emitted as a part of the transaction and can be collected by arch > `protected` **enableTokenDepositsBase**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) #### Parameters @@ -704,7 +704,7 @@ class MyContract extends SmartContract { > `protected` **initializeBase**(`settlementContract`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) #### Parameters @@ -823,7 +823,7 @@ authorization flow. > `protected` **updateMessagesHashBase**(`executedMessagesHash`, `newPromisedMessagesHash`): `void` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md b/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md index 666c000..95b68a9 100644 --- a/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md +++ b/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md @@ -10,7 +10,7 @@ title: DynamicBlockProof # Class: DynamicBlockProof -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L49) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L49) ## Extends @@ -155,7 +155,7 @@ Alternatively, you can use {@FeatureFlags.fromZkProgram} to compute the set of f > `static` **maxProofsVerified**: `2` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L57) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L57) #### Overrides @@ -167,7 +167,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `static` **publicInputType**: *typeof* [`BlockProverPublicInput`](BlockProverPublicInput.md) = `BlockProverPublicInput` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L53) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L53) #### Overrides @@ -179,7 +179,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `static` **publicOutputType**: *typeof* [`BlockProverPublicOutput`](BlockProverPublicOutput.md) = `BlockProverPublicOutput` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L55) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L55) #### Overrides diff --git a/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md b/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md index ce8eea1..f2090fb 100644 --- a/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md +++ b/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md @@ -10,7 +10,7 @@ title: DynamicRuntimeProof # Class: DynamicRuntimeProof -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L63) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L63) ## Extends @@ -155,7 +155,7 @@ Alternatively, you can use {@FeatureFlags.fromZkProgram} to compute the set of f > `static` **maxProofsVerified**: `0` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L72) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L72) #### Overrides @@ -167,7 +167,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:72](https://git > `static` **publicInputType**: `ProvablePureExtended`\<`void`, `void`, `null`\> = `Void` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L67) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L67) #### Overrides @@ -179,7 +179,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:67](https://git > `static` **publicOutputType**: *typeof* [`MethodPublicOutput`](MethodPublicOutput.md) = `MethodPublicOutput` -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L69) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L69) #### Overrides diff --git a/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md b/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md index 43554f7..e9d428d 100644 --- a/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md +++ b/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md @@ -10,7 +10,7 @@ title: LastStateRootBlockHook # Class: LastStateRootBlockHook -Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L5) +Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L5) ## Extends @@ -51,7 +51,7 @@ checks when retrieving it via the getter > `optional` **name**: `string` -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) #### Inherited from @@ -63,7 +63,7 @@ Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](h > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -77,7 +77,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -127,7 +127,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **afterBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L8) +Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L8) #### Parameters @@ -153,7 +153,7 @@ Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:8](https://gi > **beforeBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L20) +Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L20) #### Parameters @@ -179,7 +179,7 @@ Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:20](https://g > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -201,7 +201,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md b/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md index a7909fd..f19b36d 100644 --- a/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md +++ b/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md @@ -10,7 +10,7 @@ title: MethodPublicOutput # Class: MethodPublicOutput -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L7) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L7) Public input used to link in-circuit execution with the proof's public input. @@ -69,7 +69,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **eventsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L13) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L13) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:13](https://githu > **isMessage**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L12) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L12) #### Inherited from @@ -93,7 +93,7 @@ Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:12](https://githu > **networkStateHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L11) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L11) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:11](https://githu > **stateTransitionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L8) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L8) #### Inherited from @@ -117,7 +117,7 @@ Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:8](https://github > **status**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L9) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L9) #### Inherited from @@ -129,7 +129,7 @@ Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:9](https://github > **transactionHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/MethodPublicOutput.ts#L10) +Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L10) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md b/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md index 43481c3..f96153d 100644 --- a/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md +++ b/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md @@ -10,7 +10,7 @@ title: MethodVKConfigData # Class: MethodVKConfigData -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L13) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L13) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **methodId**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L14) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L14) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificatio > **vkHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L15) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L15) #### Inherited from @@ -406,7 +406,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L17) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L17) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/MinaActions.md b/src/pages/docs/reference/protocol/classes/MinaActions.md index a56909f..dfba8e8 100644 --- a/src/pages/docs/reference/protocol/classes/MinaActions.md +++ b/src/pages/docs/reference/protocol/classes/MinaActions.md @@ -10,7 +10,7 @@ title: MinaActions # Class: MinaActions -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L28) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L28) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:28](htt > `static` **actionHash**(`action`, `previousHash`): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L29) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md b/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md index 0b4b33a..6495778 100644 --- a/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md +++ b/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md @@ -10,7 +10,7 @@ title: MinaActionsHashList # Class: MinaActionsHashList -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L69) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L69) Utilities for creating a hash list from a given value type. @@ -24,7 +24,7 @@ Utilities for creating a hash list from a given value type. > **new MinaActionsHashList**(`internalCommitment`): [`MinaActionsHashList`](MinaActionsHashList.md) -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L70) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L70) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:70](htt > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -58,7 +58,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > `readonly` **prefix**: `string` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](htt > `protected` `readonly` **valueType**: `ProvablePure`\<`Field`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > `protected` **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) #### Parameters @@ -104,7 +104,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](htt > **push**(`value`): [`MinaActionsHashList`](MinaActionsHashList.md) -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -133,7 +133,7 @@ Current hash list. > **pushIf**(`value`, `condition`): [`MinaActionsHashList`](MinaActionsHashList.md) -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L29) #### Parameters @@ -159,7 +159,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github. > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/MinaEvents.md b/src/pages/docs/reference/protocol/classes/MinaEvents.md index 4e6c1e4..e03a8d5 100644 --- a/src/pages/docs/reference/protocol/classes/MinaEvents.md +++ b/src/pages/docs/reference/protocol/classes/MinaEvents.md @@ -10,7 +10,7 @@ title: MinaEvents # Class: MinaEvents -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L41) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:41](htt > `static` **eventHash**(`event`, `previousHash`): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L42) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L42) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md b/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md index be40be9..3ddc274 100644 --- a/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md +++ b/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md @@ -10,7 +10,7 @@ title: MinaPrefixedProvableHashList # Class: MinaPrefixedProvableHashList\ -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L51) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L51) Utilities for creating a hash list from a given value type. @@ -32,7 +32,7 @@ Utilities for creating a hash list from a given value type. > **new MinaPrefixedProvableHashList**\<`Value`\>(`valueType`, `prefix`, `internalCommitment`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L54) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L54) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:54](htt > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > `readonly` **prefix**: `string` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) *** @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](htt > `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > `protected` **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) #### Parameters @@ -116,7 +116,7 @@ Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](htt > **push**(`value`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -145,7 +145,7 @@ Current hash list. > **pushIf**(`value`, `condition`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L29) #### Parameters @@ -171,7 +171,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github. > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/NetworkState.md b/src/pages/docs/reference/protocol/classes/NetworkState.md index 5d68b15..1623e7b 100644 --- a/src/pages/docs/reference/protocol/classes/NetworkState.md +++ b/src/pages/docs/reference/protocol/classes/NetworkState.md @@ -10,7 +10,7 @@ title: NetworkState # Class: NetworkState -Defined in: [packages/protocol/src/model/network/NetworkState.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L12) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L12) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **block**: [`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` -Defined in: [packages/protocol/src/model/network/NetworkState.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L13) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L13) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/network/NetworkState.ts:13](https://git > **previous**: [`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` -Defined in: [packages/protocol/src/model/network/NetworkState.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L14) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L14) #### Inherited from @@ -406,7 +406,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/model/network/NetworkState.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L16) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L16) #### Returns @@ -418,7 +418,7 @@ Defined in: [packages/protocol/src/model/network/NetworkState.ts:16](https://git > `static` **empty**(): [`NetworkState`](NetworkState.md) -Defined in: [packages/protocol/src/model/network/NetworkState.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L23) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L23) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md b/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md index 44eb96a..b300815 100644 --- a/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md +++ b/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md @@ -10,7 +10,7 @@ title: NetworkStateSettlementModule # Class: NetworkStateSettlementModule -Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L14) +Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L14) Used by various module sub-types that may need to be configured @@ -53,7 +53,7 @@ checks when retrieving it via the getter > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -67,7 +67,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -117,7 +117,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **beforeSettlement**(`smartContract`, `__namedParameters`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L15) +Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L15) #### Parameters @@ -143,7 +143,7 @@ Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModu > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -165,7 +165,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/Option.md b/src/pages/docs/reference/protocol/classes/Option.md index 0f36e90..87998cb 100644 --- a/src/pages/docs/reference/protocol/classes/Option.md +++ b/src/pages/docs/reference/protocol/classes/Option.md @@ -10,7 +10,7 @@ title: Option # Class: Option\ -Defined in: [packages/protocol/src/model/Option.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L84) +Defined in: [packages/protocol/src/model/Option.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L84) Option facilitating in-circuit values that may or may not exist. @@ -28,7 +28,7 @@ Option facilitating in-circuit values that may or may not exist. > **new Option**\<`Value`\>(`isSome`, `value`, `valueType`, `isForcedSome`): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L122) +Defined in: [packages/protocol/src/model/Option.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L122) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/Option.ts:122](https://github.com/proto > **isForcedSome**: `Bool` -Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L24) +Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L24) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto- > **isSome**: `Bool` -Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L23) +Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L23) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto- > **value**: `Value` -Defined in: [packages/protocol/src/model/Option.ts:124](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L124) +Defined in: [packages/protocol/src/model/Option.ts:124](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L124) *** @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/model/Option.ts:124](https://github.com/proto > **valueType**: `FlexibleProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:125](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L125) +Defined in: [packages/protocol/src/model/Option.ts:125](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L125) ## Accessors @@ -104,7 +104,7 @@ Defined in: [packages/protocol/src/model/Option.ts:125](https://github.com/proto > **get** **treeValue**(): `Field` -Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L34) +Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L34) ##### Returns @@ -122,7 +122,7 @@ Tree representation of the current value > **clone**(): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:135](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L135) +Defined in: [packages/protocol/src/model/Option.ts:135](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L135) #### Returns @@ -138,7 +138,7 @@ Defined in: [packages/protocol/src/model/Option.ts:135](https://github.com/proto > **encodeValueToFields**(): `Field`[] -Defined in: [packages/protocol/src/model/Option.ts:131](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L131) +Defined in: [packages/protocol/src/model/Option.ts:131](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L131) #### Returns @@ -154,7 +154,7 @@ Defined in: [packages/protocol/src/model/Option.ts:131](https://github.com/proto > **forceSome**(): `void` -Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L44) +Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L44) #### Returns @@ -170,7 +170,7 @@ Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto- > **orElse**(`defaultValue`): `Value` -Defined in: [packages/protocol/src/model/Option.ts:148](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L148) +Defined in: [packages/protocol/src/model/Option.ts:148](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L148) #### Parameters @@ -191,7 +191,7 @@ otherwise returns the given defaultValue > **toConstant**(): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:157](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L157) +Defined in: [packages/protocol/src/model/Option.ts:157](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L157) #### Returns @@ -203,7 +203,7 @@ Defined in: [packages/protocol/src/model/Option.ts:157](https://github.com/proto > **toFields**(): `Field`[] -Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L53) +Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L53) Returns the `to`-value as decoded as a list of fields Not in circuit @@ -222,7 +222,7 @@ Not in circuit > **toJSON**(): `object` -Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L70) +Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L70) #### Returns @@ -250,7 +250,7 @@ Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto- > **toProvable**(): [`ProvableOption`](ProvableOption.md) -Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L63) +Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L63) #### Returns @@ -268,7 +268,7 @@ Provable representation of the current option. > `static` **from**\<`Value`\>(`isSome`, `value`, `valueType`): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:93](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L93) +Defined in: [packages/protocol/src/model/Option.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L93) Creates a new Option from the provided parameters @@ -302,7 +302,7 @@ New option from the provided parameters. > `static` **fromValue**\<`Value`\>(`value`, `valueType`): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/Option.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L108) +Defined in: [packages/protocol/src/model/Option.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L108) Creates a new Option from the provided parameters @@ -332,7 +332,7 @@ New option from the provided parameters. > `static` **none**(): [`Option`](Option.md)\<`Field`\> -Defined in: [packages/protocol/src/model/Option.ts:118](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L118) +Defined in: [packages/protocol/src/model/Option.ts:118](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L118) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/OptionBase.md b/src/pages/docs/reference/protocol/classes/OptionBase.md index 2de9709..2f47fd0 100644 --- a/src/pages/docs/reference/protocol/classes/OptionBase.md +++ b/src/pages/docs/reference/protocol/classes/OptionBase.md @@ -10,7 +10,7 @@ title: OptionBase # Class: `abstract` OptionBase -Defined in: [packages/protocol/src/model/Option.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L21) +Defined in: [packages/protocol/src/model/Option.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L21) ## Extended by @@ -23,7 +23,7 @@ Defined in: [packages/protocol/src/model/Option.ts:21](https://github.com/proto- > `protected` **new OptionBase**(`isSome`, `isForcedSome`): [`OptionBase`](OptionBase.md) -Defined in: [packages/protocol/src/model/Option.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L22) +Defined in: [packages/protocol/src/model/Option.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L22) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/protocol/src/model/Option.ts:22](https://github.com/proto- > **isForcedSome**: `Bool` -Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L24) +Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L24) *** @@ -53,7 +53,7 @@ Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto- > **isSome**: `Bool` -Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L23) +Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L23) ## Accessors @@ -63,7 +63,7 @@ Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto- > **get** **treeValue**(): `Field` -Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L34) +Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L34) ##### Returns @@ -77,7 +77,7 @@ Tree representation of the current value > `abstract` `protected` **clone**(): [`OptionBase`](OptionBase.md) -Defined in: [packages/protocol/src/model/Option.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L29) +Defined in: [packages/protocol/src/model/Option.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L29) #### Returns @@ -89,7 +89,7 @@ Defined in: [packages/protocol/src/model/Option.ts:29](https://github.com/proto- > `abstract` `protected` **encodeValueToFields**(): `Field`[] -Defined in: [packages/protocol/src/model/Option.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L27) +Defined in: [packages/protocol/src/model/Option.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L27) #### Returns @@ -101,7 +101,7 @@ Defined in: [packages/protocol/src/model/Option.ts:27](https://github.com/proto- > **forceSome**(): `void` -Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L44) +Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L44) #### Returns @@ -113,7 +113,7 @@ Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto- > **toFields**(): `Field`[] -Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L53) +Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L53) Returns the `to`-value as decoded as a list of fields Not in circuit @@ -128,7 +128,7 @@ Not in circuit > **toJSON**(): `object` -Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L70) +Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L70) #### Returns @@ -152,7 +152,7 @@ Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto- > **toProvable**(): [`ProvableOption`](ProvableOption.md) -Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L63) +Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L63) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md index 0844a3a..85832da 100644 --- a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md +++ b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md @@ -10,7 +10,7 @@ title: OutgoingMessageArgument # Class: OutgoingMessageArgument -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L8) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L8) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **value**: [`Withdrawal`](Withdrawal.md) = `Withdrawal` -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L10) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L10) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.t > **witness**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L9) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L9) #### Inherited from @@ -474,7 +474,7 @@ Convert provable type to a normal JS type. > `static` **dummy**(): [`OutgoingMessageArgument`](OutgoingMessageArgument.md) -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L12) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L12) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md index 0299b5c..d9f9ccf 100644 --- a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md +++ b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md @@ -10,7 +10,7 @@ title: OutgoingMessageArgumentBatch # Class: OutgoingMessageArgumentBatch -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L20) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L20) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **arguments**: [`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L21) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L21) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.t > **isDummys**: `Bool`[] -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L26) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L26) #### Inherited from @@ -406,7 +406,7 @@ Convert provable type to a normal JS type. > `static` **fromMessages**(`providedArguments`): [`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L28) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L28) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md index 36d1c1d..510b7b4 100644 --- a/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md +++ b/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md @@ -10,7 +10,7 @@ title: OutgoingMessageKey # Class: OutgoingMessageKey -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L49) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L49) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **index**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L50) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L50) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:50](ht > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L51) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L51) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/Path.md b/src/pages/docs/reference/protocol/classes/Path.md index 677a25c..563cea8 100644 --- a/src/pages/docs/reference/protocol/classes/Path.md +++ b/src/pages/docs/reference/protocol/classes/Path.md @@ -10,7 +10,7 @@ title: Path # Class: Path -Defined in: [packages/protocol/src/model/Path.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Path.ts#L8) +Defined in: [packages/protocol/src/model/Path.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Path.ts#L8) Helps manage path (key) identifiers for key-values in trees. @@ -30,7 +30,7 @@ Helps manage path (key) identifiers for key-values in trees. > `static` **fromKey**\<`KeyType`\>(`path`, `keyType`, `key`): `Field` -Defined in: [packages/protocol/src/model/Path.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Path.ts#L42) +Defined in: [packages/protocol/src/model/Path.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Path.ts#L42) Encodes an existing path with the provided key into a single Field. @@ -64,7 +64,7 @@ Field representation of the leading path + the provided key. > `static` **fromProperty**(`className`, `propertyKey`): `Field` -Defined in: [packages/protocol/src/model/Path.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Path.ts#L26) +Defined in: [packages/protocol/src/model/Path.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Path.ts#L26) Encodes a class name and its property name into a Field @@ -90,7 +90,7 @@ Field representation of class name + property name > `static` **toField**(`value`): `Field` -Defined in: [packages/protocol/src/model/Path.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Path.ts#L15) +Defined in: [packages/protocol/src/model/Path.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Path.ts#L15) Encodes a JS string as a Field diff --git a/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md b/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md index 13ebf76..48c5969 100644 --- a/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md +++ b/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md @@ -10,7 +10,7 @@ title: PrefixedProvableHashList # Class: PrefixedProvableHashList\ -Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/PrefixedProvableHashList.ts#L6) +Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/PrefixedProvableHashList.ts#L6) Utilities for creating a hash list from a given value type. @@ -28,7 +28,7 @@ Utilities for creating a hash list from a given value type. > **new PrefixedProvableHashList**\<`Value`\>(`valueType`, `prefix`, `internalCommitment`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/PrefixedProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/PrefixedProvableHashList.ts#L9) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:9](https:// > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > `protected` **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/PrefixedProvableHashList.ts#L18) +Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/PrefixedProvableHashList.ts#L18) #### Parameters @@ -104,7 +104,7 @@ Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:18](https:/ > **push**(`value`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -133,7 +133,7 @@ Current hash list. > **pushIf**(`value`, `condition`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L29) #### Parameters @@ -159,7 +159,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github. > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/PreviousBlock.md b/src/pages/docs/reference/protocol/classes/PreviousBlock.md index f4336ea..e150047 100644 --- a/src/pages/docs/reference/protocol/classes/PreviousBlock.md +++ b/src/pages/docs/reference/protocol/classes/PreviousBlock.md @@ -10,7 +10,7 @@ title: PreviousBlock # Class: PreviousBlock -Defined in: [packages/protocol/src/model/network/NetworkState.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L8) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L8) ## Extends @@ -46,7 +46,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **rootHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/network/NetworkState.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/network/NetworkState.ts#L9) +Defined in: [packages/protocol/src/model/network/NetworkState.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L9) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/Protocol.md b/src/pages/docs/reference/protocol/classes/Protocol.md index e5b3b66..2282b50 100644 --- a/src/pages/docs/reference/protocol/classes/Protocol.md +++ b/src/pages/docs/reference/protocol/classes/Protocol.md @@ -10,7 +10,7 @@ title: Protocol # Class: Protocol\ -Defined in: [packages/protocol/src/protocol/Protocol.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L60) +Defined in: [packages/protocol/src/protocol/Protocol.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L66) Reusable module container facilitating registration, resolution configuration, decoration and validation of modules @@ -33,7 +33,7 @@ configuration, decoration and validation of modules > **new Protocol**\<`Modules`\>(`definition`): [`Protocol`](Protocol.md)\<`Modules`\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L78) +Defined in: [packages/protocol/src/protocol/Protocol.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L84) #### Parameters @@ -70,7 +70,7 @@ checks when retrieving it via the getter > **definition**: [`ProtocolDefinition`](../interfaces/ProtocolDefinition.md)\<`Modules`\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L76) +Defined in: [packages/protocol/src/protocol/Protocol.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L82) #### Overrides @@ -84,7 +84,7 @@ Defined in: [packages/protocol/src/protocol/Protocol.ts:76](https://github.com/p > **get** **blockProver**(): [`BlockProvable`](../interfaces/BlockProvable.md) -Defined in: [packages/protocol/src/protocol/Protocol.ts:115](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L115) +Defined in: [packages/protocol/src/protocol/Protocol.ts:121](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L121) ##### Returns @@ -150,7 +150,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 > **get** **dependencyContainer**(): `DependencyContainer` -Defined in: [packages/protocol/src/protocol/Protocol.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L105) +Defined in: [packages/protocol/src/protocol/Protocol.ts:111](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L111) ##### Returns @@ -202,7 +202,7 @@ list of module names > **get** **stateService**(): [`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) -Defined in: [packages/protocol/src/protocol/Protocol.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L83) +Defined in: [packages/protocol/src/protocol/Protocol.ts:89](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L89) ##### Returns @@ -220,7 +220,7 @@ Defined in: [packages/protocol/src/protocol/Protocol.ts:83](https://github.com/p > **get** **stateServiceProvider**(): [`StateServiceProvider`](StateServiceProvider.md) -Defined in: [packages/protocol/src/protocol/Protocol.ts:87](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L87) +Defined in: [packages/protocol/src/protocol/Protocol.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L93) ##### Returns @@ -238,7 +238,7 @@ Defined in: [packages/protocol/src/protocol/Protocol.ts:87](https://github.com/p > **get** **stateTransitionProver**(): [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) -Defined in: [packages/protocol/src/protocol/Protocol.ts:123](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L123) +Defined in: [packages/protocol/src/protocol/Protocol.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L129) ##### Returns @@ -348,7 +348,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/Protocol.ts:133](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L133) +Defined in: [packages/protocol/src/protocol/Protocol.ts:139](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L139) This is a placeholder for individual modules to override. This method will be called whenever the underlying container fully @@ -374,7 +374,7 @@ initialized > **decorateModule**(`moduleName`, `containedModule`): `void` -Defined in: [packages/protocol/src/protocol/Protocol.ts:91](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L91) +Defined in: [packages/protocol/src/protocol/Protocol.ts:97](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L97) Override this in the child class to provide custom features or module checks @@ -403,7 +403,7 @@ features or module checks > **getAreProofsEnabled**(): [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/Protocol.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L129) +Defined in: [packages/protocol/src/protocol/Protocol.ts:135](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L135) #### Returns @@ -658,7 +658,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:186](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L186) +Defined in: [packages/protocol/src/protocol/Protocol.ts:214](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L214) #### Returns @@ -699,7 +699,7 @@ such as only injecting other known modules. > `static` **from**\<`Modules`\>(`modules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](Protocol.md)\<`Modules`\>\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L66) +Defined in: [packages/protocol/src/protocol/Protocol.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L72) #### Type Parameters diff --git a/src/pages/docs/reference/protocol/classes/ProtocolModule.md b/src/pages/docs/reference/protocol/classes/ProtocolModule.md index fe9e8ba..bd02047 100644 --- a/src/pages/docs/reference/protocol/classes/ProtocolModule.md +++ b/src/pages/docs/reference/protocol/classes/ProtocolModule.md @@ -10,7 +10,7 @@ title: ProtocolModule # Class: `abstract` ProtocolModule\ -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L11) Used by various module sub-types that may need to be configured @@ -65,7 +65,7 @@ checks when retrieving it via the getter > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) ## Accessors @@ -75,7 +75,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -121,7 +121,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -143,7 +143,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md b/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md index 948fcf3..6dfedc3 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md +++ b/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md @@ -10,7 +10,7 @@ title: ProvableBlockHook # Class: `abstract` ProvableBlockHook\ -Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProvableBlockHook.ts#L7) +Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProvableBlockHook.ts#L7) ## Extends @@ -60,7 +60,7 @@ checks when retrieving it via the getter > `optional` **name**: `string` -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](h > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -136,7 +136,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > `abstract` **afterBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProvableBlockHook.ts#L15) +Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProvableBlockHook.ts#L15) #### Parameters @@ -158,7 +158,7 @@ Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:15](https://git > `abstract` **beforeBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> -Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProvableBlockHook.ts#L10) +Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProvableBlockHook.ts#L10) #### Parameters @@ -180,7 +180,7 @@ Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:10](https://git > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -202,7 +202,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableHashList.md b/src/pages/docs/reference/protocol/classes/ProvableHashList.md index b477f14..74b7dad 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableHashList.md +++ b/src/pages/docs/reference/protocol/classes/ProvableHashList.md @@ -10,7 +10,7 @@ title: ProvableHashList # Class: `abstract` ProvableHashList\ -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L6) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L6) Utilities for creating a hash list from a given value type. @@ -31,7 +31,7 @@ Utilities for creating a hash list from a given value type. > **new ProvableHashList**\<`Value`\>(`valueType`, `commitment`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L7) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L7) #### Parameters @@ -53,7 +53,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.c > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) *** @@ -61,7 +61,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) ## Methods @@ -69,7 +69,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > `abstract` `protected` **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L12) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L12) #### Parameters @@ -87,7 +87,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:12](https://github. > **push**(`value`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -112,7 +112,7 @@ Current hash list. > **pushIf**(`value`, `condition`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L29) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L29) #### Parameters @@ -134,7 +134,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github. > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableOption.md b/src/pages/docs/reference/protocol/classes/ProvableOption.md index 032d242..d34383f 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableOption.md +++ b/src/pages/docs/reference/protocol/classes/ProvableOption.md @@ -10,7 +10,7 @@ title: ProvableOption # Class: ProvableOption -Defined in: [packages/protocol/src/model/Option.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L11) +Defined in: [packages/protocol/src/model/Option.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L11) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **isSome**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/Option.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L12) +Defined in: [packages/protocol/src/model/Option.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L12) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/Option.ts:12](https://github.com/proto- > **value**: `Field` = `Field` -Defined in: [packages/protocol/src/model/Option.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L13) +Defined in: [packages/protocol/src/model/Option.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L13) #### Inherited from @@ -406,7 +406,7 @@ Convert provable type to a normal JS type. > **toSome**(): [`ProvableOption`](ProvableOption.md) -Defined in: [packages/protocol/src/model/Option.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/Option.ts#L15) +Defined in: [packages/protocol/src/model/Option.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L15) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md b/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md index 132f319..48d5f44 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md +++ b/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md @@ -10,7 +10,7 @@ title: ProvableReductionHashList # Class: ProvableReductionHashList\ -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L5) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L5) Utilities for creating a hash list from a given value type. @@ -32,7 +32,7 @@ Utilities for creating a hash list from a given value type. > **new ProvableReductionHashList**\<`Value`\>(`valueType`, `commitment`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L7) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L7) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.c > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > **unconstrainedList**: `Value`[] = `[]` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) *** @@ -78,7 +78,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https:/ > `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -90,7 +90,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) #### Parameters @@ -112,7 +112,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https: > **push**(`value`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L21) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) Converts the provided value to Field[] and appends it to the current hashlist. @@ -141,7 +141,7 @@ Current hash list. > **pushAndReduce**(`value`, `reduce`): `object` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) #### Parameters @@ -171,7 +171,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https: > **pushIf**(`value`, `condition`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) #### Parameters @@ -197,7 +197,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https: > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md b/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md index 7961355..7675d75 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md +++ b/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md @@ -10,7 +10,7 @@ title: ProvableSettlementHook # Class: `abstract` ProvableSettlementHook\ -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L29) +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L29) Used by various module sub-types that may need to be configured @@ -61,7 +61,7 @@ checks when retrieving it via the getter > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -125,7 +125,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > `abstract` **beforeSettlement**(`smartContract`, `inputs`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L32) +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L32) #### Parameters @@ -147,7 +147,7 @@ Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook. > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -169,7 +169,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md b/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md index 23c20a9..94be00b 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md +++ b/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md @@ -10,7 +10,7 @@ title: ProvableStateTransition # Class: ProvableStateTransition -Defined in: [packages/protocol/src/model/StateTransition.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L10) +Defined in: [packages/protocol/src/model/StateTransition.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L10) Provable representation of a State Transition, used to normalize state transitions of various value types for @@ -58,7 +58,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **from**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` -Defined in: [packages/protocol/src/model/StateTransition.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L14) +Defined in: [packages/protocol/src/model/StateTransition.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L14) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:14](https://github.c > **path**: `Field` = `Field` -Defined in: [packages/protocol/src/model/StateTransition.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L11) +Defined in: [packages/protocol/src/model/StateTransition.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L11) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:11](https://github.c > **to**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` -Defined in: [packages/protocol/src/model/StateTransition.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L17) +Defined in: [packages/protocol/src/model/StateTransition.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L17) #### Inherited from @@ -522,7 +522,7 @@ Convert provable type to a normal JS type. > `static` **dummy**(): [`ProvableStateTransition`](ProvableStateTransition.md) -Defined in: [packages/protocol/src/model/StateTransition.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L19) +Defined in: [packages/protocol/src/model/StateTransition.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L19) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md b/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md index b99111a..6356681 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md +++ b/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md @@ -10,7 +10,7 @@ title: ProvableStateTransitionType # Class: ProvableStateTransitionType -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L27) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L27) ## Extends @@ -46,7 +46,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **type**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L28) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L28) #### Inherited from @@ -344,7 +344,7 @@ Convert provable type to a normal JS type. > **get** `static` **normal**(): [`ProvableStateTransitionType`](ProvableStateTransitionType.md) -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L30) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L30) ##### Returns @@ -358,7 +358,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:30](htt > **get** `static` **protocol**(): [`ProvableStateTransitionType`](ProvableStateTransitionType.md) -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L36) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L36) ##### Returns @@ -370,7 +370,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:36](htt > **isNormal**(): `Bool` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L42) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L42) #### Returns @@ -382,7 +382,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:42](htt > **isProtocol**(): `Bool` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L46) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L46) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md b/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md index 88f8124..67a6fb0 100644 --- a/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md +++ b/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md @@ -10,7 +10,7 @@ title: ProvableTransactionHook # Class: `abstract` ProvableTransactionHook\ -Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProvableTransactionHook.ts#L7) +Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProvableTransactionHook.ts#L7) ## Extends @@ -60,7 +60,7 @@ checks when retrieving it via the getter > `optional` **name**: `string` -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) +Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) #### Inherited from @@ -72,7 +72,7 @@ Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](h > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -136,7 +136,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -158,7 +158,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > `abstract` **onTransaction**(`executionData`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProvableTransactionHook.ts#L10) +Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProvableTransactionHook.ts#L10) #### Parameters @@ -176,7 +176,7 @@ Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:10](https > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/PublicKeyOption.md b/src/pages/docs/reference/protocol/classes/PublicKeyOption.md index 64db171..5174080 100644 --- a/src/pages/docs/reference/protocol/classes/PublicKeyOption.md +++ b/src/pages/docs/reference/protocol/classes/PublicKeyOption.md @@ -10,7 +10,7 @@ title: PublicKeyOption # Class: PublicKeyOption -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L26) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L26) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **isSome**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L5) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L5) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://g > **value**: `PublicKey` = `valueType` -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L6) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L6) #### Inherited from @@ -420,7 +420,7 @@ Convert provable type to a normal JS type. > `static` **fromSome**(`value`): `Generic`\<`PublicKey`\> -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L8) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L8) #### Parameters @@ -442,7 +442,7 @@ Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://g > `static` **none**(`value`): `Generic`\<`PublicKey`\> -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L15) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L15) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md index 2c263ba..f58669c 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md @@ -10,7 +10,7 @@ title: RuntimeMethodExecutionContext # Class: RuntimeMethodExecutionContext -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L54) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L54) Execution context used to wrap runtime module methods, allowing them to post relevant information (such as execution status) @@ -52,7 +52,7 @@ Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d > **input**: `undefined` \| [`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md) -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L57) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L57) *** @@ -60,7 +60,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **methods**: `string`[] = `[]` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L55) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L55) #### Overrides @@ -72,7 +72,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **result**: [`RuntimeProvableMethodExecutionResult`](RuntimeProvableMethodExecutionResult.md) -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L62) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L62) #### Overrides @@ -120,7 +120,7 @@ Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d > **addEvent**(`eventType`, `event`, `eventName`, `condition`): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:83](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L83) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L83) #### Parameters @@ -150,7 +150,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **addStateTransition**\<`Value`\>(`stateTransition`): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L78) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L78) Adds an in-method generated state transition to the current context @@ -176,7 +176,7 @@ State transition to add to the context > **afterMethod**(): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:152](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L152) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:152](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L152) Removes the latest method from the execution context stack, keeping track of the amount of 'unfinished' methods. Allowing @@ -231,7 +231,7 @@ Name of the method being captured in the context > **clear**(): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:148](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L148) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:148](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L148) Manually clears/resets the execution context @@ -249,7 +249,7 @@ Manually clears/resets the execution context > **current**(): `object` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:166](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L166) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:166](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L166) Had to override current() otherwise it would not infer the type of result correctly (parent type would be reused) @@ -309,7 +309,7 @@ which can be collected and ran asynchronously at a later point in time. > **setSimulated**(`simulated`): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:141](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L141) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:141](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L141) #### Parameters @@ -327,7 +327,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **setStatus**(`status`): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L114) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L114) #### Parameters @@ -347,7 +347,7 @@ Execution status of the current method > **setStatusMessage**(`message`?, `stackTrace`?): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L102) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L102) #### Parameters @@ -371,7 +371,7 @@ Status message to acompany the current status > **setup**(`input`): `void` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:125](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L125) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:125](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L125) #### Parameters @@ -391,7 +391,7 @@ Input witness data required for a runtime execution > **witnessInput**(): [`RuntimeMethodExecutionDataStruct`](RuntimeMethodExecutionDataStruct.md) -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L129) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L129) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md index 6a11a86..c43aaae 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md @@ -10,7 +10,7 @@ title: RuntimeMethodExecutionDataStruct # Class: RuntimeMethodExecutionDataStruct -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L41) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L41) ## Extends @@ -54,7 +54,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L44) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L44) #### Implementation of @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L43) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L43) #### Implementation of diff --git a/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md b/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md index 2360f73..e02980c 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md @@ -10,7 +10,7 @@ title: RuntimeProvableMethodExecutionResult # Class: RuntimeProvableMethodExecutionResult -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L19) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L19) ## Extends @@ -48,7 +48,7 @@ Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d > **events**: `object`[] = `[]` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L28) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L28) #### condition @@ -112,7 +112,7 @@ Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d > `optional` **stackTrace**: `string` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L26) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L26) *** @@ -120,7 +120,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **stateTransitions**: [`StateTransition`](StateTransition.md)\<`any`\>[] = `[]` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L20) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L20) *** @@ -128,7 +128,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **status**: `Bool` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L22) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L22) *** @@ -136,7 +136,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > `optional` **statusMessage**: `string` -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L24) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L24) ## Methods diff --git a/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md b/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md index 0255a5c..3c54b9d 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md @@ -10,7 +10,7 @@ title: RuntimeTransaction # Class: RuntimeTransaction -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L11) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L11) This struct is used to expose transaction information to the runtime method execution. This class has not all data included in transactions on purpose. @@ -62,7 +62,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **argsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L13) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L13) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:13](h > **methodId**: `Field` = `Field` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L12) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L12) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:12](h > **nonce**: [`UInt64Option`](UInt64Option.md) = `UInt64Option` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L14) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L14) #### Inherited from @@ -98,7 +98,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:14](h > **sender**: [`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L15) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L15) #### Inherited from @@ -600,7 +600,7 @@ Convert provable type to a normal JS type. > **assertTransactionType**(`isMessage`): `void` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L61) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L61) #### Parameters @@ -618,7 +618,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:61](h > **hash**(): `Field` -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:102](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L102) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L102) #### Returns @@ -630,7 +630,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:102]( > **hashData**(): `Field`[] -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L76) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:76](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L76) #### Returns @@ -642,7 +642,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:76](h > `static` **dummyTransaction**(): [`RuntimeTransaction`](RuntimeTransaction.md) -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L46) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L46) #### Returns @@ -654,7 +654,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:46](h > `static` **fromHashData**(`fields`): [`RuntimeTransaction`](RuntimeTransaction.md) -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L85) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L85) #### Parameters @@ -672,7 +672,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:85](h > `static` **fromMessage**(`__namedParameters`): [`RuntimeTransaction`](RuntimeTransaction.md) -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L31) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L31) #### Parameters @@ -696,7 +696,7 @@ Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:31](h > `static` **fromTransaction**(`input`): [`RuntimeTransaction`](RuntimeTransaction.md) -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L17) +Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L17) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md index 5e74f4e..41f4ff6 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md @@ -10,7 +10,7 @@ title: RuntimeVerificationKeyAttestation # Class: RuntimeVerificationKeyAttestation -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L8) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L8) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **verificationKey**: `VerificationKey` = `VerificationKey` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L9) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L9) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificatio > **witness**: [`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L10) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L10) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md index 9e2c6b3..3496685 100644 --- a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md +++ b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md @@ -10,7 +10,7 @@ title: RuntimeVerificationKeyRootService # Class: RuntimeVerificationKeyRootService -Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L7) +Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L7) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyR > **getRoot**(): `bigint` -Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L14) +Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L14) #### Returns @@ -48,7 +48,7 @@ Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyR > **setRoot**(`root`): `void` -Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L10) +Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/SettlementContractModule.md b/src/pages/docs/reference/protocol/classes/SettlementContractModule.md index 761bd35..d642fdf 100644 --- a/src/pages/docs/reference/protocol/classes/SettlementContractModule.md +++ b/src/pages/docs/reference/protocol/classes/SettlementContractModule.md @@ -10,7 +10,7 @@ title: SettlementContractModule # Class: SettlementContractModule\ -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L46) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L46) Used by various module sub-types that may need to be configured @@ -32,7 +32,7 @@ Used by various module sub-types that may need to be configured > **new SettlementContractModule**\<`SettlementModules`\>(`definition`): [`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L53) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L53) #### Parameters @@ -87,7 +87,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L94) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L94) #### Implementation of @@ -101,7 +101,7 @@ Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:94](ht > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:96](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L96) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:96](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L96) ##### Returns @@ -309,7 +309,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:101](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L101) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:101](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L101) This is a placeholder for individual modules to override. This method will be called whenever the underlying container fully @@ -339,7 +339,7 @@ initialized > **createBridgeContract**(`address`, `tokenId`?): [`BridgeContractType`](../type-aliases/BridgeContractType.md) & `SmartContract` -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:137](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L137) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:137](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L137) #### Parameters @@ -361,7 +361,7 @@ Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:137](h > **createContracts**(`addresses`): `object` -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:119](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L119) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:119](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L119) #### Parameters @@ -422,7 +422,7 @@ features or module checks > **getContractClasses**(): `GetContracts`\<`SettlementModules`\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L109) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L109) #### Returns @@ -673,7 +673,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L105) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L105) #### Returns @@ -718,7 +718,7 @@ such as only injecting other known modules. > `static` **from**\<`SettlementModules`\>(`modules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\>\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L57) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L57) #### Type Parameters @@ -740,7 +740,7 @@ Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:57](ht > `static` **fromDefaults**(): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<\{ `BridgeContract`: *typeof* [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md); `DispatchContract`: *typeof* [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md); `SettlementContract`: *typeof* [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md); \}\>\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L78) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L78) #### Returns @@ -752,7 +752,7 @@ Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:78](ht > `static` **mandatoryModules**(): `object` -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L70) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L70) #### Returns @@ -776,7 +776,7 @@ Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:70](ht > `static` **with**\<`AdditionalModules`\>(`additionalModules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`object` & `AdditionalModules`\>\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L84) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L84) #### Type Parameters diff --git a/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md index 8738c87..d4c47e3 100644 --- a/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md +++ b/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md @@ -10,7 +10,7 @@ title: SettlementContractProtocolModule # Class: SettlementContractProtocolModule -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L34) +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L34) This module type is used to define a contract module that can be used to construct and inject smart contract instances. @@ -29,7 +29,7 @@ ContractType generic. > **new SettlementContractProtocolModule**(`hooks`, `blockProver`, `dispatchContractModule`, `bridgeContractModule`, `childVerificationKeyService`): [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md) -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L38) +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L38) #### Parameters @@ -116,7 +116,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compile**(`registry`): `Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L82) +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L82) #### Parameters @@ -138,7 +138,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtoc > **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L52) +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L52) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md b/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md index 3b98a14..db36dc5 100644 --- a/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md +++ b/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md @@ -10,7 +10,7 @@ title: SettlementSmartContract # Class: SettlementSmartContract -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:433](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L433) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:433](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L433) ## Extends @@ -64,7 +64,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 > **authorizationField**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:446](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L446) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:446](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L446) #### Implementation of @@ -80,7 +80,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **blockHashRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:442](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L442) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:442](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L442) #### Overrides @@ -92,7 +92,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **dispatchContractAddressX**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:444](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L444) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:444](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L444) #### Overrides @@ -104,7 +104,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **events**: `object` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) A list of event types that can be emitted using this.emitEvent()`. @@ -122,7 +122,7 @@ A list of event types that can be emitted using this.emitEvent()`. > **lastSettlementL1BlockHeight**: `State`\<`UInt32`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:438](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L438) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:438](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L438) #### Overrides @@ -134,7 +134,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **networkStateHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:441](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L441) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:441](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L441) #### Overrides @@ -211,7 +211,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > **sequencerKey**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:437](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L437) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:437](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L437) #### Overrides @@ -223,7 +223,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **stateRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:440](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L440) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:440](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L440) #### Overrides @@ -315,7 +315,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) #### BridgeContract @@ -578,7 +578,7 @@ Returns the current AccountUpdate associated to this SmartContract. > **addTokenBridge**(`tokenId`, `address`, `dispatchContract`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:468](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L468) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:468](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L468) #### Parameters @@ -698,7 +698,7 @@ Approve a list of account updates (with arbitrarily many children). > **approveBase**(`forest`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:448](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L448) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:448](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L448) #### Parameters @@ -720,7 +720,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **assertStateRoot**(`root`): `AccountUpdate` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) #### Parameters @@ -814,7 +814,7 @@ async deploy() { > `protected` **deployTokenBridge**(`tokenId`, `address`, `dispatchContractAddress`, `dispatchContractPreconditionEnforced`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) #### Parameters @@ -1043,7 +1043,7 @@ class MyContract extends SmartContract { > **initialize**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:453](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L453) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:453](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L453) #### Parameters @@ -1077,7 +1077,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `protected` **initializeBase**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) #### Parameters @@ -1189,7 +1189,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 > **settle**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:477](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L477) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:477](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L477) #### Parameters @@ -1235,7 +1235,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `protected` **settleBase**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md b/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md index ce4222b..3c9ce86 100644 --- a/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md +++ b/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md @@ -10,7 +10,7 @@ title: SettlementSmartContractBase # Class: `abstract` SettlementSmartContractBase -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L108) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L108) ## Extends @@ -64,7 +64,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 > `abstract` **authorizationField**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:135](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L135) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:135](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L135) *** @@ -72,7 +72,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `abstract` **blockHashRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L132) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L132) *** @@ -80,7 +80,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `abstract` **dispatchContractAddressX**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:133](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L133) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:133](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L133) *** @@ -88,7 +88,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **events**: `object` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) A list of event types that can be emitted using this.emitEvent()`. @@ -106,7 +106,7 @@ A list of event types that can be emitted using this.emitEvent()`. > `abstract` **lastSettlementL1BlockHeight**: `State`\<`UInt32`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L129) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L129) *** @@ -114,7 +114,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `abstract` **networkStateHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:131](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L131) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:131](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L131) *** @@ -187,7 +187,7 @@ Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove tha > `abstract` **sequencerKey**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:128](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L128) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:128](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L128) *** @@ -195,7 +195,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > `abstract` **stateRoot**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L130) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L130) *** @@ -283,7 +283,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 > `static` **args**: `object` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) #### BridgeContract @@ -654,7 +654,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:62 > **assertStateRoot**(`root`): `AccountUpdate` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) #### Parameters @@ -740,7 +740,7 @@ async deploy() { > `protected` **deployTokenBridge**(`tokenId`, `address`, `dispatchContractAddress`, `dispatchContractPreconditionEnforced`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) #### Parameters @@ -965,7 +965,7 @@ class MyContract extends SmartContract { > `protected` **initializeBase**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) #### Parameters @@ -1073,7 +1073,7 @@ Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 > `protected` **settleBase**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/SignedTransaction.md b/src/pages/docs/reference/protocol/classes/SignedTransaction.md index 1046abd..c7625d9 100644 --- a/src/pages/docs/reference/protocol/classes/SignedTransaction.md +++ b/src/pages/docs/reference/protocol/classes/SignedTransaction.md @@ -10,7 +10,7 @@ title: SignedTransaction # Class: SignedTransaction -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L5) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L5) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **signature**: `Signature` = `Signature` -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L7) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L7) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:7](htt > **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L6) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L6) #### Inherited from @@ -516,7 +516,7 @@ Convert provable type to a normal JS type. > **getSignatureData**(): `Field`[] -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L32) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L32) #### Returns @@ -528,7 +528,7 @@ Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:32](ht > **hash**(): `Field` -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L28) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L28) #### Returns @@ -540,7 +540,7 @@ Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:28](ht > **validateSignature**(): `Bool` -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L41) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L41) #### Returns @@ -552,7 +552,7 @@ Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:41](ht > `static` **dummy**(): [`SignedTransaction`](SignedTransaction.md) -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L17) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L17) #### Returns @@ -564,7 +564,7 @@ Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:17](ht > `static` **getSignatureData**(`args`): `Field`[] -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/SignedTransaction.ts#L9) +Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L9) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/State.md b/src/pages/docs/reference/protocol/classes/State.md index 19f0df2..b9c6ff3 100644 --- a/src/pages/docs/reference/protocol/classes/State.md +++ b/src/pages/docs/reference/protocol/classes/State.md @@ -10,7 +10,7 @@ title: State # Class: State\ -Defined in: [packages/protocol/src/state/State.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L42) +Defined in: [packages/protocol/src/state/State.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L42) Utilities for runtime module state, such as get/set @@ -28,7 +28,7 @@ Utilities for runtime module state, such as get/set > **new State**\<`Value`\>(`valueType`): [`State`](State.md)\<`Value`\> -Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L53) +Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L53) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-k > `optional` **path**: `Field` -Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L14) +Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L14) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-k > `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) -Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L26) +Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L26) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-k > **valueType**: `FlexibleProvablePure`\<`Value`\> -Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L53) +Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L53) ## Methods @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-k > **get**(): `Promise`\<[`Option`](Option.md)\<`Value`\>\> -Defined in: [packages/protocol/src/state/State.ts:133](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L133) +Defined in: [packages/protocol/src/state/State.ts:133](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L133) Retrieves the current state and creates a state transition anchoring the use of the current state value in the circuit. @@ -99,7 +99,7 @@ Option representation of the current state. > **hasPathOrFail**(): `asserts this is { path: Path }` -Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L16) +Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L16) #### Returns @@ -115,7 +115,7 @@ Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-k > **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` -Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L28) +Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L28) #### Returns @@ -131,7 +131,7 @@ Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-k > **set**(`value`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/state/State.ts:158](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L158) +Defined in: [packages/protocol/src/state/State.ts:158](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L158) Sets a new state value by creating a state transition from the current value to the newly set value. @@ -159,7 +159,7 @@ Value to be set as the current state > `static` **from**\<`Value`\>(`valueType`): [`State`](State.md)\<`Value`\> -Defined in: [packages/protocol/src/state/State.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L49) +Defined in: [packages/protocol/src/state/State.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L49) Creates a new state wrapper for the provided value type. diff --git a/src/pages/docs/reference/protocol/classes/StateMap.md b/src/pages/docs/reference/protocol/classes/StateMap.md index 08179c2..c8f70ac 100644 --- a/src/pages/docs/reference/protocol/classes/StateMap.md +++ b/src/pages/docs/reference/protocol/classes/StateMap.md @@ -10,7 +10,7 @@ title: StateMap # Class: StateMap\ -Defined in: [packages/protocol/src/state/StateMap.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L12) +Defined in: [packages/protocol/src/state/StateMap.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L12) Map-like wrapper for state @@ -30,7 +30,7 @@ Map-like wrapper for state > **new StateMap**\<`KeyType`, `ValueType`\>(`keyType`, `valueType`): [`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> -Defined in: [packages/protocol/src/state/StateMap.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L30) +Defined in: [packages/protocol/src/state/StateMap.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L30) #### Parameters @@ -56,7 +56,7 @@ Defined in: [packages/protocol/src/state/StateMap.ts:30](https://github.com/prot > **keyType**: `FlexibleProvablePure`\<`KeyType`\> -Defined in: [packages/protocol/src/state/StateMap.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L31) +Defined in: [packages/protocol/src/state/StateMap.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L31) *** @@ -64,7 +64,7 @@ Defined in: [packages/protocol/src/state/StateMap.ts:31](https://github.com/prot > `optional` **path**: `Field` -Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L14) +Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L14) #### Inherited from @@ -76,7 +76,7 @@ Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-k > `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) -Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L26) +Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L26) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-k > **valueType**: `FlexibleProvablePure`\<`ValueType`\> -Defined in: [packages/protocol/src/state/StateMap.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L32) +Defined in: [packages/protocol/src/state/StateMap.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L32) ## Methods @@ -96,7 +96,7 @@ Defined in: [packages/protocol/src/state/StateMap.ts:32](https://github.com/prot > **get**(`key`): `Promise`\<[`Option`](Option.md)\<`ValueType`\>\> -Defined in: [packages/protocol/src/state/StateMap.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L48) +Defined in: [packages/protocol/src/state/StateMap.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L48) Obtains a value for the provided key in the current state map. @@ -120,7 +120,7 @@ Value for the provided key. > **getPath**(`key`): `Field` -Defined in: [packages/protocol/src/state/StateMap.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L37) +Defined in: [packages/protocol/src/state/StateMap.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L37) #### Parameters @@ -138,7 +138,7 @@ Defined in: [packages/protocol/src/state/StateMap.ts:37](https://github.com/prot > **hasPathOrFail**(): `asserts this is { path: Path }` -Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L16) +Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L16) #### Returns @@ -154,7 +154,7 @@ Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-k > **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` -Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L28) +Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L28) #### Returns @@ -170,7 +170,7 @@ Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-k > **set**(`key`, `value`): `Promise`\<`void`\> -Defined in: [packages/protocol/src/state/StateMap.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L64) +Defined in: [packages/protocol/src/state/StateMap.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L64) Sets a value for the given key in the current state map. @@ -198,7 +198,7 @@ Value to be stored under the given key > `static` **from**\<`KeyType`, `ValueType`\>(`keyType`, `valueType`): [`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> -Defined in: [packages/protocol/src/state/StateMap.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateMap.ts#L23) +Defined in: [packages/protocol/src/state/StateMap.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L23) Create a new state map with the given key and value types diff --git a/src/pages/docs/reference/protocol/classes/StateServiceProvider.md b/src/pages/docs/reference/protocol/classes/StateServiceProvider.md index 794a280..e315b12 100644 --- a/src/pages/docs/reference/protocol/classes/StateServiceProvider.md +++ b/src/pages/docs/reference/protocol/classes/StateServiceProvider.md @@ -10,7 +10,7 @@ title: StateServiceProvider # Class: StateServiceProvider -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateServiceProvider.ts#L14) +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateServiceProvider.ts#L14) ## Constructors @@ -30,7 +30,7 @@ Defined in: [packages/protocol/src/state/StateServiceProvider.ts:14](https://git > **get** **stateService**(): [`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateServiceProvider.ts#L17) +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateServiceProvider.ts#L17) ##### Returns @@ -42,7 +42,7 @@ Defined in: [packages/protocol/src/state/StateServiceProvider.ts:17](https://git > **popCurrentStateService**(): `void` -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateServiceProvider.ts#L30) +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateServiceProvider.ts#L30) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/protocol/src/state/StateServiceProvider.ts:30](https://git > **setCurrentStateService**(`service`): `void` -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateServiceProvider.ts#L26) +Defined in: [packages/protocol/src/state/StateServiceProvider.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateServiceProvider.ts#L26) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/StateTransition.md b/src/pages/docs/reference/protocol/classes/StateTransition.md index 3aae030..e529e11 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransition.md +++ b/src/pages/docs/reference/protocol/classes/StateTransition.md @@ -10,7 +10,7 @@ title: StateTransition # Class: StateTransition\ -Defined in: [packages/protocol/src/model/StateTransition.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L32) +Defined in: [packages/protocol/src/model/StateTransition.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L32) Generic state transition that constraints the current method circuit to external state, by providing a state anchor. @@ -25,7 +25,7 @@ to external state, by providing a state anchor. > **new StateTransition**\<`Value`\>(`path`, `fromValue`, `toValue`): [`StateTransition`](StateTransition.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L45) +Defined in: [packages/protocol/src/model/StateTransition.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L45) #### Parameters @@ -51,7 +51,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:45](https://github.c > **fromValue**: [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L47) +Defined in: [packages/protocol/src/model/StateTransition.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L47) *** @@ -59,7 +59,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:47](https://github.c > **path**: `Field` -Defined in: [packages/protocol/src/model/StateTransition.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L46) +Defined in: [packages/protocol/src/model/StateTransition.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L46) *** @@ -67,7 +67,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:46](https://github.c > **toValue**: [`Option`](Option.md)\<`Field`\> \| [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L48) +Defined in: [packages/protocol/src/model/StateTransition.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L48) ## Accessors @@ -77,7 +77,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:48](https://github.c > **get** **from**(): [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L51) +Defined in: [packages/protocol/src/model/StateTransition.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L51) ##### Returns @@ -91,7 +91,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:51](https://github.c > **get** **to**(): [`Option`](Option.md)\<`Field`\> \| [`Option`](Option.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L57) +Defined in: [packages/protocol/src/model/StateTransition.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L57) ##### Returns @@ -103,7 +103,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:57](https://github.c > **toConstant**(): [`StateTransition`](StateTransition.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L81) +Defined in: [packages/protocol/src/model/StateTransition.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L81) #### Returns @@ -115,7 +115,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:81](https://github.c > **toJSON**(): `object` -Defined in: [packages/protocol/src/model/StateTransition.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L73) +Defined in: [packages/protocol/src/model/StateTransition.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L73) #### Returns @@ -163,7 +163,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:73](https://github.c > **toProvable**(): [`ProvableStateTransition`](ProvableStateTransition.md) -Defined in: [packages/protocol/src/model/StateTransition.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L65) +Defined in: [packages/protocol/src/model/StateTransition.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L65) Converts a StateTransition to a ProvableStateTransition, while enforcing the 'from' property to be 'Some' in all cases. @@ -178,7 +178,7 @@ while enforcing the 'from' property to be 'Some' in all cases. > `static` **from**\<`Value`\>(`path`, `fromValue`): [`StateTransition`](StateTransition.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L33) +Defined in: [packages/protocol/src/model/StateTransition.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L33) #### Type Parameters @@ -204,7 +204,7 @@ Defined in: [packages/protocol/src/model/StateTransition.ts:33](https://github.c > `static` **fromTo**\<`Value`\>(`path`, `fromValue`, `toValue`): [`StateTransition`](StateTransition.md)\<`Value`\> -Defined in: [packages/protocol/src/model/StateTransition.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransition.ts#L37) +Defined in: [packages/protocol/src/model/StateTransition.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L37) #### Type Parameters diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md b/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md index ff3f35d..97569e0 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md @@ -10,7 +10,7 @@ title: StateTransitionProvableBatch # Class: StateTransitionProvableBatch -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L58) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L58) A Batch of StateTransitions to be consumed by the StateTransitionProver to prove multiple STs at once @@ -28,7 +28,7 @@ true == normal ST, false == protocol ST > **batch**: [`ProvableStateTransition`](ProvableStateTransition.md)[] -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L59) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L59) #### Inherited from @@ -40,7 +40,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:59](htt > **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L69) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L69) #### Inherited from @@ -52,7 +52,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:69](htt > **transitionTypes**: [`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L64) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L64) #### Inherited from @@ -444,7 +444,7 @@ Convert provable type to a normal JS type. > `static` **fromMappings**(`transitions`, `merkleWitnesses`): [`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L74) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L74) #### Parameters @@ -466,7 +466,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:74](htt > `static` **fromTransitions**(`transitions`, `protocolTransitions`, `merkleWitnesses`): [`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:111](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L111) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:111](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L111) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProver.md b/src/pages/docs/reference/protocol/classes/StateTransitionProver.md index 02d0da9..7fa408a 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProver.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProver.md @@ -10,7 +10,7 @@ title: StateTransitionProver # Class: StateTransitionProver -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:343](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L343) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:343](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L343) Used by various module sub-types that may need to be configured @@ -30,7 +30,7 @@ Used by various module sub-types that may need to be configured > **new StateTransitionProver**(): [`StateTransitionProver`](StateTransitionProver.md) -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:352](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L352) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:352](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L352) #### Returns @@ -65,7 +65,7 @@ checks when retrieving it via the getter > `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Implementation of @@ -81,7 +81,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **zkProgrammable**: [`StateTransitionProverProgrammable`](StateTransitionProverProgrammable.md) -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:350](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L350) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:350](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L350) #### Implementation of @@ -95,7 +95,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -153,7 +153,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:357](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L357) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:357](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L357) #### Parameters @@ -175,7 +175,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -201,7 +201,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:370](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L370) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:370](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L370) #### Parameters @@ -231,7 +231,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **runBatch**(`publicInput`, `batch`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:363](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L363) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:363](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L363) #### Parameters @@ -257,7 +257,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md index 774d879..9f254ac 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md @@ -10,7 +10,7 @@ title: StateTransitionProverProgrammable # Class: StateTransitionProverProgrammable -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L74) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L74) StateTransitionProver is the prover that proves the application of some state transitions and checks and updates their merkle-tree entries @@ -25,7 +25,7 @@ transitions and checks and updates their merkle-tree entries > **new StateTransitionProverProgrammable**(`stateTransitionProver`): [`StateTransitionProverProgrammable`](StateTransitionProverProgrammable.md) -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L78) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L78) #### Parameters @@ -49,7 +49,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L84) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L84) ##### Returns @@ -83,7 +83,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:34 > **applyTransition**(`state`, `transition`, `type`, `merkleWitness`, `index`): `void` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:197](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L197) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:197](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L197) Applies a single state transition to the given state and mutates it in place @@ -120,7 +120,7 @@ and mutates it in place > **applyTransitions**(`stateRoot`, `protocolStateRoot`, `stateTransitionCommitmentFrom`, `protocolTransitionCommitmentFrom`, `transitionBatch`): `StateTransitionProverExecutionState` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:151](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L151) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:151](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L151) Applies the state transitions to the current stateRoot and returns the new prover state @@ -179,7 +179,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:35 > **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:267](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L267) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:267](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L267) #### Parameters @@ -205,7 +205,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver. > **runBatch**(`publicInput`, `batch`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:246](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L246) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:246](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L246) Applies a whole batch of StateTransitions at once @@ -229,7 +229,7 @@ Applies a whole batch of StateTransitions at once > **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\>[] -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L88) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L88) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md index 9235731..a049be6 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md @@ -10,7 +10,7 @@ title: StateTransitionProverPublicInput # Class: StateTransitionProverPublicInput -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L6) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L6) ## Extends @@ -58,7 +58,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **protocolStateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L10) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L10) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **protocolTransitionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L8) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L8) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **stateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L9) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L9) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **stateTransitionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L7) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L7) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md index 7a677ff..3709b0e 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md @@ -10,7 +10,7 @@ title: StateTransitionProverPublicOutput # Class: StateTransitionProverPublicOutput -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L13) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L13) ## Extends @@ -58,7 +58,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **protocolStateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L17) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L17) #### Inherited from @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **protocolTransitionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L15) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L15) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **stateRoot**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L16) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L16) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **stateTransitionsHash**: `Field` = `Field` -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L14) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L14) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md b/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md index cf0d88c..c10ac5d 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md @@ -10,7 +10,7 @@ title: StateTransitionReductionList # Class: StateTransitionReductionList -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/StateTransitionReductionList.ts#L11) +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/StateTransitionReductionList.ts#L11) Utilities for creating a hash list from a given value type. @@ -24,7 +24,7 @@ Utilities for creating a hash list from a given value type. > **new StateTransitionReductionList**(`valueType`, `commitment`): [`StateTransitionReductionList`](StateTransitionReductionList.md) -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L7) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L7) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.c > **commitment**: `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L9) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.c > **unconstrainedList**: [`ProvableStateTransition`](ProvableStateTransition.md)[] = `[]` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https:/ > `protected` `readonly` **valueType**: `ProvablePure`\<[`ProvableStateTransition`](ProvableStateTransition.md)\> -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L8) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) #### Inherited from @@ -86,7 +86,7 @@ Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.c > **hash**(`elements`): `Field` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) #### Parameters @@ -108,7 +108,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https: > **push**(`value`): [`StateTransitionReductionList`](StateTransitionReductionList.md) -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/StateTransitionReductionList.ts#L12) +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/StateTransitionReductionList.ts#L12) Converts the provided value to Field[] and appends it to the current hashlist. @@ -137,7 +137,7 @@ Current hash list. > **pushAndReduce**(`value`, `reduce`): `object` -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) #### Parameters @@ -171,7 +171,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https: > **pushIf**(`value`, `condition`): [`StateTransitionReductionList`](StateTransitionReductionList.md) -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) +Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) #### Parameters @@ -197,7 +197,7 @@ Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https: > **pushWithMetadata**(`value`): `object` -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/StateTransitionReductionList.ts#L18) +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/StateTransitionReductionList.ts#L18) #### Parameters @@ -223,7 +223,7 @@ Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:18](htt > **toField**(): `Field` -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/ProvableHashList.ts#L41) +Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionType.md b/src/pages/docs/reference/protocol/classes/StateTransitionType.md index cf40f13..77bec3d 100644 --- a/src/pages/docs/reference/protocol/classes/StateTransitionType.md +++ b/src/pages/docs/reference/protocol/classes/StateTransitionType.md @@ -10,7 +10,7 @@ title: StateTransitionType # Class: StateTransitionType -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L13) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L13) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:13](htt > `readonly` `static` **normal**: `true` = `true` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L14) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L14) *** @@ -36,7 +36,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:14](htt > `readonly` `static` **protocol**: `false` = `false` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L16) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L16) ## Methods @@ -44,7 +44,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:16](htt > `static` **isNormal**(`type`): `boolean` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L18) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L18) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:18](htt > `static` **isProtocol**(`type`): `boolean` -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/StateTransitionProvableBatch.ts#L22) +Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L22) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md b/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md index 36fa50c..78e2069 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md @@ -10,7 +10,7 @@ title: TokenBridgeAttestation # Class: TokenBridgeAttestation -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L65) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L65) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **index**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:67](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L67) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L67) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:67](h > **witness**: [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L66) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L66) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md b/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md index c1e188e..19557f5 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md @@ -10,7 +10,7 @@ title: TokenBridgeDeploymentAuth # Class: TokenBridgeDeploymentAuth -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L5) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L5) Interface for cross-contract call authorization See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 @@ -61,7 +61,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **address**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L9) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L9) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBrid > **target**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L7) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L7) #### Implementation of @@ -89,7 +89,7 @@ Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBrid > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L8) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L8) #### Inherited from @@ -497,7 +497,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L13) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L13) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md b/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md index 848df15..621939e 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md @@ -10,7 +10,7 @@ title: TokenBridgeEntry # Class: TokenBridgeEntry -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L56) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L56) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **address**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L57) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L57) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:57](h > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L58) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L58) #### Inherited from @@ -414,7 +414,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L60) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L60) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md index 9c127fa..f9f0897 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md @@ -10,7 +10,7 @@ title: TokenBridgeTree # Class: TokenBridgeTree -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L15) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L15) Merkle tree that contains all the deployed token bridges as a mapping of tokenId => PublicKey @@ -50,7 +50,7 @@ Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:113 > **indizes**: `Record`\<`string`, `bigint`\> = `{}` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L16) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L16) *** @@ -194,7 +194,7 @@ Values to fill the leaves with. > **getIndex**(`tokenId`): `bigint` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L49) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L49) #### Parameters @@ -328,7 +328,7 @@ New value. > `static` **buildTreeFromEvents**(`contract`): `Promise`\<[`TokenBridgeTree`](TokenBridgeTree.md)\> -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L22) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L22) Initializes and fills the tree based on all on-chain events that have been emitted by every emit diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md index e4af8b4..674bc84 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md @@ -10,7 +10,7 @@ title: TokenBridgeTreeAddition # Class: TokenBridgeTreeAddition -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L70) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L70) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **index**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L71) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L71) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:71](h > **value**: [`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L72) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L72) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md index 13f34c2..d3bbfad 100644 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md +++ b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md @@ -10,7 +10,7 @@ title: TokenBridgeTreeWitness # Class: TokenBridgeTreeWitness -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L54) +Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L54) ## Extends diff --git a/src/pages/docs/reference/protocol/classes/TokenMapping.md b/src/pages/docs/reference/protocol/classes/TokenMapping.md index d09c6b4..e9fa6fb 100644 --- a/src/pages/docs/reference/protocol/classes/TokenMapping.md +++ b/src/pages/docs/reference/protocol/classes/TokenMapping.md @@ -10,7 +10,7 @@ title: TokenMapping # Class: TokenMapping -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L60) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L60) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **publicKey**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L62) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L62) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L61) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L61) #### Inherited from diff --git a/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md b/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md index f1d5d2d..5648b69 100644 --- a/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md +++ b/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md @@ -10,7 +10,7 @@ title: TransitionMethodExecutionResult # Class: TransitionMethodExecutionResult -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L3) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L3) ## Constructors @@ -28,4 +28,4 @@ Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContex > **stateTransitions**: [`StateTransition`](StateTransition.md)\<`any`\>[] = `[]` -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L4) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L4) diff --git a/src/pages/docs/reference/protocol/classes/UInt64Option.md b/src/pages/docs/reference/protocol/classes/UInt64Option.md index 50c1cdc..1014a56 100644 --- a/src/pages/docs/reference/protocol/classes/UInt64Option.md +++ b/src/pages/docs/reference/protocol/classes/UInt64Option.md @@ -10,7 +10,7 @@ title: UInt64Option # Class: UInt64Option -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L24) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L24) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **isSome**: `Bool` = `Bool` -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L5) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L5) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://g > **value**: `UInt64` = `valueType` -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L6) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L6) #### Inherited from @@ -420,7 +420,7 @@ Convert provable type to a normal JS type. > `static` **fromSome**(`value`): `Generic`\<`UInt64`\> -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L8) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L8) #### Parameters @@ -442,7 +442,7 @@ Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://g > `static` **none**(`value`): `Generic`\<`UInt64`\> -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/transaction/ValueOption.ts#L15) +Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L15) #### Parameters diff --git a/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md b/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md index 531f5f6..3f96a26 100644 --- a/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md +++ b/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md @@ -10,7 +10,7 @@ title: UpdateMessagesHashAuth # Class: UpdateMessagesHashAuth -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L5) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L5) Interface for cross-contract call authorization See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 @@ -61,7 +61,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **executedMessagesHash**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L8) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L8) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMes > **newPromisedMessagesHash**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L9) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L9) #### Inherited from @@ -85,7 +85,7 @@ Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMes > **target**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L7) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L7) #### Implementation of @@ -489,7 +489,7 @@ Convert provable type to a normal JS type. > **hash**(): `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L13) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L13) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/VKTree.md b/src/pages/docs/reference/protocol/classes/VKTree.md index c7f14ce..e1fd47a 100644 --- a/src/pages/docs/reference/protocol/classes/VKTree.md +++ b/src/pages/docs/reference/protocol/classes/VKTree.md @@ -10,7 +10,7 @@ title: VKTree # Class: VKTree -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L5) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L5) ## Extends diff --git a/src/pages/docs/reference/protocol/classes/VKTreeWitness.md b/src/pages/docs/reference/protocol/classes/VKTreeWitness.md index f5577dd..ac29e6d 100644 --- a/src/pages/docs/reference/protocol/classes/VKTreeWitness.md +++ b/src/pages/docs/reference/protocol/classes/VKTreeWitness.md @@ -10,7 +10,7 @@ title: VKTreeWitness # Class: VKTreeWitness -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L6) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L6) ## Extends diff --git a/src/pages/docs/reference/protocol/classes/WithPath.md b/src/pages/docs/reference/protocol/classes/WithPath.md index fb102df..6ba374e 100644 --- a/src/pages/docs/reference/protocol/classes/WithPath.md +++ b/src/pages/docs/reference/protocol/classes/WithPath.md @@ -10,7 +10,7 @@ title: WithPath # Class: WithPath -Defined in: [packages/protocol/src/state/State.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L13) +Defined in: [packages/protocol/src/state/State.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L13) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/protocol/src/state/State.ts:13](https://github.com/proto-k > `optional` **path**: `Field` -Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L14) +Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L14) ## Methods @@ -36,7 +36,7 @@ Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-k > **hasPathOrFail**(): `asserts this is { path: Path }` -Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L16) +Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L16) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md b/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md index 248c142..360f911 100644 --- a/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md +++ b/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md @@ -10,7 +10,7 @@ title: WithStateServiceProvider # Class: WithStateServiceProvider -Defined in: [packages/protocol/src/state/State.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L25) +Defined in: [packages/protocol/src/state/State.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L25) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/protocol/src/state/State.ts:25](https://github.com/proto-k > `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) -Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L26) +Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L26) ## Methods @@ -36,7 +36,7 @@ Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-k > **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` -Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/State.ts#L28) +Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L28) #### Returns diff --git a/src/pages/docs/reference/protocol/classes/Withdrawal.md b/src/pages/docs/reference/protocol/classes/Withdrawal.md index 5715695..3d480b5 100644 --- a/src/pages/docs/reference/protocol/classes/Withdrawal.md +++ b/src/pages/docs/reference/protocol/classes/Withdrawal.md @@ -10,7 +10,7 @@ title: Withdrawal # Class: Withdrawal -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Withdrawal.ts#L4) +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Withdrawal.ts#L4) ## Extends @@ -54,7 +54,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **address**: `PublicKey` = `PublicKey` -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Withdrawal.ts#L6) +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Withdrawal.ts#L6) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:6](https:// > **amount**: `UInt64` = `UInt64` -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Withdrawal.ts#L7) +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Withdrawal.ts#L7) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:7](https:// > **tokenId**: `Field` = `Field` -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Withdrawal.ts#L5) +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Withdrawal.ts#L5) #### Inherited from @@ -478,7 +478,7 @@ Convert provable type to a normal JS type. > `static` **dummy**(): [`Withdrawal`](Withdrawal.md) -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/Withdrawal.ts#L9) +Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Withdrawal.ts#L9) #### Returns diff --git a/src/pages/docs/reference/protocol/functions/assert.md b/src/pages/docs/reference/protocol/functions/assert.md index ad83ea0..1c5128e 100644 --- a/src/pages/docs/reference/protocol/functions/assert.md +++ b/src/pages/docs/reference/protocol/functions/assert.md @@ -12,7 +12,7 @@ title: assert > **assert**(`condition`, `message`?): `void` -Defined in: [packages/protocol/src/state/assert/assert.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/assert/assert.ts#L16) +Defined in: [packages/protocol/src/state/assert/assert.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/assert/assert.ts#L16) Maintains an execution status of the current runtime module method, while prioritizing one-time failures. The assertion won't change the diff --git a/src/pages/docs/reference/protocol/functions/emptyActions.md b/src/pages/docs/reference/protocol/functions/emptyActions.md index fac75bf..80ccfd0 100644 --- a/src/pages/docs/reference/protocol/functions/emptyActions.md +++ b/src/pages/docs/reference/protocol/functions/emptyActions.md @@ -12,7 +12,7 @@ title: emptyActions > **emptyActions**(): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L20) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L20) ## Returns diff --git a/src/pages/docs/reference/protocol/functions/emptyEvents.md b/src/pages/docs/reference/protocol/functions/emptyEvents.md index 3ce3340..f0055a9 100644 --- a/src/pages/docs/reference/protocol/functions/emptyEvents.md +++ b/src/pages/docs/reference/protocol/functions/emptyEvents.md @@ -12,7 +12,7 @@ title: emptyEvents > **emptyEvents**(): `Field` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L24) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L24) ## Returns diff --git a/src/pages/docs/reference/protocol/functions/notInCircuit.md b/src/pages/docs/reference/protocol/functions/notInCircuit.md index 2b494f3..55b1e5f 100644 --- a/src/pages/docs/reference/protocol/functions/notInCircuit.md +++ b/src/pages/docs/reference/protocol/functions/notInCircuit.md @@ -12,7 +12,7 @@ title: notInCircuit > **notInCircuit**(): `MethodDecorator` -Defined in: [packages/protocol/src/utils/utils.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/utils.ts#L16) +Defined in: [packages/protocol/src/utils/utils.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/utils.ts#L16) ## Returns diff --git a/src/pages/docs/reference/protocol/functions/protocolState.md b/src/pages/docs/reference/protocol/functions/protocolState.md index f95aaaf..ec2a360 100644 --- a/src/pages/docs/reference/protocol/functions/protocolState.md +++ b/src/pages/docs/reference/protocol/functions/protocolState.md @@ -12,7 +12,7 @@ title: protocolState > **protocolState**(): \<`TargetTransitioningModule`\>(`target`, `propertyKey`) => `void` -Defined in: [packages/protocol/src/state/protocol/ProtocolState.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/protocol/ProtocolState.ts#L23) +Defined in: [packages/protocol/src/state/protocol/ProtocolState.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/protocol/ProtocolState.ts#L23) Decorates a runtime module property as state, passing down some underlying values to improve developer experience. diff --git a/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md b/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md index aed8377..5066c32 100644 --- a/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md +++ b/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md @@ -12,7 +12,7 @@ title: reduceStateTransitions > **reduceStateTransitions**(`transitions`): [`StateTransition`](../classes/StateTransition.md)\<`unknown`\>[] -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/StateTransitionReductionList.ts#L61) +Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/StateTransitionReductionList.ts#L61) ## Parameters diff --git a/src/pages/docs/reference/protocol/functions/singleFieldToString.md b/src/pages/docs/reference/protocol/functions/singleFieldToString.md index 2894de3..658dd59 100644 --- a/src/pages/docs/reference/protocol/functions/singleFieldToString.md +++ b/src/pages/docs/reference/protocol/functions/singleFieldToString.md @@ -12,7 +12,7 @@ title: singleFieldToString > **singleFieldToString**(`value`): `string` -Defined in: [packages/protocol/src/utils/utils.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/utils.ts#L69) +Defined in: [packages/protocol/src/utils/utils.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/utils.ts#L69) ## Parameters diff --git a/src/pages/docs/reference/protocol/functions/stringToField.md b/src/pages/docs/reference/protocol/functions/stringToField.md index 8e9950a..65da906 100644 --- a/src/pages/docs/reference/protocol/functions/stringToField.md +++ b/src/pages/docs/reference/protocol/functions/stringToField.md @@ -12,7 +12,7 @@ title: stringToField > **stringToField**(`value`): `Field` -Defined in: [packages/protocol/src/utils/utils.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/utils.ts#L36) +Defined in: [packages/protocol/src/utils/utils.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/utils.ts#L36) ## Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProvable.md b/src/pages/docs/reference/protocol/interfaces/BlockProvable.md index 4adad24..ea50578 100644 --- a/src/pages/docs/reference/protocol/interfaces/BlockProvable.md +++ b/src/pages/docs/reference/protocol/interfaces/BlockProvable.md @@ -10,7 +10,7 @@ title: BlockProvable # Interface: BlockProvable -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L75) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L75) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:75](https://git > **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L94) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L94) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://git > **proveBlock**: (`publicInput`, `networkState`, `blockWitness`, `transactionProof`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L86) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L86) #### Parameters @@ -82,7 +82,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://git > **proveTransaction**: (`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L78) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L78) #### Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProverState.md b/src/pages/docs/reference/protocol/interfaces/BlockProverState.md index eddc1fe..c502d5d 100644 --- a/src/pages/docs/reference/protocol/interfaces/BlockProverState.md +++ b/src/pages/docs/reference/protocol/interfaces/BlockProverState.md @@ -10,7 +10,7 @@ title: BlockProverState # Interface: BlockProverState -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L98) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:98](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L98) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:98](https://githu > **blockHashRoot**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:120](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L120) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:120](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L120) The root of the merkle tree encoding all block hashes, see `BlockHashMerkleTree` @@ -29,7 +29,7 @@ see `BlockHashMerkleTree` > **eternalTransactionsHash**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:127](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L127) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:127](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L127) A variant of the transactionsHash that is never reset. Thought for usage in the sequence state mempool. @@ -41,7 +41,7 @@ In comparison, transactionsHash restarts at 0 for every new block > **incomingMessagesHash**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L129) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L129) *** @@ -49,7 +49,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProver.ts:129](https://gith > **networkStateHash**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L114) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L114) The network state which gives access to values such as blockHeight This value is the same for the whole batch (L2 block) @@ -60,7 +60,7 @@ This value is the same for the whole batch (L2 block) > **stateRoot**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:102](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L102) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L102) The current state root of the block prover @@ -70,7 +70,7 @@ The current state root of the block prover > **transactionsHash**: `Field` -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L108) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L108) The current commitment of the transaction-list which will at the end equal the bundle hash diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProverType.md b/src/pages/docs/reference/protocol/interfaces/BlockProverType.md index a6af316..c777716 100644 --- a/src/pages/docs/reference/protocol/interfaces/BlockProverType.md +++ b/src/pages/docs/reference/protocol/interfaces/BlockProverType.md @@ -10,7 +10,7 @@ title: BlockProverType # Interface: BlockProverType -Defined in: [packages/protocol/src/protocol/Protocol.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L41) +Defined in: [packages/protocol/src/protocol/Protocol.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L47) Used by various module sub-types that may need to be configured @@ -39,7 +39,7 @@ checks when retrieving it via the getter > **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L94) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L94) #### Parameters @@ -69,7 +69,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://git > `optional` **protocol**: [`ProtocolEnvironment`](ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **proveBlock**: (`publicInput`, `networkState`, `blockWitness`, `transactionProof`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L86) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L86) #### Parameters @@ -115,7 +115,7 @@ Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://git > **proveTransaction**: (`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L78) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L78) #### Parameters @@ -167,7 +167,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -239,7 +239,7 @@ Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -261,7 +261,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md b/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md index f67feb9..5570de3 100644 --- a/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md +++ b/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md @@ -10,7 +10,7 @@ title: ContractAuthorization # Interface: ContractAuthorization -Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L7) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L7) Interface for cross-contract call authorization See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 @@ -21,7 +21,7 @@ See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 > **hash**: () => `Field` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L10) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L10) #### Returns @@ -33,4 +33,4 @@ Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractA > **target**: `PublicKey` -Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L8) +Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L8) diff --git a/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md b/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md index 6ae0ee0..abaa90a 100644 --- a/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md +++ b/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md @@ -10,7 +10,7 @@ title: DispatchContractType # Interface: DispatchContractType -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L40) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L40) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **enableTokenDeposits**: (`tokenId`, `bridgeContractAddress`, `settlementContractAddress`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L46) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L46) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **initialize**: (`settlementContract`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L45) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L45) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **promisedMessagesHash**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L52) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L52) *** @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts > **updateMessagesHash**: (`executedMessagesHash`, `newPromisedMessagesHash`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L41) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L41) #### Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md b/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md index 0082c7e..36e8b56 100644 --- a/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md +++ b/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md @@ -10,7 +10,7 @@ title: MinimalVKTreeService # Interface: MinimalVKTreeService -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L22) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L22) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificatio > **getRoot**: () => `bigint` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L23) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L23) #### Returns diff --git a/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md b/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md index cabbd0f..19352d0 100644 --- a/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md +++ b/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md @@ -10,7 +10,7 @@ title: ProtocolDefinition # Interface: ProtocolDefinition\ -Defined in: [packages/protocol/src/protocol/Protocol.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L55) +Defined in: [packages/protocol/src/protocol/Protocol.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L61) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [packages/protocol/src/protocol/Protocol.ts:55](https://github.com/p > `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L57) +Defined in: [packages/protocol/src/protocol/Protocol.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L63) *** @@ -30,4 +30,4 @@ Defined in: [packages/protocol/src/protocol/Protocol.ts:57](https://github.com/p > **modules**: `Modules` -Defined in: [packages/protocol/src/protocol/Protocol.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L56) +Defined in: [packages/protocol/src/protocol/Protocol.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L62) diff --git a/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md b/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md index 938a576..61b8295 100644 --- a/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md +++ b/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md @@ -10,7 +10,7 @@ title: ProtocolEnvironment # Interface: ProtocolEnvironment -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolEnvironment.ts#L6) +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolEnvironment.ts#L6) ## Accessors @@ -20,7 +20,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:6](https://gi > **get** **stateService**(): [`SimpleAsyncStateService`](SimpleAsyncStateService.md) -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolEnvironment.ts#L7) +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolEnvironment.ts#L7) ##### Returns @@ -34,7 +34,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:7](https://gi > **get** **stateServiceProvider**(): [`StateServiceProvider`](../classes/StateServiceProvider.md) -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolEnvironment.ts#L8) +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolEnvironment.ts#L8) ##### Returns @@ -46,7 +46,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:8](https://gi > **getAreProofsEnabled**(): [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolEnvironment.ts#L9) +Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolEnvironment.ts#L9) #### Returns diff --git a/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md b/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md index 1610467..f63a18e 100644 --- a/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md +++ b/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md @@ -10,7 +10,7 @@ title: RuntimeLike # Interface: RuntimeLike -Defined in: [packages/protocol/src/model/RuntimeLike.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/RuntimeLike.ts#L8) +Defined in: [packages/protocol/src/model/RuntimeLike.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/RuntimeLike.ts#L8) ## Accessors @@ -20,7 +20,7 @@ Defined in: [packages/protocol/src/model/RuntimeLike.ts:8](https://github.com/pr > **get** **methodIdResolver**(): `object` -Defined in: [packages/protocol/src/model/RuntimeLike.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/RuntimeLike.ts#L9) +Defined in: [packages/protocol/src/model/RuntimeLike.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/RuntimeLike.ts#L9) ##### Returns diff --git a/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md b/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md index 70d048b..014037a 100644 --- a/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md +++ b/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md @@ -10,7 +10,7 @@ title: RuntimeMethodExecutionData # Interface: RuntimeMethodExecutionData -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L36) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L36) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **networkState**: [`NetworkState`](../classes/NetworkState.md) -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L38) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L38) *** @@ -26,4 +26,4 @@ Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.t > **transaction**: [`RuntimeTransaction`](../classes/RuntimeTransaction.md) -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L37) +Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L37) diff --git a/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md b/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md index ef01657..4f85ba5 100644 --- a/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md +++ b/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md @@ -10,7 +10,7 @@ title: SettlementContractType # Interface: SettlementContractType -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L65) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L65) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **addTokenBridge**: (`tokenId`, `address`, `dispatchContract`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L84) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L84) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **assertStateRoot**: (`root`) => `AccountUpdate` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L74) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L74) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **authorizationField**: `State`\<`Field`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L66) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L66) *** @@ -70,7 +70,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **initialize**: (`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L68) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L68) #### Parameters @@ -100,7 +100,7 @@ Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract. > **settle**: (`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L75) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L75) #### Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md b/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md index 0dd1337..53c003d 100644 --- a/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md +++ b/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md @@ -10,7 +10,7 @@ title: SimpleAsyncStateService # Interface: SimpleAsyncStateService -Defined in: [packages/protocol/src/state/StateService.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateService.ts#L3) +Defined in: [packages/protocol/src/state/StateService.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateService.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/state/StateService.ts:3](https://github.com/p > **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/protocol/src/state/StateService.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateService.ts#L4) +Defined in: [packages/protocol/src/state/StateService.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateService.ts#L4) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/protocol/src/state/StateService.ts:4](https://github.com/p > **set**: (`key`, `value`) => `Promise`\<`void`\> -Defined in: [packages/protocol/src/state/StateService.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/StateService.ts#L5) +Defined in: [packages/protocol/src/state/StateService.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateService.ts#L5) #### Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md b/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md index 894b5bf..c352d47 100644 --- a/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md +++ b/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md @@ -10,7 +10,7 @@ title: StateTransitionProvable # Interface: StateTransitionProvable -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L25) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L25) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > **runBatch**: (`publicInput`, `batch`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) #### Parameters diff --git a/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md b/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md index 6cf7060..af2707f 100644 --- a/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md +++ b/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md @@ -10,7 +10,7 @@ title: StateTransitionProverType # Interface: StateTransitionProverType -Defined in: [packages/protocol/src/protocol/Protocol.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L43) +Defined in: [packages/protocol/src/protocol/Protocol.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L49) Used by various module sub-types that may need to be configured @@ -39,7 +39,7 @@ checks when retrieving it via the getter > **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) #### Parameters @@ -69,7 +69,7 @@ Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvabl > `optional` **protocol**: [`ProtocolEnvironment`](ProtocolEnvironment.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L14) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) #### Inherited from @@ -81,7 +81,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github > **runBatch**: (`publicInput`, `batch`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) #### Parameters @@ -121,7 +121,7 @@ Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 > **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L16) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) ##### Returns @@ -193,7 +193,7 @@ Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 > **create**(`childContainerProvider`): `void` -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L20) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) #### Parameters @@ -215,7 +215,7 @@ Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github > **start**(): `Promise`\<`void`\> -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/ProtocolModule.ts#L24) +Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) #### Returns diff --git a/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md b/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md index 0e73c5c..ed0c462 100644 --- a/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md +++ b/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md @@ -10,7 +10,7 @@ title: TransitionMethodExecutionContext # Interface: TransitionMethodExecutionContext -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L7) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L7) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContex > **addStateTransition**: \<`Value`\>(`stateTransition`) => `void` -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L12) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L12) Adds an in-method generated state transition to the current context @@ -44,7 +44,7 @@ State transition to add to the context > **clear**: () => `void` -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L17) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L17) Manually clears/resets the execution context @@ -58,7 +58,7 @@ Manually clears/resets the execution context > **current**: () => `object` -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L23) +Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L23) Had to override current() otherwise it would not infer the type of result correctly (parent type would be reused) diff --git a/src/pages/docs/reference/protocol/type-aliases/BlockProof.md b/src/pages/docs/reference/protocol/type-aliases/BlockProof.md index f346786..41d2fb3 100644 --- a/src/pages/docs/reference/protocol/type-aliases/BlockProof.md +++ b/src/pages/docs/reference/protocol/type-aliases/BlockProof.md @@ -12,4 +12,4 @@ title: BlockProof > **BlockProof**: `Proof`\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L132) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L132) diff --git a/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md b/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md index 4f1287b..4786f7f 100644 --- a/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md +++ b/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md @@ -12,4 +12,4 @@ title: BlockProverProof > **BlockProverProof**: `Proof`\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProvable.ts#L52) +Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L52) diff --git a/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md index 85be19d..5921da9 100644 --- a/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md +++ b/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md @@ -12,7 +12,7 @@ title: BridgeContractConfig > **BridgeContractConfig**: `object` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L12) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L12) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md b/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md index 4bde5c8..f41445d 100644 --- a/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md +++ b/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md @@ -12,7 +12,7 @@ title: BridgeContractType > **BridgeContractType**: `object` -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/BridgeContract.ts#L29) +Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L29) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md index a2a3121..2e95f2e 100644 --- a/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md +++ b/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md @@ -12,7 +12,7 @@ title: DispatchContractConfig > **DispatchContractConfig**: `object` -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L17) +Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L17) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md b/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md index 5afad99..c1d64cb 100644 --- a/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md +++ b/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md @@ -12,4 +12,4 @@ title: InputBlockProof > **InputBlockProof**: [`InferProofBase`](../../common/type-aliases/InferProofBase.md)\<[`BlockProof`](BlockProof.md)\> -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L9) +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L9) diff --git a/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md index 82db990..26030d4 100644 --- a/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md +++ b/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md @@ -12,7 +12,7 @@ title: MandatoryProtocolModulesRecord > **MandatoryProtocolModulesRecord**: `object` -Defined in: [packages/protocol/src/protocol/Protocol.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L47) +Defined in: [packages/protocol/src/protocol/Protocol.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L53) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md index 6e5a4da..e4a6800 100644 --- a/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md +++ b/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md @@ -12,7 +12,7 @@ title: MandatorySettlementModulesRecord > **MandatorySettlementModulesRecord**: `object` -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L35) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L35) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md index bb8debd..4dff026 100644 --- a/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md +++ b/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md @@ -12,4 +12,4 @@ title: ProtocolModulesRecord > **ProtocolModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ProtocolModule`](../classes/ProtocolModule.md)\<`unknown`\>\>\> -Defined in: [packages/protocol/src/protocol/Protocol.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/protocol/Protocol.ts#L37) +Defined in: [packages/protocol/src/protocol/Protocol.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L43) diff --git a/src/pages/docs/reference/protocol/type-aliases/ReturnType.md b/src/pages/docs/reference/protocol/type-aliases/ReturnType.md index 279e1e5..f56ccd7 100644 --- a/src/pages/docs/reference/protocol/type-aliases/ReturnType.md +++ b/src/pages/docs/reference/protocol/type-aliases/ReturnType.md @@ -12,7 +12,7 @@ title: ReturnType > **ReturnType**\<`FunctionType`\>: `FunctionType` *extends* (...`args`) => infer Return ? `Return` : `any` -Defined in: [packages/protocol/src/utils/utils.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/utils.ts#L4) +Defined in: [packages/protocol/src/utils/utils.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/utils.ts#L4) ## Type Parameters diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md index b0ba400..d7de3c9 100644 --- a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md +++ b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md @@ -12,4 +12,4 @@ title: RuntimeMethodIdMapping > **RuntimeMethodIdMapping**: `Record`\<`` `${string}.${string}` ``, \{ `methodId`: `bigint`; `type`: [`RuntimeMethodInvocationType`](RuntimeMethodInvocationType.md); \}\> -Defined in: [packages/protocol/src/model/RuntimeLike.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/RuntimeLike.ts#L3) +Defined in: [packages/protocol/src/model/RuntimeLike.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/RuntimeLike.ts#L3) diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md index 9c0207d..d189de0 100644 --- a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md +++ b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md @@ -12,4 +12,4 @@ title: RuntimeMethodInvocationType > **RuntimeMethodInvocationType**: `"INCOMING_MESSAGE"` \| `"SIGNATURE"` -Defined in: [packages/protocol/src/model/RuntimeLike.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/model/RuntimeLike.ts#L1) +Defined in: [packages/protocol/src/model/RuntimeLike.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/RuntimeLike.ts#L1) diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md index 002ac5e..36ec5ce 100644 --- a/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md +++ b/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md @@ -12,4 +12,4 @@ title: RuntimeProof > **RuntimeProof**: `Proof`\<`void`, [`MethodPublicOutput`](../classes/MethodPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:133](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/BlockProver.ts#L133) +Defined in: [packages/protocol/src/prover/block/BlockProver.ts:133](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L133) diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md index e9cfd2e..1f111a7 100644 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md @@ -12,7 +12,7 @@ title: SettlementContractConfig > **SettlementContractConfig**: `object` -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L26) +Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L26) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md b/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md index d7d7591..1ba9815 100644 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md @@ -12,7 +12,7 @@ title: SettlementHookInputs > **SettlementHookInputs**: `object` -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L20) +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L20) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md index baaf4b8..497405f 100644 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md @@ -12,4 +12,4 @@ title: SettlementModulesRecord > **SettlementModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ContractModule`](../classes/ContractModule.md)\<`unknown`, `unknown`\>\>\> -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/SettlementContractModule.ts#L31) +Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L31) diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md b/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md index 62f5326..5e53432 100644 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md +++ b/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md @@ -12,7 +12,7 @@ title: SettlementStateRecord > **SettlementStateRecord**: `object` -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L11) +Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L11) ## Type declaration diff --git a/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md b/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md index 5ff9cb8..5b09f4a 100644 --- a/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md +++ b/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md @@ -12,7 +12,7 @@ title: SmartContractClassFromInterface > **SmartContractClassFromInterface**\<`Type`\>: *typeof* `SmartContract` & [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`Type`\> -Defined in: [packages/protocol/src/settlement/ContractModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/ContractModule.ts#L11) +Defined in: [packages/protocol/src/settlement/ContractModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/ContractModule.ts#L11) ## Type Parameters diff --git a/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md b/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md index 4cd719c..4031123 100644 --- a/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md +++ b/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md @@ -12,4 +12,4 @@ title: StateTransitionProof > **StateTransitionProof**: `Proof`\<[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L20) +Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L20) diff --git a/src/pages/docs/reference/protocol/type-aliases/Subclass.md b/src/pages/docs/reference/protocol/type-aliases/Subclass.md index 260cf14..17843eb 100644 --- a/src/pages/docs/reference/protocol/type-aliases/Subclass.md +++ b/src/pages/docs/reference/protocol/type-aliases/Subclass.md @@ -12,7 +12,7 @@ title: Subclass > **Subclass**\<`Class`\>: (...`args`) => `InstanceType`\<`Class`\> & `{ [Key in keyof Class]: Class[Key] }` & `object` -Defined in: [packages/protocol/src/utils/utils.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/utils.ts#L10) +Defined in: [packages/protocol/src/utils/utils.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/utils.ts#L10) ## Type declaration diff --git a/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md b/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md index 29d4f10..dc58e5a 100644 --- a/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md +++ b/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md @@ -12,4 +12,4 @@ title: ACTIONS_EMPTY_HASH > `const` **ACTIONS\_EMPTY\_HASH**: `Field` = `Reducer.initialActionState` -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L38) +Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L38) diff --git a/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md b/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md index 6b04566..268bdeb 100644 --- a/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md +++ b/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md @@ -12,4 +12,4 @@ title: BATCH_SIGNATURE_PREFIX > `const` **BATCH\_SIGNATURE\_PREFIX**: `Field` -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L92) +Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L92) diff --git a/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md b/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md index eabe3ca..dea39bb 100644 --- a/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md +++ b/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md @@ -12,7 +12,7 @@ title: MINA_EVENT_PREFIXES > `const` **MINA\_EVENT\_PREFIXES**: `object` -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L14) +Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L14) ## Type declaration diff --git a/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md b/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md index 0fc522e..d5b0d30 100644 --- a/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md +++ b/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md @@ -12,4 +12,4 @@ title: OUTGOING_MESSAGE_BATCH_SIZE > `const` **OUTGOING\_MESSAGE\_BATCH\_SIZE**: `1` = `1` -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L6) +Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L6) diff --git a/src/pages/docs/reference/protocol/variables/ProtocolConstants.md b/src/pages/docs/reference/protocol/variables/ProtocolConstants.md index e1e8ea0..8237a35 100644 --- a/src/pages/docs/reference/protocol/variables/ProtocolConstants.md +++ b/src/pages/docs/reference/protocol/variables/ProtocolConstants.md @@ -12,7 +12,7 @@ title: ProtocolConstants > `const` **ProtocolConstants**: `object` -Defined in: [packages/protocol/src/Constants.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/Constants.ts#L1) +Defined in: [packages/protocol/src/Constants.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/Constants.ts#L1) ## Type declaration diff --git a/src/pages/docs/reference/protocol/variables/treeFeeHeight.md b/src/pages/docs/reference/protocol/variables/treeFeeHeight.md index d2778bf..94061dc 100644 --- a/src/pages/docs/reference/protocol/variables/treeFeeHeight.md +++ b/src/pages/docs/reference/protocol/variables/treeFeeHeight.md @@ -12,4 +12,4 @@ title: treeFeeHeight > `const` **treeFeeHeight**: `10` = `10` -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L4) +Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L4) diff --git a/src/pages/docs/reference/sdk/classes/AppChain.md b/src/pages/docs/reference/sdk/classes/AppChain.md index 9e6f797..acfa70d 100644 --- a/src/pages/docs/reference/sdk/classes/AppChain.md +++ b/src/pages/docs/reference/sdk/classes/AppChain.md @@ -10,7 +10,7 @@ title: AppChain # Class: AppChain\ -Defined in: [sdk/src/appChain/AppChain.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L112) +Defined in: [sdk/src/appChain/AppChain.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L112) AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer @@ -39,7 +39,7 @@ AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer > **new AppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L151) +Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L151) #### Parameters @@ -76,7 +76,7 @@ checks when retrieving it via the getter > **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L144) +Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L144) #### Overrides @@ -180,7 +180,7 @@ list of module names > **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L215) +Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L215) ##### Returns @@ -194,7 +194,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/fram > **get** **query**(): `object` -Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L176) +Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L176) ##### Returns @@ -220,7 +220,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/fram > **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L207) +Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L207) ##### Returns @@ -234,7 +234,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/fram > **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L211) +Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L211) ##### Returns @@ -294,7 +294,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L352) +Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L352) #### Returns @@ -650,7 +650,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:129 > **start**(`proofsEnabled`, `dependencyContainer`): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L309) +Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L309) Starts the appchain and cross-registers runtime to sequencer @@ -674,7 +674,7 @@ Starts the appchain and cross-registers runtime to sequencer > **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> -Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L219) +Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L219) #### Parameters @@ -731,7 +731,7 @@ such as only injecting other known modules. > `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L127) +Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L127) #### Type Parameters diff --git a/src/pages/docs/reference/sdk/classes/AppChainModule.md b/src/pages/docs/reference/sdk/classes/AppChainModule.md index 4137d38..c5e752a 100644 --- a/src/pages/docs/reference/sdk/classes/AppChainModule.md +++ b/src/pages/docs/reference/sdk/classes/AppChainModule.md @@ -10,7 +10,7 @@ title: AppChainModule # Class: AppChainModule\ -Defined in: [sdk/src/appChain/AppChainModule.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L13) +Defined in: [sdk/src/appChain/AppChainModule.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L13) Used by various module sub-types that may need to be configured @@ -55,7 +55,7 @@ Used by various module sub-types that may need to be configured > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) *** @@ -78,7 +78,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) ## Accessors diff --git a/src/pages/docs/reference/sdk/classes/AppChainTransaction.md b/src/pages/docs/reference/sdk/classes/AppChainTransaction.md index adce8ad..35b0022 100644 --- a/src/pages/docs/reference/sdk/classes/AppChainTransaction.md +++ b/src/pages/docs/reference/sdk/classes/AppChainTransaction.md @@ -10,7 +10,7 @@ title: AppChainTransaction # Class: AppChainTransaction -Defined in: [sdk/src/transaction/AppChainTransaction.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L6) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L6) ## Constructors @@ -18,7 +18,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:6](https://github.com/pr > **new AppChainTransaction**(`signer`, `transactionSender`): [`AppChainTransaction`](AppChainTransaction.md) -Defined in: [sdk/src/transaction/AppChainTransaction.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L9) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L9) #### Parameters @@ -40,7 +40,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:9](https://github.com/pr > **signer**: [`Signer`](../interfaces/Signer.md) -Defined in: [sdk/src/transaction/AppChainTransaction.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L10) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L10) *** @@ -48,7 +48,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:10](https://github.com/p > `optional` **transaction**: [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) \| [`UnsignedTransaction`](../../sequencer/classes/UnsignedTransaction.md) -Defined in: [sdk/src/transaction/AppChainTransaction.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L7) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L7) *** @@ -56,7 +56,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:7](https://github.com/pr > **transactionSender**: [`TransactionSender`](../interfaces/TransactionSender.md) -Defined in: [sdk/src/transaction/AppChainTransaction.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L11) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L11) ## Methods @@ -64,7 +64,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:11](https://github.com/p > **hasPendingTransaction**(`transaction`?): `asserts transaction is PendingTransaction` -Defined in: [sdk/src/transaction/AppChainTransaction.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L27) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L27) #### Parameters @@ -82,7 +82,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:27](https://github.com/p > **hasUnsignedTransaction**(`transaction`?): `asserts transaction is UnsignedTransaction` -Defined in: [sdk/src/transaction/AppChainTransaction.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L18) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L18) #### Parameters @@ -100,7 +100,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:18](https://github.com/p > **send**(): `Promise`\<`void`\> -Defined in: [sdk/src/transaction/AppChainTransaction.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L48) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L48) #### Returns @@ -112,7 +112,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:48](https://github.com/p > **sign**(): `Promise`\<`void`\> -Defined in: [sdk/src/transaction/AppChainTransaction.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L36) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L36) #### Returns @@ -124,7 +124,7 @@ Defined in: [sdk/src/transaction/AppChainTransaction.ts:36](https://github.com/p > **withUnsignedTransaction**(`unsignedTransaction`): `void` -Defined in: [sdk/src/transaction/AppChainTransaction.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AppChainTransaction.ts#L14) +Defined in: [sdk/src/transaction/AppChainTransaction.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L14) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md b/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md index 37e1a54..50605b6 100644 --- a/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md +++ b/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md @@ -10,7 +10,7 @@ title: AreProofsEnabledFactory # Class: AreProofsEnabledFactory -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L21) +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L21) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -43,7 +43,7 @@ deps that are necessary for the sequencer to work. > **dependencies**(): `object` -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L22) +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L22) #### Returns diff --git a/src/pages/docs/reference/sdk/classes/AuroSigner.md b/src/pages/docs/reference/sdk/classes/AuroSigner.md index 3460a8b..ba4ad71 100644 --- a/src/pages/docs/reference/sdk/classes/AuroSigner.md +++ b/src/pages/docs/reference/sdk/classes/AuroSigner.md @@ -10,7 +10,7 @@ title: AuroSigner # Class: AuroSigner -Defined in: [sdk/src/transaction/AuroSigner.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AuroSigner.ts#L9) +Defined in: [sdk/src/transaction/AuroSigner.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AuroSigner.ts#L9) Used by various module sub-types that may need to be configured @@ -42,7 +42,7 @@ Used by various module sub-types that may need to be configured > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -69,7 +69,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -137,7 +137,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **sign**(`message`): `Promise`\<`Signature`\> -Defined in: [sdk/src/transaction/AuroSigner.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/AuroSigner.ts#L10) +Defined in: [sdk/src/transaction/AuroSigner.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AuroSigner.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md b/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md index f4f84a5..11f3e6f 100644 --- a/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md +++ b/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md @@ -10,7 +10,7 @@ title: BlockStorageNetworkStateModule # Class: BlockStorageNetworkStateModule -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L17) +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L17) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new BlockStorageNetworkStateModule**(`sequencer`): [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md) -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L21) +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L21) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:21](https://github. > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -77,7 +77,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -145,7 +145,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **getProvenNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L58) +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L58) #### Returns @@ -161,7 +161,7 @@ Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:58](https://github. > **getStagedNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L53) +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L53) Staged network state is the networkstate after the latest unproven block with afterBundle() hooks executed @@ -180,7 +180,7 @@ with afterBundle() hooks executed > **getUnprovenNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L44) +Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L44) #### Returns diff --git a/src/pages/docs/reference/sdk/classes/ClientAppChain.md b/src/pages/docs/reference/sdk/classes/ClientAppChain.md index 971368d..b5b7245 100644 --- a/src/pages/docs/reference/sdk/classes/ClientAppChain.md +++ b/src/pages/docs/reference/sdk/classes/ClientAppChain.md @@ -10,7 +10,7 @@ title: ClientAppChain # Class: ClientAppChain\ -Defined in: [sdk/src/appChain/ClientAppChain.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/ClientAppChain.ts#L30) +Defined in: [sdk/src/appChain/ClientAppChain.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/ClientAppChain.ts#L30) AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer @@ -34,7 +34,7 @@ AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer > **new ClientAppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`ClientAppChain`](ClientAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L151) +Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L151) #### Parameters @@ -71,7 +71,7 @@ checks when retrieving it via the getter > **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L144) +Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L144) #### Inherited from @@ -175,7 +175,7 @@ list of module names > **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L215) +Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L215) ##### Returns @@ -193,7 +193,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/fram > **get** **query**(): `object` -Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L176) +Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L176) ##### Returns @@ -223,7 +223,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/fram > **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L207) +Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L207) ##### Returns @@ -241,7 +241,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/fram > **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L211) +Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L211) ##### Returns @@ -305,7 +305,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L352) +Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L352) #### Returns @@ -665,7 +665,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/ClientAppChain.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/ClientAppChain.ts#L108) +Defined in: [sdk/src/appChain/ClientAppChain.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/ClientAppChain.ts#L108) Starts the appchain and cross-registers runtime to sequencer @@ -683,7 +683,7 @@ Starts the appchain and cross-registers runtime to sequencer > **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> -Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L219) +Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L219) #### Parameters @@ -744,7 +744,7 @@ such as only injecting other known modules. > `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L127) +Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L127) #### Type Parameters @@ -776,7 +776,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/fram > `static` **fromRuntime**\<`RuntimeModules`, `SignerType`\>(`runtimeModules`, `signer`): [`ClientAppChain`](ClientAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{\}, \{ `GraphqlClient`: *typeof* [`GraphqlClient`](GraphqlClient.md); `NetworkStateTransportModule`: *typeof* [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md); `QueryTransportModule`: *typeof* [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md); `Signer`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`SignerType`\>; `TransactionSender`: *typeof* [`GraphqlTransactionSender`](GraphqlTransactionSender.md); \}\> -Defined in: [sdk/src/appChain/ClientAppChain.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/ClientAppChain.ts#L42) +Defined in: [sdk/src/appChain/ClientAppChain.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/ClientAppChain.ts#L42) #### Type Parameters diff --git a/src/pages/docs/reference/sdk/classes/GraphqlClient.md b/src/pages/docs/reference/sdk/classes/GraphqlClient.md index bb69255..52f25db 100644 --- a/src/pages/docs/reference/sdk/classes/GraphqlClient.md +++ b/src/pages/docs/reference/sdk/classes/GraphqlClient.md @@ -10,7 +10,7 @@ title: GraphqlClient # Class: GraphqlClient -Defined in: [sdk/src/graphql/GraphqlClient.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlClient.ts#L9) +Defined in: [sdk/src/graphql/GraphqlClient.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlClient.ts#L9) Used by various module sub-types that may need to be configured @@ -38,7 +38,7 @@ Used by various module sub-types that may need to be configured > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -65,7 +65,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit > **get** **client**(): `Client` -Defined in: [sdk/src/graphql/GraphqlClient.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlClient.ts#L20) +Defined in: [sdk/src/graphql/GraphqlClient.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlClient.ts#L20) ##### Returns diff --git a/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md b/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md index 36e5e73..1742155 100644 --- a/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md +++ b/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md @@ -10,7 +10,7 @@ title: GraphqlNetworkStateTransportModule # Class: GraphqlNetworkStateTransportModule -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L20) +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L20) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new GraphqlNetworkStateTransportModule**(`graphqlClient`): [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md) -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L24) +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L24) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:24](https://g > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -77,7 +77,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -145,7 +145,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **getProvenNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L71) +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L71) #### Returns @@ -161,7 +161,7 @@ Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:71](https://g > **getStagedNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L75) +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L75) #### Returns @@ -177,7 +177,7 @@ Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:75](https://g > **getUnprovenNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L79) +Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L79) #### Returns diff --git a/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md b/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md index fd78fef..9673923 100644 --- a/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md +++ b/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md @@ -10,7 +10,7 @@ title: GraphqlQueryTransportModule # Class: GraphqlQueryTransportModule -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L30) +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L30) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new GraphqlQueryTransportModule**(`graphqlClient`): [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md) -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L34) +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L34) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:34](https://github.c > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -77,7 +77,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -145,7 +145,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L40) +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L40) #### Parameters @@ -167,7 +167,7 @@ Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:40](https://github.c > **merkleWitness**(`key`): `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L65) +Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L65) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md b/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md index 03213bc..d02928e 100644 --- a/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md +++ b/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md @@ -10,7 +10,7 @@ title: GraphqlTransactionSender # Class: GraphqlTransactionSender -Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L11) +Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L11) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new GraphqlTransactionSender**(`graphqlClient`): [`GraphqlTransactionSender`](GraphqlTransactionSender.md) -Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L15) +Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L15) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:15](https://github.com/ > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Implementation of @@ -85,7 +85,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -161,7 +161,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **send**(`transaction`): `Promise`\<`void`\> -Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L21) +Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L21) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md b/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md index 09eb30e..a4652a8 100644 --- a/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md +++ b/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md @@ -10,7 +10,7 @@ title: InMemoryAreProofsEnabled # Class: InMemoryAreProofsEnabled -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L9) +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L9) ## Implements @@ -34,7 +34,7 @@ Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:9](https://github.com/p > **get** **areProofsEnabled**(): `boolean` -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L12) +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L12) ##### Returns @@ -50,7 +50,7 @@ Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:12](https://github.com/ > **setProofsEnabled**(`areProofsEnabled`): `void` -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L16) +Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/InMemorySigner.md b/src/pages/docs/reference/sdk/classes/InMemorySigner.md index 04faf54..e0b9c09 100644 --- a/src/pages/docs/reference/sdk/classes/InMemorySigner.md +++ b/src/pages/docs/reference/sdk/classes/InMemorySigner.md @@ -10,7 +10,7 @@ title: InMemorySigner # Class: InMemorySigner -Defined in: [sdk/src/transaction/InMemorySigner.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L15) +Defined in: [sdk/src/transaction/InMemorySigner.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L15) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new InMemorySigner**(): [`InMemorySigner`](InMemorySigner.md) -Defined in: [sdk/src/transaction/InMemorySigner.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L19) +Defined in: [sdk/src/transaction/InMemorySigner.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L19) #### Returns @@ -44,7 +44,7 @@ Defined in: [sdk/src/transaction/InMemorySigner.ts:19](https://github.com/proto- > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -71,7 +71,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -139,7 +139,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **sign**(`signatureData`): `Promise`\<`Signature`\> -Defined in: [sdk/src/transaction/InMemorySigner.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L23) +Defined in: [sdk/src/transaction/InMemorySigner.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L23) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md b/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md index f97bb9c..a93bbfb 100644 --- a/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md +++ b/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md @@ -10,7 +10,7 @@ title: InMemoryTransactionSender # Class: InMemoryTransactionSender -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L16) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L16) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new InMemoryTransactionSender**(`sequencer`): [`InMemoryTransactionSender`](InMemoryTransactionSender.md) -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L22) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L22) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:22](https://github > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Implementation of @@ -85,7 +85,7 @@ checks when retrieving it via the getter > **mempool**: [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md) -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L20) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L20) *** @@ -93,7 +93,7 @@ Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:20](https://github > **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L23) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L23) *** @@ -101,7 +101,7 @@ Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:23](https://github > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -177,7 +177,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **send**(`transaction`): `Promise`\<`void`\> -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L30) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L30) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md b/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md index c5b5c63..ec25407 100644 --- a/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md +++ b/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md @@ -10,7 +10,7 @@ title: SharedDependencyFactory # Class: SharedDependencyFactory -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/SharedDependencyFactory.ts#L14) +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/SharedDependencyFactory.ts#L14) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -43,7 +43,7 @@ deps that are necessary for the sequencer to work. > **dependencies**(): [`SharedDependencyRecord`](../interfaces/SharedDependencyRecord.md) -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/SharedDependencyFactory.ts#L15) +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/SharedDependencyFactory.ts#L15) #### Returns diff --git a/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md b/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md index 3e1bef2..19b67c3 100644 --- a/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md +++ b/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md @@ -10,7 +10,7 @@ title: StateServiceQueryModule # Class: StateServiceQueryModule -Defined in: [sdk/src/query/StateServiceQueryModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L16) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L16) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new StateServiceQueryModule**(`sequencer`): [`StateServiceQueryModule`](StateServiceQueryModule.md) -Defined in: [sdk/src/query/StateServiceQueryModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L20) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L20) #### Parameters @@ -50,7 +50,7 @@ Defined in: [sdk/src/query/StateServiceQueryModule.ts:20](https://github.com/pro > `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -77,7 +77,7 @@ checks when retrieving it via the getter > **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> -Defined in: [sdk/src/query/StateServiceQueryModule.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L21) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L21) *** @@ -85,7 +85,7 @@ Defined in: [sdk/src/query/StateServiceQueryModule.ts:21](https://github.com/pro > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L16) +Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) #### Inherited from @@ -99,7 +99,7 @@ Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit > **get** **asyncStateService**(): [`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md) -Defined in: [sdk/src/query/StateServiceQueryModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L26) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L26) ##### Returns @@ -147,7 +147,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:19 > **get** **treeStore**(): [`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md) -Defined in: [sdk/src/query/StateServiceQueryModule.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L32) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L32) ##### Returns @@ -181,7 +181,7 @@ Defined in: common/dist/config/ConfigurableModule.d.ts:20 > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [sdk/src/query/StateServiceQueryModule.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L36) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L36) #### Parameters @@ -203,7 +203,7 @@ Defined in: [sdk/src/query/StateServiceQueryModule.ts:36](https://github.com/pro > **merkleWitness**(`path`): `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> -Defined in: [sdk/src/query/StateServiceQueryModule.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/query/StateServiceQueryModule.ts#L40) +Defined in: [sdk/src/query/StateServiceQueryModule.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L40) #### Parameters diff --git a/src/pages/docs/reference/sdk/classes/TestingAppChain.md b/src/pages/docs/reference/sdk/classes/TestingAppChain.md index e8322d4..9e6250b 100644 --- a/src/pages/docs/reference/sdk/classes/TestingAppChain.md +++ b/src/pages/docs/reference/sdk/classes/TestingAppChain.md @@ -10,7 +10,7 @@ title: TestingAppChain # Class: TestingAppChain\ -Defined in: [sdk/src/appChain/TestingAppChain.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L58) +Defined in: [sdk/src/appChain/TestingAppChain.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L58) AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer @@ -34,7 +34,7 @@ AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer > **new TestingAppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`TestingAppChain`](TestingAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L151) +Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L151) #### Parameters @@ -71,7 +71,7 @@ checks when retrieving it via the getter > **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L144) +Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L144) #### Inherited from @@ -175,7 +175,7 @@ list of module names > **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L215) +Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L215) ##### Returns @@ -193,7 +193,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/fram > **get** **query**(): `object` -Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L176) +Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L176) ##### Returns @@ -223,7 +223,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/fram > **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L207) +Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L207) ##### Returns @@ -241,7 +241,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/fram > **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L211) +Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L211) ##### Returns @@ -305,7 +305,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L352) +Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L352) #### Returns @@ -501,7 +501,7 @@ Handle module resolution, e.g. by decorating resolved modules > **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> -Defined in: [sdk/src/appChain/TestingAppChain.ts:135](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L135) +Defined in: [sdk/src/appChain/TestingAppChain.ts:137](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L137) #### Returns @@ -513,7 +513,7 @@ Defined in: [sdk/src/appChain/TestingAppChain.ts:135](https://github.com/proto-k > **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> -Defined in: [sdk/src/appChain/TestingAppChain.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L144) +Defined in: [sdk/src/appChain/TestingAppChain.ts:146](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L146) #### Returns @@ -689,7 +689,7 @@ Defined in: common/dist/config/ModuleContainer.d.ts:129 > **setSigner**(`signer`): `void` -Defined in: [sdk/src/appChain/TestingAppChain.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L130) +Defined in: [sdk/src/appChain/TestingAppChain.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L132) #### Parameters @@ -707,7 +707,7 @@ Defined in: [sdk/src/appChain/TestingAppChain.ts:130](https://github.com/proto-k > **start**(`proofsEnabled`, `dependencyContainer`): `Promise`\<`void`\> -Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L309) +Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L309) Starts the appchain and cross-registers runtime to sequencer @@ -735,7 +735,7 @@ Starts the appchain and cross-registers runtime to sequencer > **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> -Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L219) +Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L219) #### Parameters @@ -796,7 +796,7 @@ such as only injecting other known modules. > `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L127) +Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L127) #### Type Parameters @@ -826,9 +826,9 @@ Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/fram ### fromRuntime() -> `static` **fromRuntime**\<`RuntimeModules`\>(`runtimeModules`): [`TestingAppChain`](TestingAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](InMemoryTransactionSender.md); \}\> +> `static` **fromRuntime**\<`RuntimeModules`\>(`runtimeModules`): [`TestingAppChain`](TestingAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `FeeStrategy`: *typeof* `ConstantFeeStrategy`; `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `SequencerStartupModule`: *typeof* [`SequencerStartupModule`](../../sequencer/classes/SequencerStartupModule.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](InMemoryTransactionSender.md); \}\> -Defined in: [sdk/src/appChain/TestingAppChain.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L70) +Defined in: [sdk/src/appChain/TestingAppChain.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L70) #### Type Parameters @@ -842,4 +842,4 @@ Defined in: [sdk/src/appChain/TestingAppChain.ts:70](https://github.com/proto-ki #### Returns -[`TestingAppChain`](TestingAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](InMemoryTransactionSender.md); \}\> +[`TestingAppChain`](TestingAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `FeeStrategy`: *typeof* `ConstantFeeStrategy`; `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `SequencerStartupModule`: *typeof* [`SequencerStartupModule`](../../sequencer/classes/SequencerStartupModule.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](InMemoryTransactionSender.md); \}\> diff --git a/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md b/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md index af0b630..ea1dbc4 100644 --- a/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md +++ b/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md @@ -10,7 +10,7 @@ title: AppChainConfig # Interface: AppChainConfig\ -Defined in: [sdk/src/appChain/AppChain.ts:96](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L96) +Defined in: [sdk/src/appChain/AppChain.ts:96](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L96) Definition of required arguments for AppChain @@ -30,7 +30,7 @@ Definition of required arguments for AppChain > **AppChain**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:106](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L106) +Defined in: [sdk/src/appChain/AppChain.ts:106](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L106) *** @@ -38,7 +38,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:106](https://github.com/proto-kit/fram > **Protocol**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`ProtocolModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:104](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L104) +Defined in: [sdk/src/appChain/AppChain.ts:104](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L104) *** @@ -46,7 +46,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:104](https://github.com/proto-kit/fram > **Runtime**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`RuntimeModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:103](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L103) +Defined in: [sdk/src/appChain/AppChain.ts:103](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L103) *** @@ -54,4 +54,4 @@ Defined in: [sdk/src/appChain/AppChain.ts:103](https://github.com/proto-kit/fram > **Sequencer**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`SequencerModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L105) +Defined in: [sdk/src/appChain/AppChain.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L105) diff --git a/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md b/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md index 9e7336e..dc62fc1 100644 --- a/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md +++ b/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md @@ -10,7 +10,7 @@ title: AppChainDefinition # Interface: AppChainDefinition\ -Defined in: [sdk/src/appChain/AppChain.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L53) +Defined in: [sdk/src/appChain/AppChain.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L53) ## Type Parameters @@ -28,7 +28,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:53](https://github.com/proto-kit/frame > **modules**: `AppChainModules` -Defined in: [sdk/src/appChain/AppChain.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L63) +Defined in: [sdk/src/appChain/AppChain.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L63) *** @@ -36,7 +36,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:63](https://github.com/proto-kit/frame > **Protocol**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\>\> -Defined in: [sdk/src/appChain/AppChain.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L61) +Defined in: [sdk/src/appChain/AppChain.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L61) *** @@ -44,7 +44,7 @@ Defined in: [sdk/src/appChain/AppChain.ts:61](https://github.com/proto-kit/frame > **Runtime**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\>\> -Defined in: [sdk/src/appChain/AppChain.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L60) +Defined in: [sdk/src/appChain/AppChain.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L60) *** @@ -52,4 +52,4 @@ Defined in: [sdk/src/appChain/AppChain.ts:60](https://github.com/proto-kit/frame > **Sequencer**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\>\> -Defined in: [sdk/src/appChain/AppChain.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L62) +Defined in: [sdk/src/appChain/AppChain.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L62) diff --git a/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md b/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md index 51b1823..a97f219 100644 --- a/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md +++ b/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md @@ -10,7 +10,7 @@ title: ExpandAppChainDefinition # Interface: ExpandAppChainDefinition\ -Defined in: [sdk/src/appChain/AppChain.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L78) +Defined in: [sdk/src/appChain/AppChain.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L78) ## Type Parameters @@ -28,4 +28,4 @@ Defined in: [sdk/src/appChain/AppChain.ts:78](https://github.com/proto-kit/frame > **modules**: [`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> -Defined in: [sdk/src/appChain/AppChain.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L85) +Defined in: [sdk/src/appChain/AppChain.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L85) diff --git a/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md b/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md index a5314ab..14cca98 100644 --- a/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md +++ b/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md @@ -10,7 +10,7 @@ title: GraphqlClientConfig # Interface: GraphqlClientConfig -Defined in: [sdk/src/graphql/GraphqlClient.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlClient.ts#L5) +Defined in: [sdk/src/graphql/GraphqlClient.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlClient.ts#L5) ## Properties @@ -18,4 +18,4 @@ Defined in: [sdk/src/graphql/GraphqlClient.ts:5](https://github.com/proto-kit/fr > **url**: `string` -Defined in: [sdk/src/graphql/GraphqlClient.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/graphql/GraphqlClient.ts#L6) +Defined in: [sdk/src/graphql/GraphqlClient.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlClient.ts#L6) diff --git a/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md b/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md index 17ff04f..ca46bb1 100644 --- a/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md +++ b/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md @@ -10,7 +10,7 @@ title: InMemorySignerConfig # Interface: InMemorySignerConfig -Defined in: [sdk/src/transaction/InMemorySigner.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L10) +Defined in: [sdk/src/transaction/InMemorySigner.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L10) ## Properties @@ -18,4 +18,4 @@ Defined in: [sdk/src/transaction/InMemorySigner.ts:10](https://github.com/proto- > **signer**: `PrivateKey` -Defined in: [sdk/src/transaction/InMemorySigner.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L11) +Defined in: [sdk/src/transaction/InMemorySigner.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L11) diff --git a/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md b/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md index 65b1cab..f0728ce 100644 --- a/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md +++ b/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md @@ -10,7 +10,7 @@ title: SharedDependencyRecord # Interface: SharedDependencyRecord -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/SharedDependencyFactory.ts#L9) +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/SharedDependencyFactory.ts#L9) ## Extends @@ -26,7 +26,7 @@ Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:9](https://github.com/p > **methodIdResolver**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`MethodIdResolver`](../../module/classes/MethodIdResolver.md)\> -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/SharedDependencyFactory.ts#L11) +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/SharedDependencyFactory.ts#L11) *** @@ -34,4 +34,4 @@ Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:11](https://github.com/ > **stateServiceProvider**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md)\> -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/SharedDependencyFactory.ts#L10) +Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/SharedDependencyFactory.ts#L10) diff --git a/src/pages/docs/reference/sdk/interfaces/Signer.md b/src/pages/docs/reference/sdk/interfaces/Signer.md index 163b3ff..c3384e0 100644 --- a/src/pages/docs/reference/sdk/interfaces/Signer.md +++ b/src/pages/docs/reference/sdk/interfaces/Signer.md @@ -10,7 +10,7 @@ title: Signer # Interface: Signer -Defined in: [sdk/src/transaction/InMemorySigner.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L6) +Defined in: [sdk/src/transaction/InMemorySigner.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L6) ## Properties @@ -18,7 +18,7 @@ Defined in: [sdk/src/transaction/InMemorySigner.ts:6](https://github.com/proto-k > **sign**: (`signatureData`) => `Promise`\<`Signature`\> -Defined in: [sdk/src/transaction/InMemorySigner.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemorySigner.ts#L7) +Defined in: [sdk/src/transaction/InMemorySigner.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L7) #### Parameters diff --git a/src/pages/docs/reference/sdk/interfaces/TransactionSender.md b/src/pages/docs/reference/sdk/interfaces/TransactionSender.md index 7271771..ccf4f0b 100644 --- a/src/pages/docs/reference/sdk/interfaces/TransactionSender.md +++ b/src/pages/docs/reference/sdk/interfaces/TransactionSender.md @@ -10,7 +10,7 @@ title: TransactionSender # Interface: TransactionSender -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L11) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L11) Used by various module sub-types that may need to be configured @@ -24,7 +24,7 @@ Used by various module sub-types that may need to be configured > `optional` **appChain**: [`AppChain`](../classes/AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChainModule.ts#L18) +Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) #### Inherited from @@ -51,7 +51,7 @@ checks when retrieving it via the getter > **send**: (`transaction`) => `Promise`\<`void`\> -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L12) +Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L12) #### Parameters diff --git a/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md index e50ff66..0b98225 100644 --- a/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md +++ b/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md @@ -12,4 +12,4 @@ title: AppChainModulesRecord > **AppChainModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AppChainModule`](../classes/AppChainModule.md)\<`unknown`\>\>\> -Defined in: [sdk/src/appChain/AppChain.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L49) +Defined in: [sdk/src/appChain/AppChain.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L49) diff --git a/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md b/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md index 21b7a67..f3b9124 100644 --- a/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md +++ b/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md @@ -12,7 +12,7 @@ title: ExpandAppChainModules > **ExpandAppChainModules**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>: `AppChainModules` & `object` -Defined in: [sdk/src/appChain/AppChain.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/AppChain.ts#L66) +Defined in: [sdk/src/appChain/AppChain.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L66) ## Type declaration diff --git a/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md index 32ea89c..bb59fb3 100644 --- a/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md +++ b/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md @@ -12,7 +12,7 @@ title: PartialVanillaRuntimeModulesRecord > **PartialVanillaRuntimeModulesRecord**: `object` -Defined in: [sdk/src/appChain/TestingAppChain.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L52) +Defined in: [sdk/src/appChain/TestingAppChain.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L52) ## Type declaration diff --git a/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md index 3d944ee..fd954f4 100644 --- a/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md +++ b/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md @@ -12,7 +12,7 @@ title: TestingSequencerModulesRecord > **TestingSequencerModulesRecord**: `object` -Defined in: [sdk/src/appChain/TestingAppChain.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L37) +Defined in: [sdk/src/appChain/TestingAppChain.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L37) ## Type declaration diff --git a/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md b/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md index 7d88f92..7e17dff 100644 --- a/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md +++ b/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md @@ -12,4 +12,4 @@ title: randomFeeRecipient > `const` **randomFeeRecipient**: `string` -Defined in: [sdk/src/appChain/TestingAppChain.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sdk/src/appChain/TestingAppChain.ts#L56) +Defined in: [sdk/src/appChain/TestingAppChain.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L56) diff --git a/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md b/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md index 4806eea..22e17d2 100644 --- a/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md +++ b/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md @@ -10,7 +10,7 @@ title: AbstractTaskQueue # Class: `abstract` AbstractTaskQueue\ -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L5) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L5) Lifecycle of a SequencerModule @@ -64,7 +64,7 @@ checks when retrieving it via the getter > `protected` **queues**: `Record`\<`string`, [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> = `{}` -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) *** @@ -72,7 +72,7 @@ Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https:/ > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -118,7 +118,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > `protected` **closeQueues**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) #### Returns @@ -152,7 +152,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `protected` **createOrGetQueue**(`name`, `creator`): [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) #### Parameters @@ -174,7 +174,7 @@ Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https: > `abstract` **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md b/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md index fe1a57b..dfa4362 100644 --- a/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md @@ -10,7 +10,7 @@ title: ArtifactRecordSerializer # Class: ArtifactRecordSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L10) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L10) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Artifa > **fromJSON**(`json`): [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L27) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L27) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Artifa > **toJSON**(`input`): [`SerializedArtifactRecord`](../type-aliases/SerializedArtifactRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L11) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L11) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md b/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md index d91739a..2de6a97 100644 --- a/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md +++ b/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md @@ -10,7 +10,7 @@ title: BatchProducerModule # Class: BatchProducerModule -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L74) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L74) The BatchProducerModule has the resposiblity to oversee the block production and combine all necessary parts for that to happen. The flow roughly follows @@ -29,7 +29,7 @@ the following steps: > **new BatchProducerModule**(`asyncStateService`, `merkleStore`, `batchStorage`, `blockTreeStore`, `database`, `traceService`, `blockFlowService`, `blockProofSerializer`, `verificationKeyService`): [`BatchProducerModule`](BatchProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:77](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L77) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L77) #### Parameters @@ -98,7 +98,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -166,7 +166,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **createBatch**(`blocks`): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L108) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L108) Main function to call when wanting to create a new block based on the transactions that are present in the mempool. This function should also @@ -188,7 +188,7 @@ be the one called by BlockTriggers > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L132) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L132) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md b/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md index 6ca85c6..7bea9d1 100644 --- a/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md +++ b/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md @@ -10,7 +10,7 @@ title: BlockProducerModule # Class: BlockProducerModule -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L39) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L39) Lifecycle of a SequencerModule @@ -26,7 +26,7 @@ start(): Executed to execute any logic required to start the module > **new BlockProducerModule**(`mempool`, `messageStorage`, `unprovenStateService`, `unprovenMerkleStore`, `blockQueue`, `blockTreeStore`, `productionService`, `resultService`, `methodIdResolver`, `runtime`, `database`): [`BlockProducerModule`](BlockProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L42) #### Parameters @@ -103,7 +103,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -149,7 +149,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **blockResultCompleteCheck**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:236](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L236) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:236](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L236) #### Returns @@ -183,7 +183,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **generateMetadata**(`block`): `Promise`\<[`BlockResult`](../interfaces/BlockResult.md)\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:110](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L110) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:110](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L110) #### Parameters @@ -201,7 +201,7 @@ Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducer > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:251](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L251) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:251](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L251) Start the module and all it's functionality. The returned Promise has to resolve after initialization, @@ -222,7 +222,7 @@ That means that you mustn't await server.start() for example. > **tryProduceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:128](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L128) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:128](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L128) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md b/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md index c925983..7636eee 100644 --- a/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md @@ -10,7 +10,7 @@ title: BlockProofSerializer # Class: BlockProofSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L13) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L13) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockP > **new BlockProofSerializer**(`protocol`): [`BlockProofSerializer`](BlockProofSerializer.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L19) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L19) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockP > **getBlockProofSerializer**(): [`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../../protocol/classes/BlockProverPublicOutput.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L24) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L24) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md b/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md index 4ef288a..bc128e8 100644 --- a/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md +++ b/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md @@ -10,7 +10,7 @@ title: BlockTaskFlowService # Class: BlockTaskFlowService -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L56) +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L56) We could rename this into BlockCreationStrategy and enable the injection of different creation strategies. @@ -21,7 +21,7 @@ different creation strategies. > **new BlockTaskFlowService**(`taskQueue`, `flowCreator`, `stateTransitionTask`, `stateTransitionReductionTask`, `runtimeProvingTask`, `transactionProvingTask`, `blockProvingTask`, `blockReductionTask`, `protocol`): [`BlockTaskFlowService`](BlockTaskFlowService.md) -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L57) +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L57) #### Parameters @@ -71,7 +71,7 @@ Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts: > **executeFlow**(`blockTraces`, `batchId`): `Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:142](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L142) +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:142](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L142) #### Parameters @@ -93,7 +93,7 @@ Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts: > **pushBlockPairing**(`flow`, `blockReductionTask`, `index`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:93](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L93) +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L93) #### Parameters @@ -119,7 +119,7 @@ Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts: > **pushPairing**(`flow`, `transactionReductionTask`, `blockIndex`, `transactionIndex`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L70) +Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L70) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md b/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md index 114eeb6..df2b6a2 100644 --- a/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md +++ b/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md @@ -10,7 +10,7 @@ title: BlockTriggerBase # Class: BlockTriggerBase\ -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L35) A BlockTrigger is the primary method to start the production of a block and all associated processes. @@ -41,7 +41,7 @@ all associated processes. > **new BlockTriggerBase**\<`Config`, `Events`\>(`blockProducerModule`, `batchProducerModule`, `settlementModule`, `blockQueue`, `batchQueue`, `settlementStorage`): [`BlockTriggerBase`](BlockTriggerBase.md)\<`Config`, `Events`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L44) #### Parameters @@ -83,7 +83,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) *** @@ -91,7 +91,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) *** @@ -99,7 +99,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) *** @@ -107,7 +107,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) *** @@ -130,7 +130,7 @@ checks when retrieving it via the getter > `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<`Events`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) #### Implementation of @@ -142,7 +142,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) *** @@ -150,7 +150,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) *** @@ -158,7 +158,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -226,7 +226,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `protected` **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) #### Returns @@ -238,7 +238,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) #### Returns @@ -250,7 +250,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) #### Returns @@ -262,7 +262,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) #### Parameters @@ -280,7 +280,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md index 2b986ba..988a8c4 100644 --- a/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md +++ b/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md @@ -10,7 +10,7 @@ title: CachedMerkleTreeStore # Class: CachedMerkleTreeStore -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L14) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L14) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:14](ht > **new CachedMerkleTreeStore**(`parent`): [`CachedMerkleTreeStore`](CachedMerkleTreeStore.md) -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L32) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L32) #### Parameters @@ -64,7 +64,7 @@ Defined in: packages/common/dist/trees/InMemoryMerkleTreeStorage.d.ts:3 > **commit**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L28) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L28) #### Returns @@ -80,7 +80,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:28](ht > **getNode**(`key`, `level`): `undefined` \| `bigint` -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L36) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L36) #### Parameters @@ -106,7 +106,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:36](ht > **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:148](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L148) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:148](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L148) #### Parameters @@ -128,7 +128,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:148](h > **getWrittenNodes**(): `object` -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L45) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L45) #### Returns @@ -140,7 +140,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:45](ht > **mergeIntoParent**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L112) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L112) #### Returns @@ -152,7 +152,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:112](h > **openTransaction**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L24) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L24) #### Returns @@ -168,7 +168,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:24](ht > **preloadKey**(`index`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L108) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L108) #### Parameters @@ -186,7 +186,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:108](h > **preloadKeys**(`keys`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L94) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L94) #### Parameters @@ -204,7 +204,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:94](ht > **resetWrittenNodes**(): `void` -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L53) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L53) #### Returns @@ -216,7 +216,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:53](ht > **setNode**(`key`, `level`, `value`): `void` -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L40) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L40) #### Parameters @@ -246,7 +246,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:40](ht > **setNodeAsync**(`key`, `level`, `value`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:140](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L140) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:140](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L140) #### Parameters @@ -272,7 +272,7 @@ Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:140](h > **writeNodes**(`nodes`): `void` -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:176](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L176) +Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:176](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L176) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/CachedStateService.md b/src/pages/docs/reference/sequencer/classes/CachedStateService.md index ccb42d7..4f82f7b 100644 --- a/src/pages/docs/reference/sequencer/classes/CachedStateService.md +++ b/src/pages/docs/reference/sequencer/classes/CachedStateService.md @@ -10,7 +10,7 @@ title: CachedStateService # Class: CachedStateService -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L12) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L12) This Interface should be implemented for services that store the state in an external storage (like a DB). This can be used in conjunction with @@ -31,7 +31,7 @@ CachedStateService to preload keys for In-Circuit usage. > **new CachedStateService**(`parent`): [`CachedStateService`](CachedStateService.md) -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L18) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L18) #### Parameters @@ -68,7 +68,7 @@ This is used by the CachedState service to keep track of deletions > **applyStateTransitions**(`stateTransitions`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:99](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L99) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:99](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L99) #### Parameters @@ -86,7 +86,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:99](https: > **commit**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L42) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L42) #### Returns @@ -102,7 +102,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:42](https: > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:94](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L94) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L94) #### Parameters @@ -128,7 +128,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:94](https: > **getMany**(`keys`): `Promise`\<[`StateEntry`](../interfaces/StateEntry.md)[]\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L75) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L75) #### Parameters @@ -150,7 +150,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:75](https: > **mergeIntoParent**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:118](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L118) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:118](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L118) Merges all caches set() operation into the parent and resets this instance to the parent's state (by clearing the cache and @@ -166,7 +166,7 @@ defaulting to the parent) > **openTransaction**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L48) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L48) #### Returns @@ -182,7 +182,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:48](https: > **preloadKey**(`key`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L52) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L52) #### Parameters @@ -200,7 +200,7 @@ Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:52](https: > **preloadKeys**(`keys`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L56) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L56) #### Parameters @@ -248,7 +248,7 @@ Defined in: packages/module/dist/state/InMemoryStateService.d.ts:13 > **writeStates**(`entries`): `void` -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/CachedStateService.ts#L38) +Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L38) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/CompressedSignature.md b/src/pages/docs/reference/sequencer/classes/CompressedSignature.md index 6aeb816..a47a2ff 100644 --- a/src/pages/docs/reference/sequencer/classes/CompressedSignature.md +++ b/src/pages/docs/reference/sequencer/classes/CompressedSignature.md @@ -10,7 +10,7 @@ title: CompressedSignature # Class: CompressedSignature -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L8) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L8) CompressedSignature compresses the s scalar of a Signature (which is expanded to 256 Fields in snarkyjs) to a single string @@ -21,7 +21,7 @@ CompressedSignature compresses the s scalar of a Signature > **new CompressedSignature**(`r`, `s`): [`CompressedSignature`](CompressedSignature.md) -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L15) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L15) #### Parameters @@ -43,7 +43,7 @@ Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:15](https://g > `readonly` **r**: `Field` -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L16) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L16) *** @@ -51,7 +51,7 @@ Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:16](https://g > `readonly` **s**: `string` -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L17) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L17) ## Methods @@ -59,7 +59,7 @@ Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:17](https://g > **toSignature**(): `Signature` -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L21) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L21) #### Returns @@ -71,7 +71,7 @@ Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:21](https://g > `static` **fromSignature**(`sig`): [`CompressedSignature`](CompressedSignature.md) -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/CompressedSignature.ts#L10) +Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md b/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md index f3196a2..5fcb8b3 100644 --- a/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md +++ b/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md @@ -10,7 +10,7 @@ title: DatabasePruneModule # Class: DatabasePruneModule -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/DatabasePruneModule.ts#L16) +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/DatabasePruneModule.ts#L16) Lifecycle of a SequencerModule @@ -26,7 +26,7 @@ start(): Executed to execute any logic required to start the module > **new DatabasePruneModule**(`database`): [`DatabasePruneModule`](DatabasePruneModule.md) -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/DatabasePruneModule.ts#L17) +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/DatabasePruneModule.ts#L17) #### Parameters @@ -63,7 +63,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -131,7 +131,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/DatabasePruneModule.ts#L21) +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/DatabasePruneModule.ts#L21) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md b/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md index 8c858d4..7a6b843 100644 --- a/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md @@ -10,7 +10,7 @@ title: DecodedStateSerializer # Class: DecodedStateSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L6) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L6) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Decode > `static` **fromJSON**(`json`): [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L7) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L7) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Decode > `static` **toJSON**(`input`): [`JSONEncodableState`](../type-aliases/JSONEncodableState.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L16) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/DummyStateService.md b/src/pages/docs/reference/sequencer/classes/DummyStateService.md index 5ccef06..65236f8 100644 --- a/src/pages/docs/reference/sequencer/classes/DummyStateService.md +++ b/src/pages/docs/reference/sequencer/classes/DummyStateService.md @@ -10,7 +10,7 @@ title: DummyStateService # Class: DummyStateService -Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/DummyStateService.ts#L5) +Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/DummyStateService.ts#L5) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:5](https:// > **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/DummyStateService.ts#L6) +Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/DummyStateService.ts#L6) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:6](https:// > **set**(`key`, `value`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/state/DummyStateService.ts#L10) +Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/DummyStateService.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md index 13bf15d..86fe7a9 100644 --- a/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md @@ -10,7 +10,7 @@ title: DynamicProofTaskSerializer # Class: DynamicProofTaskSerializer\ -Defined in: [packages/sequencer/src/helpers/utils.ts:130](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L130) +Defined in: [packages/sequencer/src/helpers/utils.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L130) ## Extends @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:130](https://github.com/pro > **new DynamicProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`DynamicProofTaskSerializer`](DynamicProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> -Defined in: [packages/sequencer/src/helpers/utils.ts:134](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L134) +Defined in: [packages/sequencer/src/helpers/utils.ts:134](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L134) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:134](https://github.com/pro > **fromJSON**(`json`): `Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> -Defined in: [packages/sequencer/src/helpers/utils.ts:142](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L142) +Defined in: [packages/sequencer/src/helpers/utils.ts:142](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L142) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:142](https://github.com/pro > **fromJSONProof**(`jsonProof`): `Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> -Defined in: [packages/sequencer/src/helpers/utils.ts:149](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L149) +Defined in: [packages/sequencer/src/helpers/utils.ts:149](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L149) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:149](https://github.com/pro > `protected` **getDummy**\<`T`\>(`c`, `jsonProof`): `T` -Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L41) +Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L41) #### Type Parameters @@ -124,7 +124,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/prot > **toJSON**(`proof`): `string` -Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L65) +Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L65) #### Parameters @@ -150,7 +150,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/prot > **toJSONProof**(`proof`): `JsonProof` -Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L73) +Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L73) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/Flow.md b/src/pages/docs/reference/sequencer/classes/Flow.md index 0c7113a..8f157e5 100644 --- a/src/pages/docs/reference/sequencer/classes/Flow.md +++ b/src/pages/docs/reference/sequencer/classes/Flow.md @@ -10,7 +10,7 @@ title: Flow # Class: Flow\ -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L20) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L20) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:20](https://github.com/p > **new Flow**\<`State`\>(`queueImpl`, `flowId`, `state`): [`Flow`](Flow.md)\<`State`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L42) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L42) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:42](https://github.com/p > `readonly` **flowId**: `string` -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L44) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L44) *** @@ -60,7 +60,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:44](https://github.com/p > **state**: `State` -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L45) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L45) *** @@ -68,7 +68,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:45](https://github.com/p > **tasksInProgress**: `number` = `0` -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L40) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L40) ## Methods @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:40](https://github.com/p > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:166](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L166) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:166](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L166) #### Returns @@ -92,7 +92,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:166](https://github.com/ > **forEach**\<`Type`\>(`inputs`, `fun`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:145](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L145) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:145](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L145) #### Type Parameters @@ -118,7 +118,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:145](https://github.com/ > **pushTask**\<`Input`, `Result`\>(`task`, `input`, `completed`?, `overrides`?): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:102](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L102) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L102) #### Type Parameters @@ -156,7 +156,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:102](https://github.com/ > **reject**(`error`): `void` -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L75) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L75) #### Parameters @@ -174,7 +174,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:75](https://github.com/p > **resolve**\<`Result`\>(`result`): `void` -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L68) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L68) #### Type Parameters @@ -196,7 +196,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:68](https://github.com/p > **withFlow**\<`Result`\>(`executor`): `Promise`\<`Result`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:153](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L153) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:153](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L153) #### Type Parameters diff --git a/src/pages/docs/reference/sequencer/classes/FlowCreator.md b/src/pages/docs/reference/sequencer/classes/FlowCreator.md index bd51322..0b1a943 100644 --- a/src/pages/docs/reference/sequencer/classes/FlowCreator.md +++ b/src/pages/docs/reference/sequencer/classes/FlowCreator.md @@ -10,7 +10,7 @@ title: FlowCreator # Class: FlowCreator -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:178](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L178) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:178](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L178) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:178](https://github.com/ > **new FlowCreator**(`queueImpl`): [`FlowCreator`](FlowCreator.md) -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:179](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L179) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:179](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L179) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/sequencer/src/worker/flow/Flow.ts:179](https://github.com/ > **createFlow**\<`State`\>(`flowId`, `state`): [`Flow`](Flow.md)\<`State`\> -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:183](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Flow.ts#L183) +Defined in: [packages/sequencer/src/worker/flow/Flow.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L183) #### Type Parameters diff --git a/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md b/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md index 5c0f2c3..8cebbf8 100644 --- a/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md +++ b/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md @@ -10,7 +10,7 @@ title: FlowTaskWorker # Class: FlowTaskWorker\ -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L15) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L15) ## Type Parameters @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:15](https:// > **new FlowTaskWorker**\<`Tasks`\>(`mq`, `tasks`): [`FlowTaskWorker`](FlowTaskWorker.md)\<`Tasks`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L22) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L22) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:22](https:// > `optional` **preparePromise**: `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L78) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L78) *** @@ -56,7 +56,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:78](https:// > `optional` **prepareResolve**: () => `void` -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L80) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L80) #### Returns @@ -68,7 +68,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:80](https:// > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:165](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L165) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:165](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L165) #### Returns @@ -84,7 +84,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:165](https:/ > **prepareTasks**(`tasks`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L86) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L86) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:86](https:// > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L112) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L112) #### Returns @@ -114,7 +114,7 @@ Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:112](https:/ > **waitForPrepared**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L82) +Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L82) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md index 83d2dd4..5496bb8 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md @@ -10,7 +10,7 @@ title: InMemoryAsyncMerkleTreeStore # Class: InMemoryAsyncMerkleTreeStore -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L9) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L9) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStor > **commit**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L18) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L18) #### Returns @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStor > **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L26) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L26) #### Parameters @@ -70,7 +70,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStor > **openTransaction**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L22) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L22) #### Returns @@ -86,7 +86,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStor > **writeNodes**(`nodes`): `void` -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L12) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L12) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md index 80b7468..f3a4207 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md @@ -10,7 +10,7 @@ title: InMemoryBatchStorage # Class: InMemoryBatchStorage -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L9) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L9) ## Implements @@ -33,7 +33,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:9]( > **getBatchAt**(`height`): `Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L18) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L18) #### Parameters @@ -55,7 +55,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:18] > **getCurrentBatchHeight**(): `Promise`\<`number`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L14) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L14) #### Returns @@ -71,7 +71,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:14] > **getLatestBatch**(): `Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L27) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L27) #### Returns @@ -87,7 +87,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:27] > **pushBatch**(`batch`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L22) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L22) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md index e71980b..6d64dc5 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md @@ -10,7 +10,7 @@ title: InMemoryBlockStorage # Class: InMemoryBlockStorage -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L18) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L18) ## Implements @@ -24,7 +24,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:18] > **new InMemoryBlockStorage**(`batchStorage`): [`InMemoryBlockStorage`](InMemoryBlockStorage.md) -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L21) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L21) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:21] > **getBlock**(`hash`): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L112) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L112) #### Parameters @@ -64,7 +64,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:112 > **getBlockAt**(`height`): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L29) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L29) #### Parameters @@ -86,7 +86,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:29] > **getCurrentBlockHeight**(): `Promise`\<`number`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L33) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L33) #### Returns @@ -102,7 +102,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:33] > **getLatestBlock**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L52) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L52) #### Returns @@ -118,7 +118,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:52] > **getLatestBlockAndResult**(): `Promise`\<`undefined` \| [`BlockWithMaybeResult`](../interfaces/BlockWithMaybeResult.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L37) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L37) #### Returns @@ -134,7 +134,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:37] > **getNewBlocks**(): `Promise`\<[`BlockWithPreviousResult`](../interfaces/BlockWithPreviousResult.md)[]\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L68) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L68) #### Returns @@ -150,7 +150,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:68] > **getNewestResult**(): `Promise`\<`undefined` \| [`BlockResult`](../interfaces/BlockResult.md)\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:104](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L104) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:104](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L104) #### Returns @@ -162,7 +162,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:104 > **pushBlock**(`block`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:100](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L100) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:100](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L100) #### Parameters @@ -184,7 +184,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:100 > **pushResult**(`result`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:108](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L108) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L108) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md b/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md index b6e9bbb..dfee034 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md @@ -10,7 +10,7 @@ title: InMemoryDatabase # Class: InMemoryDatabase -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L21) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L21) Lifecycle of a SequencerModule @@ -59,7 +59,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -105,7 +105,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L64) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L64) #### Returns @@ -143,7 +143,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): [`StorageDependencyMinimumDependencies`](../interfaces/StorageDependencyMinimumDependencies.md) -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L22) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L22) #### Returns @@ -159,7 +159,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:22](htt > **executeInTransaction**(`f`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:75](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L75) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L75) #### Parameters @@ -181,7 +181,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:75](htt > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L68) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L68) Prunes all data from the database connection. Note: This function should only be called immediately at startup, @@ -201,7 +201,7 @@ everything else will lead to unexpected behaviour and errors > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L60) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L60) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md index 6c30be4..c17ef58 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md @@ -10,7 +10,7 @@ title: InMemoryMessageStorage # Class: InMemoryMessageStorage -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L7) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L7) Interface to store Messages previously fetched by a IncomingMessageadapter @@ -34,7 +34,7 @@ Interface to store Messages previously fetched by a IncomingMessageadapter > **getMessages**(`fromMessagesHash`): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L10) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L10) #### Parameters @@ -56,7 +56,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:1 > **pushMessages**(`fromMessagesHash`, `toMessagesHash`, `messages`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L16) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md b/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md index e3e2723..5cf2443 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md +++ b/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md @@ -10,7 +10,7 @@ title: InMemorySettlementStorage # Class: InMemorySettlementStorage -Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L7) +Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L7) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.t > **settlements**: [`Settlement`](../interfaces/Settlement.md)[] = `[]` -Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L8) +Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L8) ## Methods @@ -40,7 +40,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.t > **pushSettlement**(`settlement`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L10) +Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L10) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md index cb96a54..9a55a15 100644 --- a/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md +++ b/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md @@ -10,7 +10,7 @@ title: InMemoryTransactionStorage # Class: InMemoryTransactionStorage -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L14) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L14) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage. > **new InMemoryTransactionStorage**(`blockStorage`, `batchStorage`): [`InMemoryTransactionStorage`](InMemoryTransactionStorage.md) -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L19) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L19) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage. > **findTransaction**(`hash`): `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](PendingTransaction.md); \}\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L73) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L73) Finds a transaction by its hash. It returns both pending transaction and already included transactions @@ -71,7 +71,7 @@ and batch number where applicable. > **getPendingUserTransactions**(): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L25) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L25) #### Returns @@ -87,7 +87,7 @@ Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage. > **pushUserTransaction**(`tx`): `Promise`\<`boolean`\> -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L46) +Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L46) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/ListenerList.md b/src/pages/docs/reference/sequencer/classes/ListenerList.md index bdc0ad7..2718b7e 100644 --- a/src/pages/docs/reference/sequencer/classes/ListenerList.md +++ b/src/pages/docs/reference/sequencer/classes/ListenerList.md @@ -10,7 +10,7 @@ title: ListenerList # Class: ListenerList\ -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/ListenerList.ts#L3) +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/ListenerList.ts#L3) ## Type Parameters @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:3](https://gith > **executeListeners**(`payload`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/ListenerList.ts#L15) +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/ListenerList.ts#L15) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:15](https://git > **getListeners**(): `object`[] -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/ListenerList.ts#L11) +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/ListenerList.ts#L11) #### Returns @@ -62,7 +62,7 @@ Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:11](https://git > **pushListener**(`listener`): `number` -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/ListenerList.ts#L22) +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/ListenerList.ts#L22) #### Parameters @@ -80,7 +80,7 @@ Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:22](https://git > **removeListener**(`listenerId`): `void` -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/ListenerList.ts#L34) +Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/ListenerList.ts#L34) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md b/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md index 20c0c17..dbe2253 100644 --- a/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md +++ b/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md @@ -10,7 +10,7 @@ title: LocalTaskQueue # Class: LocalTaskQueue -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L74) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L74) Definition of a connection-object that can generate queues and workers for a specific connection type (e.g. BullMQ, In-memory) @@ -58,7 +58,7 @@ checks when retrieving it via the getter > `readonly` **listeners**: `object` = `{}` -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L92) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L92) #### Index Signature @@ -70,7 +70,7 @@ Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:92](https://g > **queuedTasks**: `object` = `{}` -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L78) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L78) #### Index Signature @@ -82,7 +82,7 @@ Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:78](https://g > `protected` **queues**: `Record`\<`string`, [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> = `{}` -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) #### Inherited from @@ -94,7 +94,7 @@ Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https:/ > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -140,7 +140,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > `protected` **closeQueues**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) #### Returns @@ -178,7 +178,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `protected` **createOrGetQueue**(`name`, `creator`): [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) +Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) #### Parameters @@ -204,7 +204,7 @@ Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https: > **createWorker**(`queueName`, `executor`, `options`?): [`Closeable`](../interfaces/Closeable.md) -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:146](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L146) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:149](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L149) #### Parameters @@ -240,7 +240,7 @@ Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:146](https:// > **getQueue**(`queueName`): `Promise`\<[`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:186](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L186) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:189](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L189) #### Parameters @@ -262,7 +262,7 @@ Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:186](https:// > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:193](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L193) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:196](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L196) Start the module and all it's functionality. The returned Promise has to resolve after initialization, @@ -283,7 +283,7 @@ That means that you mustn't await server.start() for example. > **workNextTasks**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:98](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L98) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:98](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L98) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md b/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md index a8645d6..ed4c09a 100644 --- a/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md +++ b/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md @@ -10,7 +10,7 @@ title: LocalTaskWorkerModule # Class: LocalTaskWorkerModule\ -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L56) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L56) This module spins up a worker in the current local node instance. This should only be used for local testing/development and not in a @@ -36,7 +36,7 @@ cloud workers. > **new LocalTaskWorkerModule**\<`Tasks`\>(`modules`): [`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L80) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L80) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:80](h > **containerEvents**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<`LocalTaskWorkerModuleEvents`\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L64) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L64) #### Implementation of @@ -101,7 +101,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L62) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L62) #### Implementation of @@ -255,7 +255,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:124](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L124) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:124](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L124) #### Returns @@ -615,7 +615,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:100](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L100) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:100](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L100) Start the module and all it's functionality. The returned Promise has to resolve after initialization, @@ -665,7 +665,7 @@ such as only injecting other known modules. > `static` **from**\<`Tasks`\>(`modules`): [`TypedClass`](../type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\>\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L70) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L70) #### Type Parameters diff --git a/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md b/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md index 984cab1..996f339 100644 --- a/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md +++ b/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md @@ -10,7 +10,7 @@ title: ManualBlockTrigger # Class: ManualBlockTrigger -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L17) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L17) A BlockTrigger is the primary method to start the production of a block and all associated processes. @@ -29,7 +29,7 @@ all associated processes. > **new ManualBlockTrigger**(`batchProducerModule`, `blockProducerModule`, `settlementModule`, `blockQueue`, `batchStorage`, `settlementStorage`): [`ManualBlockTrigger`](ManualBlockTrigger.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L21) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L21) #### Parameters @@ -71,7 +71,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigg > `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) #### Inherited from @@ -83,7 +83,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) #### Inherited from @@ -95,7 +95,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) #### Inherited from @@ -107,7 +107,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) #### Inherited from @@ -134,7 +134,7 @@ checks when retrieving it via the getter > `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`BlockEvents`](../type-aliases/BlockEvents.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) #### Inherited from @@ -146,7 +146,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) #### Inherited from @@ -158,7 +158,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) #### Inherited from @@ -170,7 +170,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -238,7 +238,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L57) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L57) #### Returns @@ -254,7 +254,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigg > **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L65) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L65) #### Returns @@ -270,7 +270,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigg > **produceBlockAndBatch**(): `Promise`\<\[`undefined` \| [`Block`](../interfaces/Block.md), `undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\]\> -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L50) Produces both an unproven block and immediately produce a settlement block proof @@ -285,7 +285,7 @@ settlement block proof > **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L69) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L69) #### Returns @@ -301,7 +301,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigg > **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L61) +Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L61) #### Parameters @@ -323,7 +323,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigg > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md b/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md index 87a5579..a416d6a 100644 --- a/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md +++ b/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md @@ -10,7 +10,7 @@ title: MinaBaseLayer # Class: MinaBaseLayer -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L35) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L35) Lifecycle of a SequencerModule @@ -31,7 +31,7 @@ start(): Executed to execute any logic required to start the module > **new MinaBaseLayer**(`areProofsEnabled`): [`MinaBaseLayer`](MinaBaseLayer.md) -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L43) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L43) #### Parameters @@ -68,7 +68,7 @@ checks when retrieving it via the getter > `optional` **network**: `Mina` -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L39) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L39) *** @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:39](http > `optional` **originalNetwork**: `Mina` -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L41) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L41) *** @@ -84,7 +84,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:41](http > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -152,7 +152,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): `object` -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L50) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L50) #### Returns @@ -192,7 +192,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:50](http > **isLocalBlockChain**(): `boolean` -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L66) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L66) #### Returns @@ -204,7 +204,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:66](http > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:70](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L70) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L70) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md b/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md index 26a7e82..6a312c0 100644 --- a/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md +++ b/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md @@ -10,7 +10,7 @@ title: MinaIncomingMessageAdapter # Class: MinaIncomingMessageAdapter -Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L34) +Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L34) IncomingMessageAdapter implementation for a Mina Baselayer based on decoding L1-dispatched actions @@ -25,7 +25,7 @@ based on decoding L1-dispatched actions > **new MinaIncomingMessageAdapter**(`baseLayer`, `runtime`, `protocol`): [`MinaIncomingMessageAdapter`](MinaIncomingMessageAdapter.md) -Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L35) +Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L35) #### Parameters @@ -51,7 +51,7 @@ Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapt > **getPendingMessages**(`address`, `params`): `Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](PendingTransaction.md)[]; `to`: `string`; \}\> -Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:99](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L99) +Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:99](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L99) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md b/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md index fe5a772..f09ae81 100644 --- a/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md +++ b/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md @@ -10,7 +10,7 @@ title: MinaSimulationService # Class: MinaSimulationService -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L17) +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L17) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationServic > **new MinaSimulationService**(`baseLayer`): [`MinaSimulationService`](MinaSimulationService.md) -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L18) +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L18) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationServic > **applyTransaction**(`tx`): `void` -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L65) +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L65) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationServic > **updateAccount**(`publicKey`, `tokenId`?): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L41) +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L41) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationServic > **updateNetworkState**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L36) +Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L36) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md b/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md index 71df160..d4eccc8 100644 --- a/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md +++ b/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md @@ -10,7 +10,7 @@ title: MinaTransactionSender # Class: MinaTransactionSender -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L29) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L29) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSende > **new MinaTransactionSender**(`creator`, `provingTask`, `simulator`, `baseLayer`): [`MinaTransactionSender`](MinaTransactionSender.md) -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L39) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L39) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSende > **proveAndSendTransaction**(`transaction`, `waitOnStatus`): `Promise`\<[`EventListenable`](../../common/type-aliases/EventListenable.md)\<[`TxEvents`](../interfaces/TxEvents.md)\>\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:116](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L116) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:116](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L116) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md b/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md index f6d8689..e36b10b 100644 --- a/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md +++ b/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md @@ -10,7 +10,7 @@ title: MinaTransactionSimulator # Class: MinaTransactionSimulator -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L32) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L32) Custom variant of the ocaml ledger implementation that applies account updates to a ledger state. It isn't feature complete and is mainly used to update the @@ -22,7 +22,7 @@ o1js internal account cache to create batched transactions > **new MinaTransactionSimulator**(`baseLayer`): [`MinaTransactionSimulator`](MinaTransactionSimulator.md) -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L37) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L37) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **apply**(`account`, `au`): `void` -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:247](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L247) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:247](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L247) #### Parameters @@ -62,7 +62,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **applyFeepayer**(`account`, `feepayer`): `void` -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:242](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L242) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:242](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L242) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **applyTransaction**(`tx`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L86) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L86) #### Parameters @@ -102,7 +102,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **checkFeePayer**(`account`, `feepayer`): `boolean` -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:199](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L199) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:199](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L199) #### Parameters @@ -124,7 +124,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **checkPreconditions**(`account`, `au`): `string`[] -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:206](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L206) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:206](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L206) #### Parameters @@ -146,7 +146,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **getAccount**(`publicKey`, `tokenId`?): `Promise`\<`Account`\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:142](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L142) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:142](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L142) #### Parameters @@ -168,7 +168,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **getAccounts**(`tx`): `Promise`\<`Account`[]\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L80) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L80) #### Parameters @@ -186,7 +186,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimul > **reloadAccount**(`publicKey`, `tokenId`?): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:163](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L163) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:163](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L163) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md b/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md index 5b31327..ec4485e 100644 --- a/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md +++ b/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md @@ -10,7 +10,7 @@ title: NetworkStateQuery # Class: NetworkStateQuery -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L5) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L5) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:5](https: > **new NetworkStateQuery**(`transportModule`): [`NetworkStateQuery`](NetworkStateQuery.md) -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L6) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L6) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:6](https: > **get** **proven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L18) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L18) ##### Returns @@ -52,7 +52,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:18](https > **get** **stagedUnproven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L14) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L14) ##### Returns @@ -66,7 +66,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:14](https > **get** **unproven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L10) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L10) ##### Returns diff --git a/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md index bbbcbde..e2e5a0f 100644 --- a/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md @@ -10,7 +10,7 @@ title: NewBlockProvingParametersSerializer # Class: NewBlockProvingParametersSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L38) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L38) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlo > **new NewBlockProvingParametersSerializer**(`stProofSerializer`, `blockProofSerializer`): [`NewBlockProvingParametersSerializer`](NewBlockProvingParametersSerializer.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L41) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L41) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlo > **fromJSON**(`json`): `Promise`\<`NewBlockPayload`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L73) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L73) #### Parameters @@ -66,7 +66,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlo > **toJSON**(`input`): `string` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L52) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L52) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/NewBlockTask.md b/src/pages/docs/reference/sequencer/classes/NewBlockTask.md index f72a98c..d5faebf 100644 --- a/src/pages/docs/reference/sequencer/classes/NewBlockTask.md +++ b/src/pages/docs/reference/sequencer/classes/NewBlockTask.md @@ -10,7 +10,7 @@ title: NewBlockTask # Class: NewBlockTask -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L45) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new NewBlockTask**(`protocol`, `executionContext`, `compileRegistry`): [`NewBlockTask`](NewBlockTask.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L55) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L55) #### Parameters @@ -73,7 +73,7 @@ checks when retrieving it via the getter > `readonly` **name**: `"newBlock"` = `"newBlock"` -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L53) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L53) #### Implementation of @@ -119,7 +119,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<`BlockProof`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:105](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L105) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L105) #### Parameters @@ -163,7 +163,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L66) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L66) #### Returns @@ -179,7 +179,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:66 > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:129](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L129) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L129) #### Returns @@ -195,7 +195,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:12 > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`BlockProof`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:81](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L81) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L81) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md b/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md index b2a052a..9ab5bc1 100644 --- a/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md +++ b/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md @@ -10,7 +10,7 @@ title: NoopBaseLayer # Class: NoopBaseLayer -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L53) +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L53) Lifecycle of a SequencerModule @@ -59,7 +59,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -105,7 +105,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **blockProduced**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L54) +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L54) #### Returns @@ -139,7 +139,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): [`BaseLayerDependencyRecord`](../interfaces/BaseLayerDependencyRecord.md) -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L62) +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L62) #### Returns @@ -155,7 +155,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:62](http > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L58) +Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L58) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md index cfdadcb..0d1f7db 100644 --- a/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md @@ -10,7 +10,7 @@ title: PairProofTaskSerializer # Class: PairProofTaskSerializer\ -Defined in: [packages/sequencer/src/helpers/utils.ts:164](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L164) +Defined in: [packages/sequencer/src/helpers/utils.ts:164](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L164) ## Type Parameters @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:164](https://github.com/pro > **new PairProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`PairProofTaskSerializer`](PairProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> -Defined in: [packages/sequencer/src/helpers/utils.ts:170](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L170) +Defined in: [packages/sequencer/src/helpers/utils.ts:170](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L170) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:170](https://github.com/pro > **fromJSON**(`json`): `Promise`\<[`PairTuple`](../type-aliases/PairTuple.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\>\> -Defined in: [packages/sequencer/src/helpers/utils.ts:176](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L176) +Defined in: [packages/sequencer/src/helpers/utils.ts:176](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L176) #### Parameters @@ -68,7 +68,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:176](https://github.com/pro > **toJSON**(`input`): `string` -Defined in: [packages/sequencer/src/helpers/utils.ts:187](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L187) +Defined in: [packages/sequencer/src/helpers/utils.ts:187](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L187) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/PendingTransaction.md b/src/pages/docs/reference/sequencer/classes/PendingTransaction.md index a358c76..6327e0d 100644 --- a/src/pages/docs/reference/sequencer/classes/PendingTransaction.md +++ b/src/pages/docs/reference/sequencer/classes/PendingTransaction.md @@ -10,7 +10,7 @@ title: PendingTransaction # Class: PendingTransaction -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:123](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L123) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:123](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L123) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:123](https://g > **new PendingTransaction**(`data`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:140](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L140) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:140](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L140) #### Parameters @@ -70,7 +70,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:140](https://g > **argsFields**: `Field`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L37) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L37) #### Inherited from @@ -82,7 +82,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://gi > **auxiliaryData**: `string`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L39) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L39) Used to transport non-provable data, mainly proof data for now These values will not be part of the signature message or transaction hash @@ -97,7 +97,7 @@ These values will not be part of the signature message or transaction hash > **isMessage**: `boolean` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L41) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L41) #### Inherited from @@ -109,7 +109,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://gi > **methodId**: `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L31) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L31) #### Inherited from @@ -121,7 +121,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://gi > **nonce**: `UInt64` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L33) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L33) #### Inherited from @@ -133,7 +133,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://gi > **sender**: `PublicKey` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L35) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L35) #### Inherited from @@ -145,7 +145,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://gi > **signature**: `Signature` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:138](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L138) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:138](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L138) ## Methods @@ -153,7 +153,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:138](https://g > **argsHash**(): `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L59) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L59) #### Returns @@ -169,7 +169,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://gi > **getSignatureData**(): `Field`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L72) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L72) #### Returns @@ -185,7 +185,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://gi > **hash**(): `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L63) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L63) #### Returns @@ -201,7 +201,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://gi > **sign**(`privateKey`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L80) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L80) #### Parameters @@ -223,7 +223,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://gi > **signed**(`signature`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L95) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L95) #### Parameters @@ -245,7 +245,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://gi > **toJSON**(): `PendingTransactionJSONType` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:153](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L153) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:153](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L153) #### Returns @@ -257,7 +257,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:153](https://g > **toProtocolTransaction**(): [`SignedTransaction`](../../protocol/classes/SignedTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:171](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L171) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:171](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L171) #### Returns @@ -269,7 +269,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:171](https://g > **toRuntimeTransaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L85) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L85) #### Returns @@ -285,7 +285,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://gi > `static` **fromJSON**(`object`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:124](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L124) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:124](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L124) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md b/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md index 34fecc1..e9f7569 100644 --- a/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md +++ b/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md @@ -10,7 +10,7 @@ title: PreFilledStateService # Class: PreFilledStateService -Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L4) +Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L4) Naive implementation of an in-memory variant of the StateService interface @@ -24,7 +24,7 @@ Naive implementation of an in-memory variant of the StateService interface > **new PreFilledStateService**(`values`): [`PreFilledStateService`](PreFilledStateService.md) -Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L5) +Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L5) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/PrivateMempool.md b/src/pages/docs/reference/sequencer/classes/PrivateMempool.md index 1c98fde..7739489 100644 --- a/src/pages/docs/reference/sequencer/classes/PrivateMempool.md +++ b/src/pages/docs/reference/sequencer/classes/PrivateMempool.md @@ -10,7 +10,7 @@ title: PrivateMempool # Class: PrivateMempool -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L36) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L36) Lifecycle of a SequencerModule @@ -30,7 +30,7 @@ start(): Executed to execute any logic required to start the module > **new PrivateMempool**(`transactionValidator`, `transactionStorage`, `protocol`, `sequencer`, `stateService`): [`PrivateMempool`](PrivateMempool.md) -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L41) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L41) #### Parameters @@ -83,7 +83,7 @@ checks when retrieving it via the getter > `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`MempoolEvents`](../type-aliases/MempoolEvents.md)\> -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L37) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L37) #### Implementation of @@ -95,7 +95,7 @@ Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:37](https: > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -141,7 +141,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **add**(`tx`): `Promise`\<`boolean`\> -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L57) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L57) Add a transaction to the mempool @@ -189,7 +189,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **getStagedNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:91](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L91) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:91](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L91) #### Returns @@ -201,7 +201,7 @@ Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:91](https: > **getTxs**(`limit`?): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:96](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L96) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:96](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L96) Retrieve all transactions that are currently in the mempool @@ -225,7 +225,7 @@ Retrieve all transactions that are currently in the mempool > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:200](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/private/PrivateMempool.ts#L200) +Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:200](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L200) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md index 9fdd6dd..4c335a7 100644 --- a/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md @@ -10,7 +10,7 @@ title: ProofTaskSerializer # Class: ProofTaskSerializer\ -Defined in: [packages/sequencer/src/helpers/utils.ts:100](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L100) +Defined in: [packages/sequencer/src/helpers/utils.ts:100](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L100) ## Extends @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:100](https://github.com/pro > **new ProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`ProofTaskSerializer`](ProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> -Defined in: [packages/sequencer/src/helpers/utils.ts:104](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L104) +Defined in: [packages/sequencer/src/helpers/utils.ts:104](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L104) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:104](https://github.com/pro > **fromJSON**(`json`): `Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> -Defined in: [packages/sequencer/src/helpers/utils.ts:112](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L112) +Defined in: [packages/sequencer/src/helpers/utils.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L112) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:112](https://github.com/pro > **fromJSONProof**(`jsonProof`): `Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> -Defined in: [packages/sequencer/src/helpers/utils.ts:119](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L119) +Defined in: [packages/sequencer/src/helpers/utils.ts:119](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L119) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:119](https://github.com/pro > `protected` **getDummy**\<`T`\>(`c`, `jsonProof`): `T` -Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L41) +Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L41) #### Type Parameters @@ -124,7 +124,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/prot > **toJSON**(`proof`): `string` -Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L65) +Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L65) #### Parameters @@ -150,7 +150,7 @@ Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/prot > **toJSONProof**(`proof`): `JsonProof` -Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L73) +Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L73) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md b/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md index 4f8d305..3887dc7 100644 --- a/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md +++ b/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md @@ -10,7 +10,7 @@ title: ProvenSettlementPermissions # Class: ProvenSettlementPermissions -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L5) +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L5) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermi > **bridgeContractMina**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L35) +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L35) #### Returns @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermi > **bridgeContractToken**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L39) +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L39) #### Returns @@ -64,7 +64,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermi > **dispatchContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L31) +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L31) #### Returns @@ -80,7 +80,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermi > **settlementContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L27) +Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L27) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md b/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md index 915fbf7..31be168 100644 --- a/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md +++ b/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md @@ -10,7 +10,7 @@ title: ReductionTaskFlow # Class: ReductionTaskFlow\ -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L30) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L30) This class builds and executes a flow that follows the map-reduce pattern. This works in 2 steps: @@ -31,7 +31,7 @@ We use this pattern extensively in our pipeline, > **new ReductionTaskFlow**\<`Input`, `Output`\>(`options`, `flowCreator`): [`ReductionTaskFlow`](ReductionTaskFlow.md)\<`Input`, `Output`\> -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L37) #### Parameters @@ -71,7 +71,7 @@ Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.t > **deferErrorsTo**(`flow`): `void` -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:184](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L184) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:184](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L184) To be used in conjunction with onCompletion It allows errors from this flow to be "defered" to another parent @@ -94,7 +94,7 @@ error up to the user > **execute**(`inputs`): `Promise`\<`Output`\> -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:193](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L193) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:193](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L193) Execute the flow using the returned Promise that resolved when the flow is finished @@ -117,7 +117,7 @@ initial inputs - doesnt have to be the complete set of inputs > **onCompletion**(`callback`): `void` -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:173](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L173) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:173](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L173) Execute the flow using a callback method that is invoked upon completion of the flow. @@ -139,7 +139,7 @@ Push inputs using pushInput() > **pushInput**(`input`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:205](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L205) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:205](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L205) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md index 6b09075..cad1c8f 100644 --- a/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md @@ -10,7 +10,7 @@ title: RuntimeProofParametersSerializer # Class: RuntimeProofParametersSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L11) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L11) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Runtim > **fromJSON**(`json`): [`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L29) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L29) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Runtim > **toJSON**(`parameters`): `string` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L14) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L14) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md b/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md index acf2bf7..01d3cb0 100644 --- a/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md +++ b/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md @@ -10,7 +10,7 @@ title: RuntimeProvingTask # Class: RuntimeProvingTask -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L36) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L36) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new RuntimeProvingTask**(`runtime`, `executionContext`, `compileRegistry`): [`RuntimeProvingTask`](RuntimeProvingTask.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L45) #### Parameters @@ -73,7 +73,7 @@ checks when retrieving it via the getter > **name**: `string` = `"runtimeProof"` -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L43) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L43) #### Implementation of @@ -85,7 +85,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > `protected` `readonly` **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<`never`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L46) *** @@ -93,7 +93,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > `protected` `readonly` **runtimeZkProgrammable**: [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\>[] -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L40) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L40) ## Accessors @@ -135,7 +135,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<`RuntimeProof`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L61) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L61) #### Parameters @@ -179,7 +179,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L53) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L53) #### Returns @@ -195,7 +195,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:107](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L107) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:107](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L107) #### Returns @@ -211,7 +211,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`RuntimeProof`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L57) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L57) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md b/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md index 5d20627..46c6709 100644 --- a/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md @@ -10,7 +10,7 @@ title: RuntimeVerificationKeyAttestationSerializer # Class: RuntimeVerificationKeyAttestationSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L9) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L9) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Runtim > `static` **fromJSON**(`json`): [`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L10) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L10) #### Parameters @@ -68,7 +68,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Runtim > `static` **toJSON**(`attestation`): `object` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L20) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L20) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/Sequencer.md b/src/pages/docs/reference/sequencer/classes/Sequencer.md index bf7c469..bd55ea3 100644 --- a/src/pages/docs/reference/sequencer/classes/Sequencer.md +++ b/src/pages/docs/reference/sequencer/classes/Sequencer.md @@ -10,7 +10,7 @@ title: Sequencer # Class: Sequencer\ -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L30) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L30) Reusable module container facilitating registration, resolution configuration, decoration and validation of modules @@ -136,7 +136,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 > **get** **dependencyContainer**(): `DependencyContainer` -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L61) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L61) ##### Returns @@ -188,7 +188,7 @@ list of module names > **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L53) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L53) ##### Returns @@ -202,7 +202,7 @@ Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:53](https:// > **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L49) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L49) ##### Returns @@ -262,7 +262,7 @@ using e.g. a for loop. > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:125](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L125) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:128](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L128) #### Returns @@ -618,7 +618,7 @@ Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L69) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L69) Starts the sequencer by iterating over all provided modules to start each @@ -666,7 +666,7 @@ such as only injecting other known modules. > `static` **from**\<`Modules`\>(`definition`): [`TypedClass`](../type-aliases/TypedClass.md)\<[`Sequencer`](Sequencer.md)\<`Modules`\>\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L39) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L39) Alternative constructor for Sequencer diff --git a/src/pages/docs/reference/sequencer/classes/SequencerModule.md b/src/pages/docs/reference/sequencer/classes/SequencerModule.md index 10527cd..e4c4f05 100644 --- a/src/pages/docs/reference/sequencer/classes/SequencerModule.md +++ b/src/pages/docs/reference/sequencer/classes/SequencerModule.md @@ -10,7 +10,7 @@ title: SequencerModule # Class: `abstract` SequencerModule\ -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L15) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L15) Lifecycle of a SequencerModule @@ -79,7 +79,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) ## Accessors @@ -143,7 +143,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `abstract` **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md b/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md index 509cc65..8ff9424 100644 --- a/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md +++ b/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md @@ -10,7 +10,7 @@ title: SequencerStartupModule # Class: SequencerStartupModule -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L28) +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L28) Lifecycle of a SequencerModule @@ -30,7 +30,7 @@ start(): Executed to execute any logic required to start the module > **new SequencerStartupModule**(`flowCreator`, `protocol`, `compileTask`, `verificationKeyService`, `registrationFlow`, `compileRegistry`): [`SequencerStartupModule`](SequencerStartupModule.md) -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L32) +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L32) #### Parameters @@ -87,7 +87,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -133,7 +133,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:153](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L153) +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:153](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L153) #### Returns @@ -149,7 +149,7 @@ Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:153](htt > **compileRuntime**(`flow`): `Promise`\<`bigint`\> -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L55) +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L55) #### Parameters @@ -189,7 +189,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:122](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L122) +Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L122) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/SettlementModule.md b/src/pages/docs/reference/sequencer/classes/SettlementModule.md index 923233e..3d86039 100644 --- a/src/pages/docs/reference/sequencer/classes/SettlementModule.md +++ b/src/pages/docs/reference/sequencer/classes/SettlementModule.md @@ -10,7 +10,7 @@ title: SettlementModule # Class: SettlementModule -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L62) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L62) Lifecycle of a SequencerModule @@ -31,7 +31,7 @@ start(): Executed to execute any logic required to start the module > **new SettlementModule**(`baseLayer`, `protocol`, `incomingMessagesAdapter`, `messageStorage`, `blockProofSerializer`, `transactionSender`, `areProofsEnabled`, `feeStrategy`, `settlementStartupModule`): [`SettlementModule`](SettlementModule.md) -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:86](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L86) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L86) #### Parameters @@ -85,7 +85,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:86](https://g > `optional` **addresses**: `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L71) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L71) #### dispatch @@ -101,7 +101,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:71](https://g > `protected` `optional` **contracts**: `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L66) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L66) #### dispatch @@ -132,7 +132,7 @@ checks when retrieving it via the getter > **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`SettlementModuleEvents`](../type-aliases/SettlementModuleEvents.md)\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L84) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L84) #### Implementation of @@ -144,7 +144,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:84](https://g > `optional` **keys**: `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L76) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:76](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L76) #### dispatch @@ -164,7 +164,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:76](https://g > **utils**: `SettlementUtils` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:82](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L82) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L82) *** @@ -172,7 +172,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:82](https://g > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -240,7 +240,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **dependencies**(): `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:106](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L106) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:106](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L106) #### Returns @@ -264,7 +264,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:106](https:// > **deploy**(`settlementKey`, `dispatchKey`, `minaBridgeKey`, `options`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:243](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L243) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:243](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L243) #### Parameters @@ -296,7 +296,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:243](https:// > **deployTokenBridge**(`owner`, `ownerKey`, `contractKey`, `options`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:343](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L343) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:343](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L343) #### Parameters @@ -328,7 +328,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:343](https:// > **getContracts**(): `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:127](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L127) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:127](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L127) #### Returns @@ -348,7 +348,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:127](https:// > **settleBatch**(`batch`, `options`): `Promise`\<[`Settlement`](../interfaces/Settlement.md)\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:164](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L164) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:164](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L164) #### Parameters @@ -372,7 +372,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:164](https:// > `protected` **settlementContractModule**(): [`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md)\<[`MandatorySettlementModulesRecord`](../../protocol/type-aliases/MandatorySettlementModulesRecord.md)\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L114) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L114) #### Returns @@ -384,7 +384,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:114](https:// > **signTransaction**(`tx`, `pks`): `Transaction`\<`false`, `true`\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:149](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L149) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:149](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L149) #### Parameters @@ -406,7 +406,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:149](https:// > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:387](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L387) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:387](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L387) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md b/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md index c2b38ba..938dca4 100644 --- a/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md +++ b/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md @@ -10,7 +10,7 @@ title: SettlementProvingTask # Class: SettlementProvingTask -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L72) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L72) Implementation of a task to prove any Mina transaction. The o1js-internal account state is configurable via the task args. @@ -31,7 +31,7 @@ the provided AccountUpdate > **new SettlementProvingTask**(`protocol`, `compileRegistry`, `areProofsEnabled`): [`SettlementProvingTask`](SettlementProvingTask.md) -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:84](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L84) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L84) #### Parameters @@ -76,7 +76,7 @@ checks when retrieving it via the getter > **name**: `string` = `"settlementTransactions"` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:76](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L76) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:76](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L76) #### Implementation of @@ -88,7 +88,7 @@ Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:76 > **settlementContractModule**: `undefined` \| [`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md)\<[`MandatorySettlementModulesRecord`](../../protocol/type-aliases/MandatorySettlementModulesRecord.md)\> = `undefined` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L78) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L78) ## Accessors @@ -130,7 +130,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:125](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L125) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:125](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L125) #### Parameters @@ -174,7 +174,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskArgs`](../type-aliases/TransactionTaskArgs.md)\> -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:158](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L158) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:158](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L158) #### Returns @@ -190,7 +190,7 @@ Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:15 > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:395](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L395) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:395](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L395) #### Returns @@ -206,7 +206,7 @@ Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:39 > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:432](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L432) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:432](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L432) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md b/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md index aa66c28..5e68a50 100644 --- a/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md +++ b/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md @@ -10,7 +10,7 @@ title: SignedSettlementPermissions # Class: SignedSettlementPermissions -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L5) +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L5) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermi > **bridgeContractMina**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L28) +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L28) #### Returns @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermi > **bridgeContractToken**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L32) +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L32) #### Returns @@ -64,7 +64,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermi > **dispatchContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L20) +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L20) #### Returns @@ -80,7 +80,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermi > **settlementContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L24) +Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L24) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md b/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md index e4a83bc..9b392a1 100644 --- a/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md +++ b/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md @@ -10,7 +10,7 @@ title: SomeProofSubclass # Class: SomeProofSubclass -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L58) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L58) ## Extends @@ -118,7 +118,7 @@ Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:92 > `static` **publicInputType**: *typeof* `Field` & (`x`) => `Field` = `Field` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L59) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L59) #### Overrides @@ -130,7 +130,7 @@ Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:59 > `static` **publicOutputType**: `ProvablePureExtended`\<`void`, `void`, `null`\> = `Void` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L61) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L61) #### Overrides diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md index 4580b04..2a5b4bd 100644 --- a/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md @@ -10,7 +10,7 @@ title: StateTransitionParametersSerializer # Class: StateTransitionParametersSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L21) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L21) ## Implements @@ -32,7 +32,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateT > **fromJSON**(`json`): [`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L43) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L43) #### Parameters @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateT > **toJSON**(`parameters`): `string` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L24) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L24) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md b/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md index 3fc33c9..be06999 100644 --- a/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md +++ b/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md @@ -10,7 +10,7 @@ title: StateTransitionReductionTask # Class: StateTransitionReductionTask -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L24) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L24) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new StateTransitionReductionTask**(`protocol`, `executionContext`, `compileRegistry`): [`StateTransitionReductionTask`](StateTransitionReductionTask.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L32) #### Parameters @@ -73,7 +73,7 @@ checks when retrieving it via the getter > **name**: `string` = `"stateTransitionReduction"` -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L30) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L30) #### Implementation of @@ -85,7 +85,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionRed > `protected` `readonly` **stateTransitionProver**: [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L28) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L28) ## Accessors @@ -127,7 +127,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L56) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L56) #### Parameters @@ -171,7 +171,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\>\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L44) #### Returns @@ -187,7 +187,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionRed > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L66) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L66) #### Returns @@ -203,7 +203,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionRed > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L50) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md b/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md index 3e63e5e..552fffe 100644 --- a/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md +++ b/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md @@ -10,7 +10,7 @@ title: StateTransitionTask # Class: StateTransitionTask -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L38) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L38) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new StateTransitionTask**(`protocol`, `executionContext`, `compileRegistry`): [`StateTransitionTask`](StateTransitionTask.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L46) #### Parameters @@ -73,7 +73,7 @@ checks when retrieving it via the getter > **name**: `string` = `"stateTransitionProof"` -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L44) #### Implementation of @@ -85,7 +85,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > `protected` `readonly` **stateTransitionProver**: [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L42) ## Accessors @@ -127,7 +127,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L68) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L68) #### Parameters @@ -171,7 +171,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L58) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L58) #### Returns @@ -187,7 +187,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:88](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L88) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L88) #### Returns @@ -203,7 +203,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:62](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L62) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L62) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md index 4f76ee8..cfa0b5b 100644 --- a/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md +++ b/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md @@ -10,7 +10,7 @@ title: SyncCachedMerkleTreeStore # Class: SyncCachedMerkleTreeStore -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L7) +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L7) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:7] > **new SyncCachedMerkleTreeStore**(`parent`): [`SyncCachedMerkleTreeStore`](SyncCachedMerkleTreeStore.md) -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L8) +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L8) #### Parameters @@ -60,7 +60,7 @@ Defined in: packages/common/dist/trees/InMemoryMerkleTreeStorage.d.ts:3 > **getNode**(`key`, `level`): `undefined` \| `bigint` -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L12) +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L12) #### Parameters @@ -86,7 +86,7 @@ Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:12 > **mergeIntoParent**(): `void` -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L20) +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L20) #### Returns @@ -98,7 +98,7 @@ Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:20 > **setNode**(`key`, `level`, `value`): `void` -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L16) +Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L16) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md b/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md index 4159e7b..36335cf 100644 --- a/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md +++ b/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md @@ -10,7 +10,7 @@ title: TaskWorkerModule # Class: `abstract` TaskWorkerModule -Defined in: [packages/sequencer/src/worker/worker/TaskWorkerModule.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/TaskWorkerModule.ts#L3) +Defined in: [packages/sequencer/src/worker/worker/TaskWorkerModule.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/TaskWorkerModule.ts#L3) Used by various module sub-types that may need to be configured diff --git a/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md b/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md index bbfbd40..71edb16 100644 --- a/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md +++ b/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md @@ -10,7 +10,7 @@ title: TimedBlockTrigger # Class: TimedBlockTrigger -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L36) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L36) A BlockTrigger is the primary method to start the production of a block and all associated processes. @@ -30,7 +30,7 @@ all associated processes. > **new TimedBlockTrigger**(`batchProducerModule`, `blockProducerModule`, `settlementModule`, `blockQueue`, `batchStorage`, `settlementStorage`, `mempool`): [`TimedBlockTrigger`](TimedBlockTrigger.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L44) #### Parameters @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) #### Inherited from @@ -100,7 +100,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) #### Inherited from @@ -112,7 +112,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) #### Inherited from @@ -139,7 +139,7 @@ checks when retrieving it via the getter > `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`TimedBlockTriggerEvent`](../interfaces/TimedBlockTriggerEvent.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) #### Inherited from @@ -151,7 +151,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) #### Inherited from @@ -163,7 +163,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) #### Inherited from @@ -175,7 +175,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -221,7 +221,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **close**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:137](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L137) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:137](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L137) #### Returns @@ -259,7 +259,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > `protected` **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) #### Returns @@ -275,7 +275,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) #### Returns @@ -291,7 +291,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) #### Returns @@ -307,7 +307,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > `protected` **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) #### Parameters @@ -329,7 +329,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:90](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L90) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:90](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L90) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md b/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md index b11d26a..281579a 100644 --- a/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md +++ b/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md @@ -10,7 +10,7 @@ title: TransactionExecutionService # Class: TransactionExecutionService -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:153](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L153) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:153](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L153) ## Constructors @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionEx > **new TransactionExecutionService**(`runtime`, `protocol`, `stateServiceProvider`): [`TransactionExecutionService`](TransactionExecutionService.md) -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:156](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L156) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:156](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L156) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionEx > **createExecutionTrace**(`asyncStateService`, `tx`, `networkState`): `Promise`\<[`TransactionExecutionResult`](../interfaces/TransactionExecutionResult.md)\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:209](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L209) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:209](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L209) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md b/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md index 6b4467e..f0a10bd 100644 --- a/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md +++ b/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md @@ -10,7 +10,7 @@ title: TransactionProvingTask # Class: TransactionProvingTask -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L50) Used by various module sub-types that may need to be configured @@ -28,7 +28,7 @@ Used by various module sub-types that may need to be configured > **new TransactionProvingTask**(`protocol`, `runtime`, `stateServiceProvider`, `executionContext`, `compileRegistry`): [`TransactionProvingTask`](TransactionProvingTask.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L63) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L63) #### Parameters @@ -81,7 +81,7 @@ checks when retrieving it via the getter > **name**: `string` = `"block"` -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L61) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L61) #### Implementation of @@ -127,7 +127,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 > **compute**(`input`): `Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:114](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L114) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L114) #### Parameters @@ -171,7 +171,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:79](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L79) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L79) #### Returns @@ -187,7 +187,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **prepare**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:144](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L144) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:144](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L144) #### Returns @@ -203,7 +203,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:92](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L92) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L92) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md b/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md index 2e3f5a9..4ebd3ed 100644 --- a/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md +++ b/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md @@ -10,7 +10,7 @@ title: TransactionProvingTaskParameterSerializer # Class: TransactionProvingTaskParameterSerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L18) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L18) ## Implements @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Transa > **new TransactionProvingTaskParameterSerializer**(`stProofSerializer`, `runtimeProofSerializer`): [`TransactionProvingTaskParameterSerializer`](TransactionProvingTaskParameterSerializer.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L21) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L21) #### Parameters @@ -44,7 +44,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Transa > **fromJSON**(`json`): `Promise`\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L57) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L57) #### Parameters @@ -66,7 +66,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Transa > **toJSON**(`input`): `string` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L32) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md b/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md index 673f3cd..13ff214 100644 --- a/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md +++ b/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md @@ -10,7 +10,7 @@ title: TransactionTraceService # Class: TransactionTraceService -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L36) +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L36) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService. > **createBlockTrace**(`traces`, `stateServices`, `blockHashTreeStore`, `beforeBlockStateRoot`, `block`): `Promise`\<[`BlockTrace`](../interfaces/BlockTrace.md)\> -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L78) +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L78) #### Parameters @@ -68,7 +68,7 @@ Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService. > **createTransactionTrace**(`executionResult`, `stateServices`, `verificationKeyService`, `networkState`, `bundleTracker`, `eternalBundleTracker`, `messageTracker`): `Promise`\<[`TransactionTrace`](../interfaces/TransactionTrace.md)\> -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:172](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L172) +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:172](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L172) What is in a trace? A trace has two parts: diff --git a/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md b/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md index db073f7..cbcbb2b 100644 --- a/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md +++ b/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md @@ -10,7 +10,7 @@ title: UnsignedTransaction # Class: UnsignedTransaction -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L30) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L30) ## Extended by @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:30](https://gi > **new UnsignedTransaction**(`data`): [`UnsignedTransaction`](UnsignedTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L43) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L43) #### Parameters @@ -66,7 +66,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:43](https://gi > **argsFields**: `Field`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L37) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L37) #### Implementation of @@ -78,7 +78,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://gi > **auxiliaryData**: `string`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L39) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L39) Used to transport non-provable data, mainly proof data for now These values will not be part of the signature message or transaction hash @@ -93,7 +93,7 @@ These values will not be part of the signature message or transaction hash > **isMessage**: `boolean` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L41) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L41) #### Implementation of @@ -105,7 +105,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://gi > **methodId**: `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L31) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L31) #### Implementation of @@ -117,7 +117,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://gi > **nonce**: `UInt64` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L33) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L33) #### Implementation of @@ -129,7 +129,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://gi > **sender**: `PublicKey` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L35) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L35) #### Implementation of @@ -141,7 +141,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://gi > **argsHash**(): `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L59) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L59) #### Returns @@ -153,7 +153,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://gi > **getSignatureData**(): `Field`[] -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L72) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L72) #### Returns @@ -165,7 +165,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://gi > **hash**(): `Field` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L63) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L63) #### Returns @@ -177,7 +177,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://gi > **sign**(`privateKey`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L80) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L80) #### Parameters @@ -195,7 +195,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://gi > **signed**(`signature`): [`PendingTransaction`](PendingTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L95) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L95) #### Parameters @@ -213,7 +213,7 @@ Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://gi > **toRuntimeTransaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L85) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L85) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/UntypedOption.md b/src/pages/docs/reference/sequencer/classes/UntypedOption.md index d81c8cd..93154af 100644 --- a/src/pages/docs/reference/sequencer/classes/UntypedOption.md +++ b/src/pages/docs/reference/sequencer/classes/UntypedOption.md @@ -10,7 +10,7 @@ title: UntypedOption # Class: UntypedOption -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L7) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L7) Option facilitating in-circuit values that may or may not exist. @@ -24,7 +24,7 @@ Option facilitating in-circuit values that may or may not exist. > **new UntypedOption**(`isSome`, `value`, `enforceEmpty`): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L32) #### Parameters @@ -78,7 +78,7 @@ Defined in: packages/protocol/dist/model/Option.d.ts:59 > **value**: `Field`[] -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L34) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L34) ## Accessors @@ -106,7 +106,7 @@ Tree representation of the current value > **clone**(): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L40) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L40) #### Returns @@ -122,7 +122,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts > `protected` **encodeValueToFields**(): `Field`[] -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L44) #### Returns @@ -219,7 +219,7 @@ Provable representation of the current option. > `static` **fromJSON**(`__namedParameters`): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L16) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L16) #### Parameters @@ -247,7 +247,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts > `static` **fromOption**\<`Value`\>(`option`): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L8) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L8) #### Type Parameters diff --git a/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md b/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md index 6f0e0e8..f8b37db 100644 --- a/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md +++ b/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md @@ -10,7 +10,7 @@ title: UntypedStateTransition # Class: UntypedStateTransition -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L10) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L10) Generic state transition that constraints the current method circuit to external state, by providing a state anchor. @@ -21,7 +21,7 @@ to external state, by providing a state anchor. > **new UntypedStateTransition**(`path`, `fromValue`, `toValue`): [`UntypedStateTransition`](UntypedStateTransition.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L35) #### Parameters @@ -47,7 +47,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **fromValue**: [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L37) *** @@ -55,7 +55,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **path**: `Field` -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L36) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L36) *** @@ -63,7 +63,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **toValue**: [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L38) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L38) ## Accessors @@ -73,7 +73,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **get** **from**(): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L41) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L41) ##### Returns @@ -87,7 +87,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **get** **to**(): [`UntypedOption`](UntypedOption.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:47](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L47) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L47) ##### Returns @@ -99,7 +99,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **toJSON**(): `object` -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:63](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L63) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L63) #### Returns @@ -147,7 +147,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > **toProvable**(): [`ProvableStateTransition`](../../protocol/classes/ProvableStateTransition.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L55) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L55) Converts a StateTransition to a ProvableStateTransition, while enforcing the 'from' property to be 'Some' in all cases. @@ -162,7 +162,7 @@ while enforcing the 'from' property to be 'Some' in all cases. > `static` **fromJSON**(`__namedParameters`): [`UntypedStateTransition`](UntypedStateTransition.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L19) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L19) #### Parameters @@ -214,7 +214,7 @@ Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTran > `static` **fromStateTransition**\<`Value`\>(`st`): [`UntypedStateTransition`](UntypedStateTransition.md) -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L11) +Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L11) #### Type Parameters diff --git a/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md b/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md index f0b26ce..a8a2f13 100644 --- a/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md +++ b/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md @@ -10,7 +10,7 @@ title: VanillaTaskWorkerModules # Class: VanillaTaskWorkerModules -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:131](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L131) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:131](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L131) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:131]( > `static` **allTasks**(): `object` -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:145](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L145) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:145](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L145) #### Returns @@ -76,7 +76,7 @@ Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:145]( > `static` **defaultConfig**(): `object` -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:152](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L152) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:152](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L152) #### Returns @@ -86,10 +86,6 @@ Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:152]( > **BlockBuildingTask**: `object` = `{}` -##### BlockProvingTask - -> **BlockProvingTask**: `object` = `{}` - ##### BlockReductionTask > **BlockReductionTask**: `object` = `{}` @@ -128,7 +124,7 @@ Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:152]( > `static` **withoutSettlement**(): `object` -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:132](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L132) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L132) #### Returns diff --git a/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md b/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md index 1862af7..a0bdb3b 100644 --- a/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md +++ b/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md @@ -10,7 +10,7 @@ title: VerificationKeySerializer # Class: VerificationKeySerializer -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L5) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L5) ## Constructors @@ -28,7 +28,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Verifi > `static` **fromJSON**(`json`): `VerificationKey` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L13) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L13) #### Parameters @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/Verifi > `static` **toJSON**(`verificationKey`): [`VerificationKeyJSON`](../type-aliases/VerificationKeyJSON.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L6) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L6) #### Parameters diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md b/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md index ed160d8..ee29a2a 100644 --- a/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md +++ b/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md @@ -10,7 +10,7 @@ title: WithdrawalEvent # Class: WithdrawalEvent -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L24) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L24) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L25) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L25) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:25](h > **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L26) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L26) #### Inherited from diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md b/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md index dd5d933..71bf3f1 100644 --- a/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md +++ b/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md @@ -10,7 +10,7 @@ title: WithdrawalKey # Class: WithdrawalKey -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L19) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L19) ## Extends @@ -50,7 +50,7 @@ Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 > **index**: `Field` = `Field` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L20) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L20) #### Inherited from @@ -62,7 +62,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:20](h > **tokenId**: `Field` = `Field` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L21) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L21) #### Inherited from diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md b/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md index a9628c5..41c2de3 100644 --- a/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md +++ b/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md @@ -10,7 +10,7 @@ title: WithdrawalQueue # Class: WithdrawalQueue -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L44) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L44) This interface allows the SettlementModule to retrieve information about pending L2-dispatched (outgoing) messages that it can then use to roll @@ -33,7 +33,7 @@ outgoing message type is not limited to Withdrawals > **new WithdrawalQueue**(`sequencer`): [`WithdrawalQueue`](WithdrawalQueue.md) -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L54) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L54) #### Parameters @@ -70,7 +70,7 @@ checks when retrieving it via the getter > `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) #### Inherited from @@ -138,7 +138,7 @@ Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 > **length**(): `number` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:74](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L74) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L74) #### Returns @@ -154,7 +154,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:74](h > **peek**(`num`): [`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L64) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L64) #### Parameters @@ -176,7 +176,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:64](h > **pop**(`num`): [`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:68](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L68) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L68) #### Parameters @@ -198,7 +198,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:68](h > **start**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:78](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L78) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L78) Start the module and all it's functionality. The returned Promise has to resolve after initialization, diff --git a/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md b/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md index d6e156b..45aa36d 100644 --- a/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md +++ b/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md @@ -10,7 +10,7 @@ title: WorkerReadyModule # Class: WorkerReadyModule -Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L11) +Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L11) Module to safely wait for the finish of the worker startup Behaves like a noop for non-worker appchain configurations @@ -21,7 +21,7 @@ Behaves like a noop for non-worker appchain configurations > **new WorkerReadyModule**(`localTaskWorkerModule`): [`WorkerReadyModule`](WorkerReadyModule.md) -Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L12) +Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L12) #### Parameters @@ -39,7 +39,7 @@ Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:12](https > **waitForReady**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L20) +Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L20) #### Returns diff --git a/src/pages/docs/reference/sequencer/functions/closeable.md b/src/pages/docs/reference/sequencer/functions/closeable.md index 959fa78..8ef1914 100644 --- a/src/pages/docs/reference/sequencer/functions/closeable.md +++ b/src/pages/docs/reference/sequencer/functions/closeable.md @@ -12,7 +12,7 @@ title: closeable > **closeable**(): (`target`) => `void` -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/Closeable.ts#L7) +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/Closeable.ts#L7) ## Returns diff --git a/src/pages/docs/reference/sequencer/functions/distinct.md b/src/pages/docs/reference/sequencer/functions/distinct.md index 1b18f15..d73f662 100644 --- a/src/pages/docs/reference/sequencer/functions/distinct.md +++ b/src/pages/docs/reference/sequencer/functions/distinct.md @@ -12,7 +12,7 @@ title: distinct > **distinct**\<`Value`\>(`value`, `index`, `array`): `boolean` -Defined in: [packages/sequencer/src/helpers/utils.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L7) +Defined in: [packages/sequencer/src/helpers/utils.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L7) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md b/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md index f852e15..e7aa629 100644 --- a/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md +++ b/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md @@ -12,7 +12,7 @@ title: distinctByPredicate > **distinctByPredicate**\<`Value`\>(`predicate`): (`value`, `index`, `array`) => `boolean` -Defined in: [packages/sequencer/src/helpers/utils.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L15) +Defined in: [packages/sequencer/src/helpers/utils.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L15) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/functions/distinctByString.md b/src/pages/docs/reference/sequencer/functions/distinctByString.md index 6438584..fd24635 100644 --- a/src/pages/docs/reference/sequencer/functions/distinctByString.md +++ b/src/pages/docs/reference/sequencer/functions/distinctByString.md @@ -12,7 +12,7 @@ title: distinctByString > **distinctByString**\<`Value`\>(`value`, `index`, `array`): `boolean` -Defined in: [packages/sequencer/src/helpers/utils.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L23) +Defined in: [packages/sequencer/src/helpers/utils.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L23) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md b/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md index 19ef681..fe8e3ec 100644 --- a/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md +++ b/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md @@ -12,7 +12,7 @@ title: executeWithExecutionContext > **executeWithExecutionContext**\<`MethodResult`\>(`method`, `contextInputs`, `runSimulated`): `Promise`\<[`RuntimeContextReducedExecutionResult`](../type-aliases/RuntimeContextReducedExecutionResult.md) & `object`\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:109](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L109) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L109) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/functions/sequencerModule.md b/src/pages/docs/reference/sequencer/functions/sequencerModule.md index b5cbee4..7ac1266 100644 --- a/src/pages/docs/reference/sequencer/functions/sequencerModule.md +++ b/src/pages/docs/reference/sequencer/functions/sequencerModule.md @@ -12,7 +12,7 @@ title: sequencerModule > **sequencerModule**(): (`target`) => `void` -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L33) +Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L33) Marks the decorated class as a sequencer module, while also making it injectable with our dependency injection solution. diff --git a/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md b/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md index 46bcd6c..c6499e4 100644 --- a/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md +++ b/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md @@ -10,7 +10,7 @@ title: AsyncMerkleTreeStore # Interface: AsyncMerkleTreeStore -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L10) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L10) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:10](http > **commit**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L13) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L13) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:13](http > **getNodesAsync**: (`nodes`) => `Promise`\<(`undefined` \| `bigint`)[]\> -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L17) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L17) #### Parameters @@ -48,7 +48,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:17](http > **openTransaction**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L11) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L11) #### Returns @@ -60,7 +60,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:11](http > **writeNodes**: (`nodes`) => `void` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L15) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L15) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md b/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md index 823edbf..0daacaf 100644 --- a/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md +++ b/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md @@ -10,7 +10,7 @@ title: AsyncStateService # Interface: AsyncStateService -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L13) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L13) This Interface should be implemented for services that store the state in an external storage (like a DB). This can be used in conjunction with @@ -22,7 +22,7 @@ CachedStateService to preload keys for In-Circuit usage. > **commit**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L16) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L16) #### Returns @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:16](https:/ > **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L22) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L22) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:22](https:/ > **getMany**: (`keys`) => `Promise`\<[`StateEntry`](StateEntry.md)[]\> -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L20) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L20) #### Parameters @@ -70,7 +70,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:20](https:/ > **openTransaction**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L14) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L14) #### Returns @@ -82,7 +82,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:14](https:/ > **writeStates**: (`entries`) => `void` -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L18) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L18) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md index 237b5f5..5f571b8 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md +++ b/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md @@ -10,7 +10,7 @@ title: BaseLayer # Interface: BaseLayer -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L16) +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L16) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -33,7 +33,7 @@ deps that are necessary for the sequencer to work. > **dependencies**: () => [`BaseLayerDependencyRecord`](BaseLayerDependencyRecord.md) -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L17) +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L17) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md index 6fd87eb..35ffe87 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md +++ b/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md @@ -10,7 +10,7 @@ title: BaseLayerContractPermissions # Interface: BaseLayerContractPermissions -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L3) +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L3) ## Methods @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPerm > **bridgeContractMina**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L6) +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L6) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPerm > **bridgeContractToken**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L9) +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L9) #### Returns @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPerm > **dispatchContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L5) +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L5) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPerm > **settlementContract**(): `Permissions` -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L4) +Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L4) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md index 07955b7..7f86217 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md +++ b/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md @@ -10,7 +10,7 @@ title: BaseLayerDependencyRecord # Interface: BaseLayerDependencyRecord -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L10) +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L10) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:10](https:// > **IncomingMessageAdapter**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`IncomingMessageAdapter`](IncomingMessageAdapter.md)\> -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L11) +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L11) *** @@ -34,4 +34,4 @@ Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:11](https:// > **OutgoingMessageQueue**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`OutgoingMessageQueue`](OutgoingMessageQueue.md)\> -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L13) +Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L13) diff --git a/src/pages/docs/reference/sequencer/interfaces/Batch.md b/src/pages/docs/reference/sequencer/interfaces/Batch.md index d9e3500..e989032 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Batch.md +++ b/src/pages/docs/reference/sequencer/interfaces/Batch.md @@ -10,7 +10,7 @@ title: Batch # Interface: Batch -Defined in: [packages/sequencer/src/storage/model/Batch.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L12) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L12) ## Extended by @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:12](https://github.co > **blockHashes**: `string`[] -Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L14) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L14) *** @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.co > **height**: `number` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L15) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L15) *** @@ -38,4 +38,4 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.co > **proof**: `JsonProof` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L13) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L13) diff --git a/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md b/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md index effbedf..7274178 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md @@ -10,7 +10,7 @@ title: BatchStorage # Interface: BatchStorage -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L3) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:3](http > **getCurrentBatchHeight**: () => `Promise`\<`number`\> -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L5) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L5) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:5](http > **getLatestBatch**: () => `Promise`\<`undefined` \| [`Batch`](Batch.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L6) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L6) #### Returns @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:6](http > **pushBatch**: (`block`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L7) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L7) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md b/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md index 6a218bf..cbd449f 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md +++ b/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md @@ -10,7 +10,7 @@ title: BatchTransaction # Interface: BatchTransaction -Defined in: [packages/sequencer/src/storage/model/Batch.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L6) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L6) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:6](https://github.com > **status**: `boolean` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L8) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L8) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:8](https://github.com > `optional` **statusMessage**: `string` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L9) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L9) *** @@ -34,4 +34,4 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:9](https://github.com > **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) -Defined in: [packages/sequencer/src/storage/model/Batch.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L7) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L7) diff --git a/src/pages/docs/reference/sequencer/interfaces/Block.md b/src/pages/docs/reference/sequencer/interfaces/Block.md index 0fedf7e..fd17788 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Block.md +++ b/src/pages/docs/reference/sequencer/interfaces/Block.md @@ -10,7 +10,7 @@ title: Block # Interface: Block -Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L22) +Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L22) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.co > **fromBlockHashRoot**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L33) +Defined in: [packages/sequencer/src/storage/model/Block.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L33) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:33](https://github.co > **fromEternalTransactionsHash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L32) +Defined in: [packages/sequencer/src/storage/model/Block.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L32) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:32](https://github.co > **fromMessagesHash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L34) +Defined in: [packages/sequencer/src/storage/model/Block.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L34) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:34](https://github.co > **hash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L23) +Defined in: [packages/sequencer/src/storage/model/Block.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L23) *** @@ -50,7 +50,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:23](https://github.co > **height**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L24) +Defined in: [packages/sequencer/src/storage/model/Block.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L24) *** @@ -58,7 +58,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:24](https://github.co > **networkState**: `object` -Defined in: [packages/sequencer/src/storage/model/Block.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L25) +Defined in: [packages/sequencer/src/storage/model/Block.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L25) #### before @@ -74,7 +74,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:25](https://github.co > **previousBlockHash**: `undefined` \| `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L36) +Defined in: [packages/sequencer/src/storage/model/Block.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L36) *** @@ -82,7 +82,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:36](https://github.co > **toEternalTransactionsHash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L31) +Defined in: [packages/sequencer/src/storage/model/Block.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L31) *** @@ -90,7 +90,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:31](https://github.co > **toMessagesHash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L35) +Defined in: [packages/sequencer/src/storage/model/Block.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L35) *** @@ -98,7 +98,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:35](https://github.co > **transactions**: [`TransactionExecutionResult`](TransactionExecutionResult.md)[] -Defined in: [packages/sequencer/src/storage/model/Block.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L29) +Defined in: [packages/sequencer/src/storage/model/Block.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L29) *** @@ -106,4 +106,4 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:29](https://github.co > **transactionsHash**: `Field` -Defined in: [packages/sequencer/src/storage/model/Block.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L30) +Defined in: [packages/sequencer/src/storage/model/Block.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L30) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md b/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md index fa179b7..47a588f 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md @@ -10,7 +10,7 @@ title: BlockConfig # Interface: BlockConfig -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L33) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L33) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducer > `optional` **allowEmptyBlock**: `boolean` -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L34) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L34) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducer > `optional` **maximumBlockSize**: `number` -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L35) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md b/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md index dd51a90..35ac65d 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md @@ -10,7 +10,7 @@ title: BlockProverParameters # Interface: BlockProverParameters -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L35) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **executionData**: [`BlockProverExecutionData`](../../protocol/classes/BlockProverExecutionData.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L37) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **publicInput**: [`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L36) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L36) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **startingState**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L38) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L38) *** @@ -42,4 +42,4 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProving > **verificationKeyAttestation**: [`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L39) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L39) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md b/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md index accdab8..b9b5c58 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md @@ -10,7 +10,7 @@ title: BlockQueue # Interface: BlockQueue -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L9) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L9) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:9](http > **getLatestBlockAndResult**: () => `Promise`\<`undefined` \| [`BlockWithMaybeResult`](BlockWithMaybeResult.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L13) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L13) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:13](htt > **getNewBlocks**: () => `Promise`\<[`BlockWithPreviousResult`](BlockWithPreviousResult.md)[]\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L12) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L12) #### Returns @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:12](htt > **pushBlock**: (`block`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L10) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L10) #### Parameters @@ -60,7 +60,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:10](htt > **pushResult**: (`result`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L11) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L11) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockResult.md index 8280c7b..0f37213 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockResult.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockResult.md @@ -10,7 +10,7 @@ title: BlockResult # Interface: BlockResult -Defined in: [packages/sequencer/src/storage/model/Block.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L50) +Defined in: [packages/sequencer/src/storage/model/Block.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L50) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:50](https://github.co > **afterNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L54) +Defined in: [packages/sequencer/src/storage/model/Block.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L54) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:54](https://github.co > **blockHash**: `bigint` -Defined in: [packages/sequencer/src/storage/model/Block.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L51) +Defined in: [packages/sequencer/src/storage/model/Block.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L51) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:51](https://github.co > **blockHashRoot**: `bigint` -Defined in: [packages/sequencer/src/storage/model/Block.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L53) +Defined in: [packages/sequencer/src/storage/model/Block.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L53) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:53](https://github.co > **blockHashWitness**: [`BlockHashMerkleTreeWitness`](../../protocol/classes/BlockHashMerkleTreeWitness.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:56](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L56) +Defined in: [packages/sequencer/src/storage/model/Block.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L56) *** @@ -50,7 +50,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:56](https://github.co > **blockStateTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] -Defined in: [packages/sequencer/src/storage/model/Block.ts:55](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L55) +Defined in: [packages/sequencer/src/storage/model/Block.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L55) *** @@ -58,4 +58,4 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:55](https://github.co > **stateRoot**: `bigint` -Defined in: [packages/sequencer/src/storage/model/Block.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L52) +Defined in: [packages/sequencer/src/storage/model/Block.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L52) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md b/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md index 16b51b4..840e68a 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md @@ -10,7 +10,7 @@ title: BlockStorage # Interface: BlockStorage -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L16) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L16) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:16](htt > **getCurrentBlockHeight**: () => `Promise`\<`number`\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L17) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L17) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:17](htt > **getLatestBlock**: () => `Promise`\<`undefined` \| [`BlockWithResult`](BlockWithResult.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L18) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L18) #### Returns @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:18](htt > **pushBlock**: (`block`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L19) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L19) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md b/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md index 1d27c0f..6451685 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md @@ -10,7 +10,7 @@ title: BlockTrace # Interface: BlockTrace -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L43) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L43) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:4 > **block**: [`NewBlockProverParameters`](NewBlockProverParameters.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L44) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L44) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:4 > **stateTransitionProver**: [`StateTransitionProofParameters`](StateTransitionProofParameters.md)[] -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:45](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L45) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L45) *** @@ -34,4 +34,4 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:4 > **transactions**: [`TransactionTrace`](TransactionTrace.md)[] -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:46](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L46) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L46) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md b/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md index 27632f8..1ef8b51 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md @@ -10,7 +10,7 @@ title: BlockTrigger # Interface: BlockTrigger -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L24) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L24) A BlockTrigger is the primary method to start the production of a block and all associated processes. diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md index 65111d7..e6b54f3 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md @@ -10,7 +10,7 @@ title: BlockWithMaybeResult # Interface: BlockWithMaybeResult -Defined in: [packages/sequencer/src/storage/model/Block.ts:64](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L64) +Defined in: [packages/sequencer/src/storage/model/Block.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L64) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:64](https://github.co > **block**: [`Block`](Block.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:65](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L65) +Defined in: [packages/sequencer/src/storage/model/Block.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L65) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:65](https://github.co > `optional` **result**: [`BlockResult`](BlockResult.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:66](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L66) +Defined in: [packages/sequencer/src/storage/model/Block.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L66) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md index cb0338d..b92848f 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md @@ -10,7 +10,7 @@ title: BlockWithPreviousResult # Interface: BlockWithPreviousResult -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L49) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L49) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:4 > **block**: [`BlockWithResult`](BlockWithResult.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:50](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L50) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L50) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:5 > `optional` **lastBlockResult**: [`BlockResult`](BlockResult.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L51) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L51) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md index 0f728a0..4e6c318 100644 --- a/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md +++ b/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md @@ -10,7 +10,7 @@ title: BlockWithResult # Interface: BlockWithResult -Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L59) +Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L59) ## Extended by @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.co > **block**: [`Block`](Block.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:60](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L60) +Defined in: [packages/sequencer/src/storage/model/Block.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L60) *** @@ -30,4 +30,4 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:60](https://github.co > **result**: [`BlockResult`](BlockResult.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L61) +Defined in: [packages/sequencer/src/storage/model/Block.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L61) diff --git a/src/pages/docs/reference/sequencer/interfaces/Closeable.md b/src/pages/docs/reference/sequencer/interfaces/Closeable.md index 9e96f15..c245565 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Closeable.md +++ b/src/pages/docs/reference/sequencer/interfaces/Closeable.md @@ -10,7 +10,7 @@ title: Closeable # Interface: Closeable -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/Closeable.ts#L3) +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/Closeable.ts#L3) ## Extended by @@ -23,7 +23,7 @@ Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:3](https://gi > **close**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/Database.md b/src/pages/docs/reference/sequencer/interfaces/Database.md index 7d3fb3c..a966282 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Database.md +++ b/src/pages/docs/reference/sequencer/interfaces/Database.md @@ -10,7 +10,7 @@ title: Database # Interface: Database -Defined in: [packages/sequencer/src/storage/Database.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/Database.ts#L5) +Defined in: [packages/sequencer/src/storage/Database.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/Database.ts#L5) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -33,7 +33,7 @@ deps that are necessary for the sequencer to work. > **close**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) #### Returns @@ -49,7 +49,7 @@ Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://gi > **dependencies**: () => [`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) #### Returns @@ -65,7 +65,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](http > **executeInTransaction**(`f`): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/Database.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/Database.ts#L13) +Defined in: [packages/sequencer/src/storage/Database.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/Database.ts#L13) #### Parameters @@ -83,7 +83,7 @@ Defined in: [packages/sequencer/src/storage/Database.ts:13](https://github.com/p > **pruneDatabase**(): `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/Database.ts#L11) +Defined in: [packages/sequencer/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/Database.ts#L11) Prunes all data from the database connection. Note: This function should only be called immediately at startup, diff --git a/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md b/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md index 2d3024b..cae4d47 100644 --- a/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md @@ -10,7 +10,7 @@ title: HistoricalBatchStorage # Interface: HistoricalBatchStorage -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:10](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L10) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L10) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:10](htt > **getBatchAt**: (`height`) => `Promise`\<`undefined` \| [`Batch`](Batch.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BatchStorage.ts#L11) +Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L11) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md b/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md index 3f9bde9..95c8fa8 100644 --- a/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md @@ -10,7 +10,7 @@ title: HistoricalBlockStorage # Interface: HistoricalBlockStorage -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L22) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L22) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:22](htt > **getBlock**: (`hash`) => `Promise`\<`undefined` \| [`Block`](Block.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L24) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L24) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:24](htt > **getBlockAt**: (`height`) => `Promise`\<`undefined` \| [`Block`](Block.md)\> -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/BlockStorage.ts#L23) +Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L23) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md b/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md index 5715aab..ff4d8a9 100644 --- a/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md +++ b/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md @@ -10,7 +10,7 @@ title: IncomingMessageAdapter # Interface: IncomingMessageAdapter -Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L11) +Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L11) An interface provided by the BaseLayer via DependencyFactory, which implements a function that allows us to retrieve @@ -23,7 +23,7 @@ unconsumed incoming messages from the BaseLayer > **getPendingMessages**: (`address`, `params`) => `Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](../classes/PendingTransaction.md)[]; `to`: `string`; \}\> -Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L12) +Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L12) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md b/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md index 17b20dd..b06b612 100644 --- a/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md +++ b/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md @@ -10,7 +10,7 @@ title: InstantiatedQueue # Interface: InstantiatedQueue -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L20) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L20) Object that abstracts a concrete connection to a queue instance. @@ -24,7 +24,7 @@ Object that abstracts a concrete connection to a queue instance. > **addTask**: (`payload`, `taskId`?) => `Promise`\<\{ `taskId`: `string`; \}\> -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L26) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L26) Adds a specific payload to the queue and returns a unique jobId @@ -48,7 +48,7 @@ Adds a specific payload to the queue and returns a unique jobId > **close**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) +Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) #### Returns @@ -64,7 +64,7 @@ Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://gi > **name**: `string` -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L21) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L21) *** @@ -72,7 +72,7 @@ Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:21](https://github > **offCompleted**: (`listenerId`) => `void` -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L38) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L38) #### Parameters @@ -90,7 +90,7 @@ Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:38](https://github > **onCompleted**: (`listener`) => `Promise`\<`number`\> -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L34) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L34) Registers a listener for the completion of jobs diff --git a/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md b/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md index 61308ed..ddb55a9 100644 --- a/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md +++ b/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md @@ -10,7 +10,7 @@ title: LocalTaskQueueConfig # Interface: LocalTaskQueueConfig -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L22) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L22) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:22](https://g > `optional` **simulatedDuration**: `number` -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L23) +Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L23) diff --git a/src/pages/docs/reference/sequencer/interfaces/Mempool.md b/src/pages/docs/reference/sequencer/interfaces/Mempool.md index 950898d..b7dba63 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Mempool.md +++ b/src/pages/docs/reference/sequencer/interfaces/Mempool.md @@ -10,7 +10,7 @@ title: Mempool # Interface: Mempool\ -Defined in: [packages/sequencer/src/mempool/Mempool.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/Mempool.ts#L9) +Defined in: [packages/sequencer/src/mempool/Mempool.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/Mempool.ts#L9) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/mempool/Mempool.ts:9](https://github.com/pro > **add**: (`tx`) => `Promise`\<`boolean`\> -Defined in: [packages/sequencer/src/mempool/Mempool.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/Mempool.ts#L15) +Defined in: [packages/sequencer/src/mempool/Mempool.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/Mempool.ts#L15) Add a transaction to the mempool @@ -60,7 +60,7 @@ Defined in: packages/common/dist/events/EventEmittingComponent.d.ts:4 > **getTxs**: (`limit`?) => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/mempool/Mempool.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/Mempool.ts#L20) +Defined in: [packages/sequencer/src/mempool/Mempool.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/Mempool.ts#L20) Retrieve all transactions that are currently in the mempool diff --git a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md index 398b834..c4beb51 100644 --- a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md +++ b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md @@ -10,7 +10,7 @@ title: MerkleTreeNode # Interface: MerkleTreeNode -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L6) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L6) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:6](https > **key**: `bigint` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https > **level**: `number` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) #### Inherited from @@ -46,4 +46,4 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https > **value**: `bigint` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L7) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L7) diff --git a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md index a4901f5..5628bd9 100644 --- a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md +++ b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md @@ -10,7 +10,7 @@ title: MerkleTreeNodeQuery # Interface: MerkleTreeNodeQuery -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L1) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L1) ## Extended by @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:1](https > **key**: `bigint` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) *** @@ -30,4 +30,4 @@ Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https > **level**: `number` -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) +Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) diff --git a/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md b/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md index 55b9a36..baffdd2 100644 --- a/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md @@ -10,7 +10,7 @@ title: MessageStorage # Interface: MessageStorage -Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/MessageStorage.ts#L6) +Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/MessageStorage.ts#L6) Interface to store Messages previously fetched by a IncomingMessageadapter @@ -20,7 +20,7 @@ Interface to store Messages previously fetched by a IncomingMessageadapter > **getMessages**: (`fromMessagesHash`) => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/MessageStorage.ts#L12) +Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/MessageStorage.ts#L12) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:12](h > **pushMessages**: (`fromMessagesHash`, `toMessagesHash`, `messages`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:7](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/MessageStorage.ts#L7) +Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/MessageStorage.ts#L7) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md b/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md index ea2d13c..f7fb3f8 100644 --- a/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md +++ b/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md @@ -10,7 +10,7 @@ title: MinaBaseLayerConfig # Interface: MinaBaseLayerConfig -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L16) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L16) ## Properties @@ -18,4 +18,4 @@ Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:16](http > **network**: \{ `type`: `"local"`; \} \| \{ `accountManager`: `string`; `archive`: `string`; `graphql`: `string`; `type`: `"lightnet"`; \} \| \{ `archive`: `string`; `graphql`: `string`; `type`: `"remote"`; \} -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L17) +Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L17) diff --git a/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md b/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md index 0659f26..eb14415 100644 --- a/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md +++ b/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md @@ -10,7 +10,7 @@ title: NetworkStateTransportModule # Interface: NetworkStateTransportModule -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L3) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts > **getProvenNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L6) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L6) #### Returns @@ -30,7 +30,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts > **getStagedNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L5) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L5) #### Returns @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts > **getUnprovenNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L4) +Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L4) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md b/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md index 665631d..f412b01 100644 --- a/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md +++ b/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md @@ -10,7 +10,7 @@ title: NewBlockProverParameters # Interface: NewBlockProverParameters -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L30) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L30) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:30 > **blockWitness**: [`BlockHashMerkleTreeWitness`](../../protocol/classes/BlockHashMerkleTreeWitness.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L33) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L33) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:33 > **networkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L32) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:32 > **publicInput**: [`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L31) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L31) *** @@ -42,4 +42,4 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:31 > **startingState**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:34](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L34) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L34) diff --git a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md index 498a419..1591331 100644 --- a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md +++ b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md @@ -10,7 +10,7 @@ title: OutgoingMessage # Interface: OutgoingMessage\ -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L13) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L13) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:13](h > **index**: `number` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L14) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L14) *** @@ -30,4 +30,4 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:14](h > **value**: `Type` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L15) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L15) diff --git a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md index 6e64631..1cc47e5 100644 --- a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md +++ b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md @@ -10,7 +10,7 @@ title: OutgoingMessageQueue # Interface: OutgoingMessageQueue -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L37) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L37) This interface allows the SettlementModule to retrieve information about pending L2-dispatched (outgoing) messages that it can then use to roll @@ -25,7 +25,7 @@ outgoing message type is not limited to Withdrawals > **length**: () => `number` -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L40) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L40) #### Returns @@ -37,7 +37,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:40](h > **peek**: (`num`) => [`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L38) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L38) #### Parameters @@ -55,7 +55,7 @@ Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:38](h > **pop**: (`num`) => [`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L39) +Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L39) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md b/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md index 2194cae..1713dfc 100644 --- a/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md +++ b/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md @@ -10,7 +10,7 @@ title: PairingDerivedInput # Interface: PairingDerivedInput\ -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L16) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L16) This type is used to consistently define the input type of a MapReduce flow that is depenend on the result a pairing. @@ -29,7 +29,7 @@ This type is used to consistently define the input type of a MapReduce flow > **input1**: `Input1` -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L17) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L17) *** @@ -37,7 +37,7 @@ Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.t > **input2**: `Input2` -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L18) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L18) *** @@ -45,4 +45,4 @@ Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.t > **params**: `AdditionalParameters` -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L19) +Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L19) diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md b/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md index fe73516..5f35a7a 100644 --- a/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md +++ b/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md @@ -10,7 +10,7 @@ title: QueryGetterState # Interface: QueryGetterState\ -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L24) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L24) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:24](htt > **get**: () => `Promise`\<`undefined` \| `Value`\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L25) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L25) #### Returns @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:25](htt > **merkleWitness**: () => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L27) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L27) #### Returns @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:27](htt > **path**: () => `string` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L26) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L26) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md b/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md index 1609ff4..f600f6d 100644 --- a/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md +++ b/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md @@ -10,7 +10,7 @@ title: QueryGetterStateMap # Interface: QueryGetterStateMap\ -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L30) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L30) ## Type Parameters @@ -24,7 +24,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:30](htt > **get**: (`key`) => `Promise`\<`undefined` \| `Value`\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L31) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L31) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:31](htt > **merkleWitness**: (`key`) => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L33) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L33) #### Parameters @@ -60,7 +60,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:33](htt > **path**: (`key`) => `string` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L32) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L32) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md b/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md index f78813e..72d5eb7 100644 --- a/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md +++ b/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md @@ -10,7 +10,7 @@ title: QueryTransportModule # Interface: QueryTransportModule -Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L4) +Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L4) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:4](htt > **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> -Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L5) +Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L5) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:5](htt > **merkleWitness**: (`key`) => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> -Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L6) +Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L6) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md b/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md index 9eaeecf..8cf017f 100644 --- a/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md +++ b/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md @@ -10,7 +10,7 @@ title: RuntimeProofParameters # Interface: RuntimeProofParameters -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L26) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L26) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > **networkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L28) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L28) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > **state**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L29) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L29) *** @@ -34,4 +34,4 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask > **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L27) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L27) diff --git a/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md b/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md index 55d12cb..a380a9a 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md +++ b/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md @@ -10,7 +10,7 @@ title: Sequenceable # Interface: Sequenceable -Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L1) +Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L1) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:1](https: > **start**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:2](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L2) +Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:2](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L2) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md b/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md index 0b1e18e..bf97107 100644 --- a/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md +++ b/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md @@ -10,7 +10,7 @@ title: SettleableBatch # Interface: SettleableBatch -Defined in: [packages/sequencer/src/storage/model/Batch.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L18) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L18) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:18](https://github.co > **blockHashes**: `string`[] -Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L14) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L14) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.co > **fromNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [packages/sequencer/src/storage/model/Batch.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L19) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L19) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:19](https://github.co > **height**: `number` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L15) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L15) #### Inherited from @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.co > **proof**: `JsonProof` -Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L13) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L13) #### Inherited from @@ -66,4 +66,4 @@ Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.co > **toNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) -Defined in: [packages/sequencer/src/storage/model/Batch.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Batch.ts#L20) +Defined in: [packages/sequencer/src/storage/model/Batch.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L20) diff --git a/src/pages/docs/reference/sequencer/interfaces/Settlement.md b/src/pages/docs/reference/sequencer/interfaces/Settlement.md index 702c411..2cf3737 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Settlement.md +++ b/src/pages/docs/reference/sequencer/interfaces/Settlement.md @@ -10,7 +10,7 @@ title: Settlement # Interface: Settlement -Defined in: [packages/sequencer/src/storage/model/Settlement.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Settlement.ts#L1) +Defined in: [packages/sequencer/src/storage/model/Settlement.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Settlement.ts#L1) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Settlement.ts:1](https://githu > **batches**: `number`[] -Defined in: [packages/sequencer/src/storage/model/Settlement.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Settlement.ts#L6) +Defined in: [packages/sequencer/src/storage/model/Settlement.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Settlement.ts#L6) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/storage/model/Settlement.ts:6](https://githu > **promisedMessagesHash**: `string` -Defined in: [packages/sequencer/src/storage/model/Settlement.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Settlement.ts#L5) +Defined in: [packages/sequencer/src/storage/model/Settlement.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Settlement.ts#L5) diff --git a/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md b/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md index ac80304..b451c62 100644 --- a/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md +++ b/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md @@ -10,7 +10,7 @@ title: SettlementModuleConfig # Interface: SettlementModuleConfig -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:52](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L52) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L52) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:52](https://g > `optional` **address**: `PublicKey` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L54) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L54) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:54](https://g > **feepayer**: `PrivateKey` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:53](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L53) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L53) diff --git a/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md b/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md index 8b47b45..db2dfa5 100644 --- a/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md @@ -10,7 +10,7 @@ title: SettlementStorage # Interface: SettlementStorage -Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L3) +Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:3] > **pushSettlement**: (`settlement`) => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L4) +Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L4) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/StateEntry.md b/src/pages/docs/reference/sequencer/interfaces/StateEntry.md index 9cff811..e992e4d 100644 --- a/src/pages/docs/reference/sequencer/interfaces/StateEntry.md +++ b/src/pages/docs/reference/sequencer/interfaces/StateEntry.md @@ -10,7 +10,7 @@ title: StateEntry # Interface: StateEntry -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L3) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:3](https:// > **key**: `Field` -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L4) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L4) *** @@ -26,4 +26,4 @@ Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:4](https:// > **value**: `undefined` \| `Field`[] -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/state/async/AsyncStateService.ts#L5) +Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L5) diff --git a/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md b/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md index 1d4bc04..d127f12 100644 --- a/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md +++ b/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md @@ -10,7 +10,7 @@ title: StateTransitionProofParameters # Interface: StateTransitionProofParameters -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L27) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L27) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:33](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L33) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L33) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > **publicInput**: [`StateTransitionProverPublicInput`](../../protocol/classes/StateTransitionProverPublicInput.md) -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L28) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L28) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTas > **stateTransitions**: `object`[] -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L29) +Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L29) #### transition diff --git a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md index f8625f0..e932628 100644 --- a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md +++ b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md @@ -10,7 +10,7 @@ title: StorageDependencyFactory # Interface: StorageDependencyFactory -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L30) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L30) This is an abstract class for creating DependencyFactories, a pattern to bundle multiple smaller services into one and register them into the @@ -37,7 +37,7 @@ deps that are necessary for the sequencer to work. > **dependencies**: () => [`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md index bfb8240..6956718 100644 --- a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md +++ b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md @@ -10,7 +10,7 @@ title: StorageDependencyMinimumDependencies # Interface: StorageDependencyMinimumDependencies -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L16) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L16) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:16](http > **asyncMerkleStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L18) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L18) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:18](http > **asyncStateService**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncStateService`](AsyncStateService.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L17) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L17) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:17](http > **batchStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BatchStorage`](BatchStorage.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L19) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L19) *** @@ -50,7 +50,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:19](http > **blockQueue**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BlockQueue`](BlockQueue.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L20) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L20) *** @@ -58,7 +58,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:20](http > **blockStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BlockStorage`](BlockStorage.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L21) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L21) *** @@ -66,7 +66,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:21](http > **blockTreeStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L24) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L24) *** @@ -74,7 +74,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:24](http > **messageStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`MessageStorage`](MessageStorage.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L25) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L25) *** @@ -82,7 +82,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:25](http > **settlementStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`SettlementStorage`](SettlementStorage.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L26) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L26) *** @@ -90,7 +90,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:26](http > **transactionStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`TransactionStorage`](TransactionStorage.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L27) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L27) *** @@ -98,7 +98,7 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:27](http > **unprovenMerkleStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L23) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L23) *** @@ -106,4 +106,4 @@ Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:23](http > **unprovenStateService**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncStateService`](AsyncStateService.md)\> -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/StorageDependencyFactory.ts#L22) +Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L22) diff --git a/src/pages/docs/reference/sequencer/interfaces/Task.md b/src/pages/docs/reference/sequencer/interfaces/Task.md index c0b55c3..1a805a4 100644 --- a/src/pages/docs/reference/sequencer/interfaces/Task.md +++ b/src/pages/docs/reference/sequencer/interfaces/Task.md @@ -10,7 +10,7 @@ title: Task # Interface: Task\ -Defined in: [packages/sequencer/src/worker/flow/Task.ts:1](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L1) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L1) ## Type Parameters @@ -24,7 +24,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:1](https://github.com/pr > **compute**: (`input`) => `Promise`\<`Result`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L6) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L6) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:6](https://github.com/pr > **inputSerializer**: () => [`TaskSerializer`](TaskSerializer.md)\<`Input`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L8) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L8) #### Returns @@ -54,7 +54,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:8](https://github.com/pr > **name**: `string` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:2](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L2) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:2](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L2) *** @@ -62,7 +62,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:2](https://github.com/pr > **prepare**: () => `Promise`\<`void`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L4) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L4) #### Returns @@ -74,7 +74,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:4](https://github.com/pr > **resultSerializer**: () => [`TaskSerializer`](TaskSerializer.md)\<`Result`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L9) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L9) #### Returns diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md b/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md index 59e5c16..9a2213a 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md +++ b/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md @@ -10,7 +10,7 @@ title: TaskPayload # Interface: TaskPayload -Defined in: [packages/sequencer/src/worker/flow/Task.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L17) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L17) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:17](https://github.com/p > **flowId**: `string` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L22) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L22) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:22](https://github.com/p > **name**: `string` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L19) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L19) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:19](https://github.com/p > **payload**: `string` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:20](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L20) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L20) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:20](https://github.com/p > `optional` **status**: `"error"` \| `"success"` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L18) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L18) *** @@ -50,4 +50,4 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:18](https://github.com/p > `optional` **taskId**: `string` -Defined in: [packages/sequencer/src/worker/flow/Task.ts:21](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L21) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L21) diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md b/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md index 70874bd..a834bd6 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md +++ b/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md @@ -10,7 +10,7 @@ title: TaskQueue # Interface: TaskQueue -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:8](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L8) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L8) Definition of a connection-object that can generate queues and workers for a specific connection type (e.g. BullMQ, In-memory) @@ -21,7 +21,7 @@ for a specific connection type (e.g. BullMQ, In-memory) > **createWorker**: (`name`, `executor`, `options`?) => [`Closeable`](Closeable.md) -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L11) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L11) #### Parameters @@ -49,7 +49,7 @@ Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:11](https://github > **getQueue**: (`name`) => `Promise`\<[`InstantiatedQueue`](InstantiatedQueue.md)\> -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:9](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/queue/TaskQueue.ts#L9) +Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L9) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md b/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md index 898144b..bcb4ec4 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md +++ b/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md @@ -10,7 +10,7 @@ title: TaskSerializer # Interface: TaskSerializer\ -Defined in: [packages/sequencer/src/worker/flow/Task.ts:12](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L12) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L12) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:12](https://github.com/p > **fromJSON**: (`json`) => `Type` \| `Promise`\<`Type`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L14) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L14) #### Parameters @@ -40,7 +40,7 @@ Defined in: [packages/sequencer/src/worker/flow/Task.ts:14](https://github.com/p > **toJSON**: (`input`) => `string` \| `Promise`\<`string`\> -Defined in: [packages/sequencer/src/worker/flow/Task.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/Task.ts#L13) +Defined in: [packages/sequencer/src/worker/flow/Task.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L13) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md index 908eb4a..afa54ef 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md +++ b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md @@ -10,7 +10,7 @@ title: TimedBlockTriggerConfig # Interface: TimedBlockTriggerConfig -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L16) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L16) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > **blockInterval**: `number` -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:26](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L26) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L26) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > `optional` **produceEmptyBlocks**: `boolean` -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:27](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L27) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L27) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > `optional` **settlementInterval**: `number` -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L25) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L25) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > `optional` **tick**: `number` -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L24) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L24) Interval for the tick event to be fired. The time x of any block trigger time is always guaranteed to be diff --git a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md index 076ea9a..892910e 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md +++ b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md @@ -10,7 +10,7 @@ title: TimedBlockTriggerEvent # Interface: TimedBlockTriggerEvent -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L30) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L30) ## Extends @@ -22,7 +22,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigge > **batch-produced**: \[[`Batch`](Batch.md)\] -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L31) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L31) #### Inherited from @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > **block-metadata-produced**: \[[`BlockWithResult`](BlockWithResult.md)\] -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L30) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L30) #### Inherited from @@ -46,7 +46,7 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > **block-produced**: \[[`Block`](Block.md)\] -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:29](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L29) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L29) #### Inherited from @@ -58,4 +58,4 @@ Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts: > **tick**: \[`number`\] -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L31) +Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L31) diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md b/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md index d18e9ae..fc1fb93 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md +++ b/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md @@ -10,7 +10,7 @@ title: TransactionExecutionResult # Interface: TransactionExecutionResult -Defined in: [packages/sequencer/src/storage/model/Block.ts:13](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L13) +Defined in: [packages/sequencer/src/storage/model/Block.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L13) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:13](https://github.co > **events**: `object`[] -Defined in: [packages/sequencer/src/storage/model/Block.ts:19](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L19) +Defined in: [packages/sequencer/src/storage/model/Block.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L19) #### data @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:19](https://github.co > **protocolTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] -Defined in: [packages/sequencer/src/storage/model/Block.ts:16](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L16) +Defined in: [packages/sequencer/src/storage/model/Block.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L16) *** @@ -42,7 +42,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:16](https://github.co > **stateTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] -Defined in: [packages/sequencer/src/storage/model/Block.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L15) +Defined in: [packages/sequencer/src/storage/model/Block.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L15) *** @@ -50,7 +50,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:15](https://github.co > **status**: `Bool` -Defined in: [packages/sequencer/src/storage/model/Block.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L17) +Defined in: [packages/sequencer/src/storage/model/Block.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L17) *** @@ -58,7 +58,7 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:17](https://github.co > `optional` **statusMessage**: `string` -Defined in: [packages/sequencer/src/storage/model/Block.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L18) +Defined in: [packages/sequencer/src/storage/model/Block.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L18) *** @@ -66,4 +66,4 @@ Defined in: [packages/sequencer/src/storage/model/Block.ts:18](https://github.co > **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) -Defined in: [packages/sequencer/src/storage/model/Block.ts:14](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L14) +Defined in: [packages/sequencer/src/storage/model/Block.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L14) diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md b/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md index a5c7171..801c203 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md +++ b/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md @@ -10,7 +10,7 @@ title: TransactionStorage # Interface: TransactionStorage -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L3) +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L3) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:3 > **findTransaction**: (`hash`) => `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../classes/PendingTransaction.md); \}\> -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L15) +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L15) Finds a transaction by its hash. It returns both pending transaction and already included transactions @@ -41,7 +41,7 @@ and batch number where applicable. > **getPendingUserTransactions**: () => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:6](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L6) +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L6) #### Returns @@ -53,7 +53,7 @@ Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:6 > **pushUserTransaction**: (`tx`) => `Promise`\<`boolean`\> -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:4](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L4) +Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L4) #### Parameters diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md b/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md index d79e7c3..cac492d 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md +++ b/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md @@ -10,7 +10,7 @@ title: TransactionTrace # Interface: TransactionTrace -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L37) ## Properties @@ -18,7 +18,7 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:3 > **blockProver**: [`BlockProverParameters`](BlockProverParameters.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L40) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L40) *** @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:4 > **runtimeProver**: [`RuntimeProofParameters`](RuntimeProofParameters.md) -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L38) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L38) *** @@ -34,4 +34,4 @@ Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:3 > **stateTransitionProver**: [`StateTransitionProofParameters`](StateTransitionProofParameters.md)[] -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:39](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L39) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L39) diff --git a/src/pages/docs/reference/sequencer/interfaces/TxEvents.md b/src/pages/docs/reference/sequencer/interfaces/TxEvents.md index 3c74cdf..81cbe34 100644 --- a/src/pages/docs/reference/sequencer/interfaces/TxEvents.md +++ b/src/pages/docs/reference/sequencer/interfaces/TxEvents.md @@ -10,7 +10,7 @@ title: TxEvents # Interface: TxEvents -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L22) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L22) ## Extends @@ -26,7 +26,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSende > **included**: \[\{ `hash`: `string`; \}\] -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:24](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L24) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L24) *** @@ -34,7 +34,7 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSende > **rejected**: \[`any`\] -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L25) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L25) *** @@ -42,4 +42,4 @@ Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSende > **sent**: \[\{ `hash`: `string`; \}\] -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L23) +Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L23) diff --git a/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md b/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md index b8c0fa9..fa266d1 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md +++ b/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md @@ -12,4 +12,4 @@ title: AllTaskWorkerModules > **AllTaskWorkerModules**: [`ReturnType`](../../protocol/type-aliases/ReturnType.md)\<*typeof* [`allTasks`](../classes/VanillaTaskWorkerModules.md#alltasks)\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:171](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L171) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:172](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L172) diff --git a/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md b/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md index 377cbb3..993b841 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md +++ b/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md @@ -12,7 +12,7 @@ title: BlockEvents > **BlockEvents**: `object` -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:28](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L28) +Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L28) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md b/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md index cfd4da4..02b8a46 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md +++ b/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md @@ -12,7 +12,7 @@ title: ChainStateTaskArgs > **ChainStateTaskArgs**: `object` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:44](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L44) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L44) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md b/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md index e58fa81..4fba72a 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md +++ b/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md @@ -12,7 +12,7 @@ title: DatabasePruneConfig > **DatabasePruneConfig**: `object` -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:11](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/DatabasePruneModule.ts#L11) +Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/DatabasePruneModule.ts#L11) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md b/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md index 4944932..fc00272 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md +++ b/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md @@ -12,4 +12,4 @@ title: JSONEncodableState > **JSONEncodableState**: `Record`\<`string`, `string`[]\> -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L32) diff --git a/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md b/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md index 836d4d8..c69c63d 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md +++ b/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md @@ -12,7 +12,7 @@ title: MapStateMapToQuery > **MapStateMapToQuery**\<`StateProperty`\>: `StateProperty` *extends* [`StateMap`](../../protocol/classes/StateMap.md)\ ? [`QueryGetterStateMap`](../interfaces/QueryGetterStateMap.md)\<`Key`, `Value`\> : `never` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:43](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L43) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L43) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md b/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md index 731bdf5..679ec3f 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md +++ b/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md @@ -12,7 +12,7 @@ title: MapStateToQuery > **MapStateToQuery**\<`StateProperty`\>: `StateProperty` *extends* [`State`](../../protocol/classes/State.md)\ ? [`QueryGetterState`](../interfaces/QueryGetterState.md)\<`Value`\> : `never` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:40](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L40) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L40) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md b/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md index 7474845..a060446 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md +++ b/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md @@ -12,7 +12,7 @@ title: MempoolEvents > **MempoolEvents**: `object` -Defined in: [packages/sequencer/src/mempool/Mempool.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/Mempool.ts#L5) +Defined in: [packages/sequencer/src/mempool/Mempool.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/Mempool.ts#L5) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md b/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md index b60404b..3905403 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md +++ b/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md @@ -12,7 +12,7 @@ title: ModuleQuery > **ModuleQuery**\<`Module`\>: `{ [Key in keyof PickStateMapProperties]: MapStateMapToQuery[Key]> }` & `{ [Key in keyof PickStateProperties]: MapStateToQuery[Key]> }` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:48](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L48) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L48) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md b/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md index 7520f87..6d6da7f 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md +++ b/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md @@ -12,4 +12,4 @@ title: NewBlockProvingParameters > **NewBlockProvingParameters**: [`PairingDerivedInput`](../interfaces/PairingDerivedInput.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md), `BlockProof`, [`NewBlockProverParameters`](../interfaces/NewBlockProverParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L37) diff --git a/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md b/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md index eea94b0..54f9999 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md +++ b/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md @@ -12,7 +12,7 @@ title: PairTuple > **PairTuple**\<`Type`\>: \[`Type`, `Type`\] -Defined in: [packages/sequencer/src/helpers/utils.ts:162](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/utils.ts#L162) +Defined in: [packages/sequencer/src/helpers/utils.ts:162](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L162) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickByType.md b/src/pages/docs/reference/sequencer/type-aliases/PickByType.md index 317a555..88cf4c4 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/PickByType.md +++ b/src/pages/docs/reference/sequencer/type-aliases/PickByType.md @@ -12,7 +12,7 @@ title: PickByType > **PickByType**\<`Type`, `Value`\>: \{ \[Key in keyof Type as Type\[Key\] extends Value \| undefined ? Key : never\]: Type\[Key\] \} -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:18](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L18) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L18) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md b/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md index f7ae1bb..b8cf264 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md +++ b/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md @@ -12,7 +12,7 @@ title: PickStateMapProperties > **PickStateMapProperties**\<`Type`\>: [`PickByType`](PickByType.md)\<`Type`, [`StateMap`](../../protocol/classes/StateMap.md)\<`any`, `any`\>\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:38](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L38) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L38) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md b/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md index e64d8db..f42d2ed 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md +++ b/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md @@ -12,7 +12,7 @@ title: PickStateProperties > **PickStateProperties**\<`Type`\>: [`PickByType`](PickByType.md)\<`Type`, [`State`](../../protocol/classes/State.md)\<`any`\>\> -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:36](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L36) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L36) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/Query.md b/src/pages/docs/reference/sequencer/type-aliases/Query.md index 9c5130b..5a2dbd8 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/Query.md +++ b/src/pages/docs/reference/sequencer/type-aliases/Query.md @@ -12,7 +12,7 @@ title: Query > **Query**\<`ModuleType`, `ModuleRecord`\>: `{ [Key in keyof ModuleRecord]: ModuleQuery> }` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L58) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L58) ## Type Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md b/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md index 65f73f7..bc2b5a4 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md +++ b/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md @@ -12,4 +12,4 @@ title: RuntimeContextReducedExecutionResult > **RuntimeContextReducedExecutionResult**: `Pick`\<[`RuntimeProvableMethodExecutionResult`](../../protocol/classes/RuntimeProvableMethodExecutionResult.md), `"stateTransitions"` \| `"status"` \| `"statusMessage"` \| `"stackTrace"` \| `"events"`\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:37](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L37) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L37) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md b/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md index b568afb..1511997 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md +++ b/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md @@ -12,4 +12,4 @@ title: SequencerModulesRecord > **SequencerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](TypedClass.md)\<[`SequencerModule`](../classes/SequencerModule.md)\<`unknown`\>\>\> -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:25](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/sequencer/executor/Sequencer.ts#L25) +Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L25) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md b/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md index c038d56..bd145a3 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md +++ b/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md @@ -12,4 +12,4 @@ title: SerializedArtifactRecord > **SerializedArtifactRecord**: `Record`\<`string`, \{ `verificationKey`: \{ `data`: `string`; `hash`: `string`; \}; \}\> -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:5](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L5) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L5) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md b/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md index a2fbed2..bfad475 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md +++ b/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md @@ -12,7 +12,7 @@ title: SettlementModuleEvents > **SettlementModuleEvents**: `object` -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:57](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/SettlementModule.ts#L57) +Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L57) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md b/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md index 3ce8cc1..e62b2c5 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md +++ b/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md @@ -12,7 +12,7 @@ title: SomeRuntimeMethod > **SomeRuntimeMethod**: (...`args`) => `Promise`\<`unknown`\> -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L35) ## Parameters diff --git a/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md b/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md index 8716315..d6f1387 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md +++ b/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md @@ -12,4 +12,4 @@ title: StateRecord > **StateRecord**: `Record`\<`string`, `Field`[] \| `undefined`\> -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:35](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L35) +Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L35) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md b/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md index 016d43b..07c9400 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md @@ -12,4 +12,4 @@ title: TaskStateRecord > **TaskStateRecord**: `Record`\<`string`, `Field`[]\> -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:32](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L32) +Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L32) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md index f0af0eb..fac3d94 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md @@ -12,4 +12,4 @@ title: TaskWorkerModulesRecord > **TaskWorkerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](TypedClass.md)\<[`TaskWorkerModule`](../classes/TaskWorkerModule.md) & [`Task`](../interfaces/Task.md)\<`any`, `any`\>\>\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:41](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L41) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L41) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md index 902ad29..99ae1f6 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md @@ -12,4 +12,4 @@ title: TaskWorkerModulesWithoutSettlement > **TaskWorkerModulesWithoutSettlement**: [`ReturnType`](../../protocol/type-aliases/ReturnType.md)\<*typeof* [`withoutSettlement`](../classes/VanillaTaskWorkerModules.md#withoutsettlement)\> -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:168](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L168) +Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:169](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L169) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md index 2ffb43d..50580fc 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md @@ -12,4 +12,4 @@ title: TransactionProvingTaskParameters > **TransactionProvingTaskParameters**: [`PairingDerivedInput`](../interfaces/PairingDerivedInput.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md), `RuntimeProof`, [`BlockProverParameters`](../interfaces/BlockProverParameters.md)\> -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:42](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L42) +Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L42) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md index a09157b..fc22d80 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md @@ -12,7 +12,7 @@ title: TransactionTaskArgs > **TransactionTaskArgs**: `object` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:49](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L49) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L49) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md index 261d20a..86adce1 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md +++ b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md @@ -12,7 +12,7 @@ title: TransactionTaskResult > **TransactionTaskResult**: `object` -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:54](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L54) +Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L54) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md b/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md index b2f9ffb..3bd4dae 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md +++ b/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md @@ -12,7 +12,7 @@ title: UnsignedTransactionBody > **UnsignedTransactionBody**: `object` -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:17](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/mempool/PendingTransaction.ts#L17) +Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L17) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md b/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md index 84c8b5c..ab15181 100644 --- a/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md +++ b/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md @@ -12,7 +12,7 @@ title: VerificationKeyJSON > **VerificationKeyJSON**: `object` -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L3) +Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L3) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/variables/Block.md b/src/pages/docs/reference/sequencer/variables/Block.md index baa3883..485e4b8 100644 --- a/src/pages/docs/reference/sequencer/variables/Block.md +++ b/src/pages/docs/reference/sequencer/variables/Block.md @@ -12,7 +12,7 @@ title: Block > **Block**: `object` -Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L22) +Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L22) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/variables/BlockWithResult.md b/src/pages/docs/reference/sequencer/variables/BlockWithResult.md index 6ed008a..398ce6d 100644 --- a/src/pages/docs/reference/sequencer/variables/BlockWithResult.md +++ b/src/pages/docs/reference/sequencer/variables/BlockWithResult.md @@ -12,7 +12,7 @@ title: BlockWithResult > **BlockWithResult**: `object` -Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/storage/model/Block.ts#L59) +Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L59) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md b/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md index e0dac7b..062147b 100644 --- a/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md +++ b/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md @@ -12,7 +12,7 @@ title: JSONTaskSerializer > `const` **JSONTaskSerializer**: `object` -Defined in: [packages/sequencer/src/worker/flow/JSONTaskSerializer.ts:3](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/worker/flow/JSONTaskSerializer.ts#L3) +Defined in: [packages/sequencer/src/worker/flow/JSONTaskSerializer.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/JSONTaskSerializer.ts#L3) ## Type declaration diff --git a/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md b/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md index f509fee..de92d95 100644 --- a/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md +++ b/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md @@ -12,7 +12,7 @@ title: QueryBuilderFactory > `const` **QueryBuilderFactory**: `object` -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:71](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L71) +Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L71) ## Type declaration diff --git a/src/pages/docs/reference/stack/classes/TestBalances.md b/src/pages/docs/reference/stack/classes/TestBalances.md index c986aee..8cbca3b 100644 --- a/src/pages/docs/reference/stack/classes/TestBalances.md +++ b/src/pages/docs/reference/stack/classes/TestBalances.md @@ -10,7 +10,7 @@ title: TestBalances # Class: TestBalances -Defined in: [stack/src/scripts/graphql/server.ts:51](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/stack/src/scripts/graphql/server.ts#L51) +Defined in: [stack/src/scripts/graphql/server.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/stack/src/scripts/graphql/server.ts#L52) Base class for runtime modules providing the necessary utilities. @@ -133,7 +133,7 @@ Holds all method names that are callable throw transactions > **totalSupply**: [`State`](../../protocol/classes/State.md)\<[`UInt64`](../../library/classes/UInt64.md)\> -Defined in: [stack/src/scripts/graphql/server.ts:58](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/stack/src/scripts/graphql/server.ts#L58) +Defined in: [stack/src/scripts/graphql/server.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/stack/src/scripts/graphql/server.ts#L59) We use `satisfies` here in order to be able to access presets by key in a type safe way. @@ -226,7 +226,7 @@ Defined in: module/dist/runtime/RuntimeModule.d.ts:33 > **addBalance**(`tokenId`, `address`, `balance`): `Promise`\<`void`\> -Defined in: [stack/src/scripts/graphql/server.ts:69](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/stack/src/scripts/graphql/server.ts#L69) +Defined in: [stack/src/scripts/graphql/server.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/stack/src/scripts/graphql/server.ts#L70) #### Parameters @@ -330,7 +330,7 @@ Defined in: library/dist/runtime/Balances.d.ts:85 > **getBalanceForUser**(`tokenId`, `address`): `Promise`\<[`Balance`](../../library/classes/Balance.md)\> -Defined in: [stack/src/scripts/graphql/server.ts:61](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/stack/src/scripts/graphql/server.ts#L61) +Defined in: [stack/src/scripts/graphql/server.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/stack/src/scripts/graphql/server.ts#L62) #### Parameters diff --git a/src/pages/docs/reference/stack/functions/startServer.md b/src/pages/docs/reference/stack/functions/startServer.md index a7e4c5c..e7e56d8 100644 --- a/src/pages/docs/reference/stack/functions/startServer.md +++ b/src/pages/docs/reference/stack/functions/startServer.md @@ -10,10 +10,10 @@ title: startServer # Function: startServer() -> **startServer**(): `Promise`\<[`AppChain`](../../sdk/classes/AppChain.md)\<`object` & `object`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `Graphql`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md)\<\{ `BatchStorageResolver`: *typeof* [`BatchStorageResolver`](../../api/classes/BatchStorageResolver.md); `BlockResolver`: *typeof* [`BlockResolver`](../../api/classes/BlockResolver.md); `MempoolResolver`: *typeof* [`MempoolResolver`](../../api/classes/MempoolResolver.md); `MerkleWitnessResolver`: *typeof* [`MerkleWitnessResolver`](../../api/classes/MerkleWitnessResolver.md); `NodeStatusResolver`: *typeof* [`NodeStatusResolver`](../../api/classes/NodeStatusResolver.md); `QueryGraphqlModule`: *typeof* [`QueryGraphqlModule`](../../api/classes/QueryGraphqlModule.md); \}\>\>; `GraphqlServer`: *typeof* [`GraphqlServer`](../../api/classes/GraphqlServer.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](../../sdk/classes/BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](../../sdk/classes/StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](../../sdk/classes/InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](../../sdk/classes/InMemoryTransactionSender.md); \}\>\> +> **startServer**(): `Promise`\<[`AppChain`](../../sdk/classes/AppChain.md)\<`object` & `object`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `Graphql`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md)\<\{ `BatchStorageResolver`: *typeof* [`BatchStorageResolver`](../../api/classes/BatchStorageResolver.md); `BlockResolver`: *typeof* [`BlockResolver`](../../api/classes/BlockResolver.md); `MempoolResolver`: *typeof* [`MempoolResolver`](../../api/classes/MempoolResolver.md); `MerkleWitnessResolver`: *typeof* [`MerkleWitnessResolver`](../../api/classes/MerkleWitnessResolver.md); `NodeStatusResolver`: *typeof* [`NodeStatusResolver`](../../api/classes/NodeStatusResolver.md); `QueryGraphqlModule`: *typeof* [`QueryGraphqlModule`](../../api/classes/QueryGraphqlModule.md); \}\>\>; `GraphqlServer`: *typeof* [`GraphqlServer`](../../api/classes/GraphqlServer.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `SequencerStartupModule`: *typeof* [`SequencerStartupModule`](../../sequencer/classes/SequencerStartupModule.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](../../sdk/classes/BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](../../sdk/classes/StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](../../sdk/classes/InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](../../sdk/classes/InMemoryTransactionSender.md); \}\>\> -Defined in: [stack/src/scripts/graphql/server.ts:87](https://github.com/proto-kit/framework/blob/b953c754e500c62f01fbbd6d09adfb2f5577269d/packages/stack/src/scripts/graphql/server.ts#L87) +Defined in: [stack/src/scripts/graphql/server.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/stack/src/scripts/graphql/server.ts#L88) ## Returns -`Promise`\<[`AppChain`](../../sdk/classes/AppChain.md)\<`object` & `object`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `Graphql`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md)\<\{ `BatchStorageResolver`: *typeof* [`BatchStorageResolver`](../../api/classes/BatchStorageResolver.md); `BlockResolver`: *typeof* [`BlockResolver`](../../api/classes/BlockResolver.md); `MempoolResolver`: *typeof* [`MempoolResolver`](../../api/classes/MempoolResolver.md); `MerkleWitnessResolver`: *typeof* [`MerkleWitnessResolver`](../../api/classes/MerkleWitnessResolver.md); `NodeStatusResolver`: *typeof* [`NodeStatusResolver`](../../api/classes/NodeStatusResolver.md); `QueryGraphqlModule`: *typeof* [`QueryGraphqlModule`](../../api/classes/QueryGraphqlModule.md); \}\>\>; `GraphqlServer`: *typeof* [`GraphqlServer`](../../api/classes/GraphqlServer.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](../../sdk/classes/BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](../../sdk/classes/StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](../../sdk/classes/InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](../../sdk/classes/InMemoryTransactionSender.md); \}\>\> +`Promise`\<[`AppChain`](../../sdk/classes/AppChain.md)\<`object` & `object`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `Graphql`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md)\<\{ `BatchStorageResolver`: *typeof* [`BatchStorageResolver`](../../api/classes/BatchStorageResolver.md); `BlockResolver`: *typeof* [`BlockResolver`](../../api/classes/BlockResolver.md); `MempoolResolver`: *typeof* [`MempoolResolver`](../../api/classes/MempoolResolver.md); `MerkleWitnessResolver`: *typeof* [`MerkleWitnessResolver`](../../api/classes/MerkleWitnessResolver.md); `NodeStatusResolver`: *typeof* [`NodeStatusResolver`](../../api/classes/NodeStatusResolver.md); `QueryGraphqlModule`: *typeof* [`QueryGraphqlModule`](../../api/classes/QueryGraphqlModule.md); \}\>\>; `GraphqlServer`: *typeof* [`GraphqlServer`](../../api/classes/GraphqlServer.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `SequencerStartupModule`: *typeof* [`SequencerStartupModule`](../../sequencer/classes/SequencerStartupModule.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](../../sdk/classes/BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](../../sdk/classes/StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](../../sdk/classes/InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](../../sdk/classes/InMemoryTransactionSender.md); \}\>\> From 0c0fddeb90182ddb4aa0a304a020190823832327 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 11:21:47 +0100 Subject: [PATCH 19/37] remove typedoc files from version control --- src/pages/docs/reference/_meta.tsx | 3 - src/pages/docs/reference/api/README.md | 51 - src/pages/docs/reference/api/_meta.tsx | 3 - .../api/classes/AdvancedNodeStatusResolver.md | 124 -- .../api/classes/BatchStorageResolver.md | 134 -- .../docs/reference/api/classes/BlockModel.md | 71 - .../reference/api/classes/BlockResolver.md | 134 -- .../api/classes/ComputedBlockModel.md | 73 - .../reference/api/classes/GraphqlModule.md | 121 -- .../api/classes/GraphqlSequencerModule.md | 662 ------- .../reference/api/classes/GraphqlServer.md | 251 --- .../reference/api/classes/MempoolResolver.md | 164 -- .../reference/api/classes/MerkleWitnessDTO.md | 69 - .../api/classes/MerkleWitnessResolver.md | 130 -- .../api/classes/NodeInformationObject.md | 69 - .../reference/api/classes/NodeStatusObject.md | 73 - .../api/classes/NodeStatusResolver.md | 124 -- .../api/classes/NodeStatusService.md | 63 - .../api/classes/ProcessInformationObject.md | 105 - .../api/classes/QueryGraphqlModule.md | 276 --- .../classes/ResolverFactoryGraphqlModule.md | 127 -- .../classes/SchemaGeneratingGraphqlModule.md | 126 -- .../docs/reference/api/classes/Signature.md | 51 - .../api/classes/TransactionObject.md | 141 -- .../api/classes/VanillaGraphqlModules.md | 81 - .../reference/api/functions/graphqlModule.md | 32 - .../api/interfaces/GraphqlModulesDefintion.md | 33 - .../api/interfaces/NodeInformation.md | 29 - .../api/interfaces/ProcessInformation.md | 69 - .../api/type-aliases/GraphqlModulesRecord.md | 15 - .../VanillaGraphqlModulesRecord.md | 41 - src/pages/docs/reference/common/README.md | 136 -- src/pages/docs/reference/common/_meta.tsx | 3 - .../common/classes/AtomicCompileHelper.md | 53 - .../classes/ChildVerificationKeyService.md | 67 - .../common/classes/CompileRegistry.md | 124 -- .../common/classes/ConfigurableModule.md | 114 -- .../reference/common/classes/EventEmitter.md | 161 -- .../common/classes/EventEmitterProxy.md | 196 -- .../classes/InMemoryMerkleTreeStorage.md | 100 - .../classes/MockAsyncMerkleTreeStore.md | 103 - .../common/classes/ModuleContainer.md | 520 ----- .../classes/ProvableMethodExecutionContext.md | 187 -- .../classes/ProvableMethodExecutionResult.md | 79 - .../classes/ReplayingSingleUseEventEmitter.md | 203 -- .../common/classes/RollupMerkleTree.md | 291 --- .../common/classes/RollupMerkleTreeWitness.md | 575 ------ .../common/classes/ZkProgrammable.md | 93 - .../functions/assertValidTextLogLevel.md | 25 - .../common/functions/compileToMockable.md | 33 - .../common/functions/createMerkleTree.md | 43 - .../reference/common/functions/dummyValue.md | 35 - .../common/functions/expectDefined.md | 29 - .../common/functions/filterNonNull.md | 29 - .../common/functions/filterNonUndefined.md | 29 - .../common/functions/getInjectAliases.md | 25 - .../common/functions/hashWithPrefix.md | 29 - .../reference/common/functions/implement.md | 48 - .../reference/common/functions/injectAlias.md | 40 - .../common/functions/injectOptional.md | 60 - .../common/functions/isSubtypeOfName.md | 32 - .../common/functions/mapSequential.md | 35 - .../docs/reference/common/functions/noop.md | 19 - .../common/functions/prefixToField.md | 25 - .../common/functions/provableMethod.md | 55 - .../docs/reference/common/functions/range.md | 29 - .../common/functions/reduceSequential.md | 39 - .../reference/common/functions/requireTrue.md | 29 - .../common/functions/safeParseJson.md | 29 - .../docs/reference/common/functions/sleep.md | 25 - .../reference/common/functions/splitArray.md | 38 - .../reference/common/functions/toProver.md | 47 - .../common/functions/verifyToMockable.md | 45 - .../common/interfaces/AbstractMerkleTree.md | 177 -- .../interfaces/AbstractMerkleTreeClass.md | 79 - .../interfaces/AbstractMerkleWitness.md | 155 -- .../common/interfaces/AreProofsEnabled.md | 39 - .../interfaces/BaseModuleInstanceType.md | 51 - .../interfaces/ChildContainerCreatable.md | 35 - .../interfaces/ChildContainerProvider.md | 21 - .../common/interfaces/CompilableModule.md | 36 - .../reference/common/interfaces/Compile.md | 21 - .../common/interfaces/CompileArtifact.md | 29 - .../common/interfaces/Configurable.md | 29 - .../common/interfaces/DependencyFactory.md | 41 - .../interfaces/EventEmittingComponent.md | 29 - .../interfaces/EventEmittingContainer.md | 25 - .../common/interfaces/MerkleTreeStore.md | 61 - .../interfaces/ModuleContainerDefinition.md | 37 - .../common/interfaces/ModulesRecord.md | 21 - .../common/interfaces/PlainZkProgram.md | 237 --- .../interfaces/StaticConfigurableModule.md | 25 - .../common/interfaces/ToFieldable.md | 25 - .../common/interfaces/ToFieldableStatic.md | 31 - .../common/interfaces/ToJSONableStatic.md | 31 - .../reference/common/interfaces/Verify.md | 33 - .../common/interfaces/WithZkProgrammable.md | 33 - .../common/type-aliases/ArgumentTypes.md | 15 - .../common/type-aliases/ArrayElement.md | 21 - .../common/type-aliases/ArtifactRecord.md | 15 - .../common/type-aliases/BaseModuleType.md | 15 - .../common/type-aliases/CapitalizeAny.md | 19 - .../common/type-aliases/CastToEventsRecord.md | 19 - .../common/type-aliases/CompileTarget.md | 29 - .../common/type-aliases/ContainerEvents.md | 19 - .../common/type-aliases/DecoratedMethod.md | 25 - .../type-aliases/DependenciesFromModules.md | 19 - .../type-aliases/DependencyDeclaration.md | 19 - .../common/type-aliases/DependencyRecord.md | 15 - .../common/type-aliases/EventListenable.md | 19 - .../common/type-aliases/EventsRecord.md | 15 - .../common/type-aliases/FilterNeverValues.md | 19 - .../common/type-aliases/FlattenObject.md | 19 - .../type-aliases/FlattenedContainerEvents.md | 19 - .../common/type-aliases/InferDependencies.md | 19 - .../common/type-aliases/InferProofBase.md | 19 - .../MapDependencyRecordToTypes.md | 19 - .../common/type-aliases/MergeObjects.md | 19 - .../common/type-aliases/ModuleEvents.md | 19 - .../common/type-aliases/ModulesConfig.md | 19 - .../reference/common/type-aliases/NoConfig.md | 15 - .../common/type-aliases/NonMethods.md | 19 - .../common/type-aliases/O1JSPrimitive.md | 15 - .../reference/common/type-aliases/OmitKeys.md | 21 - .../type-aliases/OverwriteObjectType.md | 21 - .../reference/common/type-aliases/Preset.md | 19 - .../reference/common/type-aliases/Presets.md | 19 - .../common/type-aliases/ProofTypes.md | 15 - .../common/type-aliases/RecursivePartial.md | 26 - .../common/type-aliases/ResolvableModules.md | 19 - .../common/type-aliases/StringKeyOf.md | 22 - .../TypeFromDependencyDeclaration.md | 19 - .../common/type-aliases/TypedClass.md | 29 - .../common/type-aliases/UnTypedClass.md | 25 - .../type-aliases/UnionToIntersection.md | 21 - .../common/variables/EMPTY_PUBLICKEY.md | 15 - .../common/variables/EMPTY_PUBLICKEY_X.md | 15 - .../reference/common/variables/MAX_FIELD.md | 15 - .../reference/common/variables/MOCK_PROOF.md | 15 - .../common/variables/MOCK_VERIFICATION_KEY.md | 15 - .../common/variables/ModuleContainerErrors.md | 121 -- .../variables/injectAliasMetadataKey.md | 15 - .../docs/reference/common/variables/log.md | 355 ---- src/pages/docs/reference/deployment/README.md | 48 - src/pages/docs/reference/deployment/_meta.tsx | 3 - .../reference/deployment/classes/BullQueue.md | 266 --- .../deployment/classes/Environment.md | 105 - .../docs/reference/deployment/globals.md | 25 - .../deployment/interfaces/BullQueueConfig.md | 49 - .../deployment/interfaces/Startable.md | 25 - .../type-aliases/StartableEnvironment.md | 19 - src/pages/docs/reference/indexer/README.md | 34 - src/pages/docs/reference/indexer/_meta.tsx | 3 - .../GeneratedResolverFactoryGraphqlModule.md | 148 -- .../indexer/classes/IndexBlockTask.md | 218 --- .../IndexBlockTaskParametersSerializer.md | 99 - .../docs/reference/indexer/classes/Indexer.md | 632 ------ .../indexer/classes/IndexerModule.md | 120 -- .../indexer/classes/IndexerNotifier.md | 191 -- .../indexer/functions/ValidateTakeArg.md | 19 - .../indexer/functions/cleanResolvers.md | 25 - .../interfaces/IndexBlockTaskParameters.md | 41 - .../type-aliases/IndexerModulesRecord.md | 15 - .../NotifierMandatorySequencerModules.md | 21 - src/pages/docs/reference/library/README.md | 60 - src/pages/docs/reference/library/_meta.tsx | 3 - .../docs/reference/library/classes/Balance.md | 1125 ----------- .../reference/library/classes/Balances.md | 424 ---- .../reference/library/classes/BalancesKey.md | 451 ----- .../docs/reference/library/classes/FeeTree.md | 291 --- .../classes/InMemorySequencerModules.md | 45 - .../library/classes/MethodFeeConfigData.md | 597 ------ .../classes/RuntimeFeeAnalyzerService.md | 216 -- .../library/classes/SimpleSequencerModules.md | 157 -- .../docs/reference/library/classes/TokenId.md | 1605 --------------- .../library/classes/TransactionFeeHook.md | 289 --- .../docs/reference/library/classes/UInt.md | 924 --------- .../docs/reference/library/classes/UInt112.md | 1117 ----------- .../docs/reference/library/classes/UInt224.md | 1105 ----------- .../docs/reference/library/classes/UInt32.md | 1117 ----------- .../docs/reference/library/classes/UInt64.md | 1109 ----------- .../library/classes/VanillaProtocolModules.md | 155 -- .../library/classes/VanillaRuntimeModules.md | 61 - .../library/classes/WithdrawalEvent.md | 489 ----- .../library/classes/WithdrawalKey.md | 421 ---- .../reference/library/classes/Withdrawals.md | 302 --- .../library/interfaces/BalancesEvents.md | 29 - .../library/interfaces/FeeIndexes.md | 17 - .../library/interfaces/FeeTreeValues.md | 17 - .../library/interfaces/MethodFeeConfig.md | 45 - .../RuntimeFeeAnalyzerServiceConfig.md | 61 - .../interfaces/TransactionFeeHookConfig.md | 81 - .../AdditionalSequencerModules.md | 15 - .../InMemorySequencerModulesRecord.md | 49 - .../library/type-aliases/MinimalBalances.md | 47 - .../MinimumAdditionalSequencerModules.md | 33 - .../SimpleSequencerModulesRecord.md | 15 - .../SimpleSequencerWorkerModulesRecord.md | 25 - .../library/type-aliases/UIntConstructor.md | 99 - .../VanillaProtocolModulesRecord.md | 21 - .../VanillaRuntimeModulesRecord.md | 21 - .../reference/library/variables/errors.md | 33 - .../library/variables/treeFeeHeight.md | 15 - src/pages/docs/reference/module/README.md | 124 -- src/pages/docs/reference/module/_meta.tsx | 3 - .../module/classes/InMemoryStateService.md | 93 - .../module/classes/MethodIdFactory.md | 62 - .../module/classes/MethodIdResolver.md | 90 - .../module/classes/MethodParameterEncoder.md | 134 -- .../docs/reference/module/classes/Runtime.md | 782 -------- .../reference/module/classes/RuntimeEvents.md | 91 - .../reference/module/classes/RuntimeModule.md | 209 -- .../module/classes/RuntimeZkProgrammable.md | 125 -- .../module/functions/combineMethodName.md | 29 - .../module/functions/getAllPropertyNames.md | 25 - .../module/functions/isRuntimeMethod.md | 38 - .../module/functions/runtimeMessage.md | 37 - .../module/functions/runtimeMethod.md | 37 - .../module/functions/runtimeModule.md | 35 - .../docs/reference/module/functions/state.md | 40 - .../module/functions/toEventsHash.md | 25 - .../functions/toStateTransitionsHash.md | 25 - .../module/functions/toWrappedMethod.md | 39 - src/pages/docs/reference/module/globals.md | 55 - .../module/interfaces/RuntimeDefinition.md | 35 - .../module/interfaces/RuntimeEnvironment.md | 85 - .../module/type-aliases/AsyncWrappedMethod.md | 25 - .../RuntimeMethodInvocationType.md | 15 - .../type-aliases/RuntimeModulesRecord.md | 20 - .../module/type-aliases/WrappedMethod.md | 25 - .../variables/runtimeMethodMetadataKey.md | 15 - .../runtimeMethodNamesMetadataKey.md | 15 - .../variables/runtimeMethodTypeMetadataKey.md | 15 - .../docs/reference/persistance/README.md | 45 - .../docs/reference/persistance/_meta.tsx | 3 - .../persistance/classes/BatchMapper.md | 71 - .../persistance/classes/BlockMapper.md | 165 -- .../persistance/classes/BlockResultMapper.md | 125 -- .../persistance/classes/FieldMapper.md | 71 - .../persistance/classes/PrismaBatchStore.md | 116 -- .../persistance/classes/PrismaBlockStorage.md | 205 -- .../classes/PrismaDatabaseConnection.md | 227 --- .../classes/PrismaMessageStorage.md | 93 - .../classes/PrismaRedisDatabase.md | 298 --- .../classes/PrismaSettlementStorage.md | 61 - .../persistance/classes/PrismaStateService.md | 143 -- .../classes/PrismaTransactionStorage.md | 104 - .../classes/RedisConnectionModule.md | 269 --- .../classes/RedisMerkleTreeStore.md | 115 -- .../persistance/classes/SettlementMapper.md | 71 - .../classes/StateTransitionArrayMapper.md | 79 - .../classes/StateTransitionMapper.md | 71 - .../TransactionExecutionResultMapper.md | 87 - .../persistance/classes/TransactionMapper.md | 141 -- .../interfaces/PrismaConnection.md | 27 - .../interfaces/PrismaDatabaseConfig.md | 21 - .../interfaces/PrismaRedisCombinedConfig.md | 29 - .../persistance/interfaces/RedisConnection.md | 41 - .../interfaces/RedisConnectionConfig.md | 45 - .../type-aliases/RedisTransaction.md | 15 - src/pages/docs/reference/processor/README.md | 42 - src/pages/docs/reference/processor/_meta.tsx | 3 - .../processor/classes/BlockFetching.md | 178 -- .../reference/processor/classes/Database.md | 216 -- .../processor/classes/DatabasePruneModule.md | 128 -- .../processor/classes/HandlersExecutor.md | 236 --- .../reference/processor/classes/Processor.md | 618 ------ .../processor/classes/ProcessorModule.md | 128 -- .../classes/ResolverFactoryGraphqlModule.md | 170 -- .../classes/TimedProcessorTrigger.md | 192 -- .../processor/functions/ValidateTakeArg.md | 19 - .../processor/functions/cleanResolvers.md | 25 - .../interfaces/BlockFetchingConfig.md | 21 - .../processor/interfaces/BlockResponse.md | 111 -- .../interfaces/DatabasePruneModuleConfig.md | 21 - .../interfaces/HandlersExecutorConfig.md | 29 - .../processor/interfaces/HandlersRecord.md | 25 - .../interfaces/TimedProcessorTriggerConfig.md | 21 - .../processor/type-aliases/BlockHandler.md | 33 - .../type-aliases/ClientTransaction.md | 19 - .../type-aliases/ProcessorModulesRecord.md | 15 - src/pages/docs/reference/protocol/README.md | 55 - src/pages/docs/reference/protocol/_meta.tsx | 3 - .../protocol/classes/AccountState.md | 357 ---- .../protocol/classes/AccountStateHook.md | 190 -- .../protocol/classes/BlockHashMerkleTree.md | 291 --- .../classes/BlockHashMerkleTreeWitness.md | 575 ------ .../protocol/classes/BlockHashTreeEntry.md | 433 ---- .../protocol/classes/BlockHeightHook.md | 204 -- .../reference/protocol/classes/BlockProver.md | 333 ---- .../classes/BlockProverExecutionData.md | 643 ------ .../classes/BlockProverProgrammable.md | 318 --- .../classes/BlockProverPublicInput.md | 741 ------- .../classes/BlockProverPublicOutput.md | 827 -------- .../protocol/classes/BridgeContract.md | 1587 --------------- .../protocol/classes/BridgeContractBase.md | 1477 -------------- .../classes/BridgeContractProtocolModule.md | 147 -- .../protocol/classes/ContractModule.md | 159 -- .../protocol/classes/CurrentBlock.md | 357 ---- .../classes/DefaultProvableHashList.md | 168 -- .../reference/protocol/classes/Deposit.md | 493 ----- .../classes/DispatchContractProtocolModule.md | 175 -- .../protocol/classes/DispatchSmartContract.md | 1401 ------------- .../classes/DispatchSmartContractBase.md | 1245 ------------ .../protocol/classes/DynamicBlockProof.md | 380 ---- .../protocol/classes/DynamicRuntimeProof.md | 380 ---- .../classes/LastStateRootBlockHook.md | 212 -- .../protocol/classes/MethodPublicOutput.md | 680 ------- .../protocol/classes/MethodVKConfigData.md | 433 ---- .../reference/protocol/classes/MinaActions.md | 45 - .../protocol/classes/MinaActionsHashList.md | 172 -- .../reference/protocol/classes/MinaEvents.md | 45 - .../classes/MinaPrefixedProvableHashList.md | 184 -- .../protocol/classes/NetworkState.md | 449 ----- .../classes/NetworkStateSettlementModule.md | 176 -- .../docs/reference/protocol/classes/Option.md | 341 ---- .../reference/protocol/classes/OptionBase.md | 161 -- .../classes/OutgoingMessageArgument.md | 501 ----- .../classes/OutgoingMessageArgumentBatch.md | 439 ----- .../protocol/classes/OutgoingMessageKey.md | 421 ---- .../docs/reference/protocol/classes/Path.md | 107 - .../classes/PrefixedProvableHashList.md | 172 -- .../protocol/classes/PreviousBlock.md | 357 ---- .../reference/protocol/classes/Protocol.md | 716 ------- .../protocol/classes/ProtocolModule.md | 150 -- .../protocol/classes/ProvableBlockHook.md | 213 -- .../protocol/classes/ProvableHashList.md | 143 -- .../protocol/classes/ProvableOption.md | 433 ---- .../classes/ProvableReductionHashList.md | 210 -- .../classes/ProvableSettlementHook.md | 180 -- .../classes/ProvableStateTransition.md | 549 ------ .../classes/ProvableStateTransitionType.md | 409 ---- .../classes/ProvableTransactionHook.md | 187 -- .../protocol/classes/PublicKeyOption.md | 479 ----- .../classes/RuntimeMethodExecutionContext.md | 398 ---- .../RuntimeMethodExecutionDataStruct.md | 591 ------ .../RuntimeProvableMethodExecutionResult.md | 159 -- .../protocol/classes/RuntimeTransaction.md | 743 ------- .../RuntimeVerificationKeyAttestation.md | 467 ----- .../RuntimeVerificationKeyRootService.md | 61 - .../classes/SettlementContractModule.md | 793 -------- .../SettlementContractProtocolModule.md | 171 -- .../classes/SettlementSmartContract.md | 1736 ----------------- .../classes/SettlementSmartContractBase.md | 1570 --------------- .../protocol/classes/SignedTransaction.md | 607 ------ .../docs/reference/protocol/classes/State.md | 182 -- .../reference/protocol/classes/StateMap.md | 229 --- .../protocol/classes/StateServiceProvider.md | 67 - .../protocol/classes/StateTransition.md | 229 --- .../classes/StateTransitionProvableBatch.md | 507 ----- .../protocol/classes/StateTransitionProver.md | 272 --- .../StateTransitionProverProgrammable.md | 240 --- .../StateTransitionProverPublicInput.md | 549 ------ .../StateTransitionProverPublicOutput.md | 549 ------ .../classes/StateTransitionReductionList.md | 236 --- .../protocol/classes/StateTransitionType.md | 75 - .../classes/TokenBridgeAttestation.md | 445 ----- .../classes/TokenBridgeDeploymentAuth.md | 528 ----- .../protocol/classes/TokenBridgeEntry.md | 441 ----- .../protocol/classes/TokenBridgeTree.md | 344 ---- .../classes/TokenBridgeTreeAddition.md | 453 ----- .../classes/TokenBridgeTreeWitness.md | 575 ------ .../protocol/classes/TokenMapping.md | 429 ---- .../TransitionMethodExecutionResult.md | 31 - .../protocol/classes/UInt64Option.md | 479 ----- .../classes/UpdateMessagesHashAuth.md | 520 ----- .../docs/reference/protocol/classes/VKTree.md | 291 --- .../protocol/classes/VKTreeWitness.md | 575 ------ .../reference/protocol/classes/WithPath.md | 43 - .../classes/WithStateServiceProvider.md | 43 - .../reference/protocol/classes/Withdrawal.md | 505 ----- .../reference/protocol/functions/assert.md | 38 - .../protocol/functions/emptyActions.md | 19 - .../protocol/functions/emptyEvents.md | 19 - .../protocol/functions/notInCircuit.md | 19 - .../protocol/functions/protocolState.md | 40 - .../functions/reduceStateTransitions.md | 25 - .../protocol/functions/singleFieldToString.md | 25 - .../protocol/functions/stringToField.md | 25 - src/pages/docs/reference/protocol/globals.md | 163 -- .../protocol/interfaces/BlockProvable.md | 145 -- .../protocol/interfaces/BlockProverState.md | 76 - .../protocol/interfaces/BlockProverType.md | 272 --- .../interfaces/ContractAuthorization.md | 36 - .../interfaces/DispatchContractType.md | 87 - .../interfaces/MinimalVKTreeService.md | 25 - .../protocol/interfaces/ProtocolDefinition.md | 33 - .../interfaces/ProtocolEnvironment.md | 53 - .../protocol/interfaces/RuntimeLike.md | 35 - .../interfaces/RuntimeMethodExecutionData.md | 29 - .../interfaces/SettlementContractType.md | 137 -- .../interfaces/SimpleAsyncStateService.md | 53 - .../interfaces/StateTransitionProvable.md | 103 - .../interfaces/StateTransitionProverType.md | 226 --- .../TransitionMethodExecutionContext.md | 72 - .../protocol/type-aliases/BlockProof.md | 15 - .../protocol/type-aliases/BlockProverProof.md | 15 - .../type-aliases/BridgeContractConfig.md | 25 - .../type-aliases/BridgeContractType.md | 93 - .../type-aliases/DispatchContractConfig.md | 21 - .../protocol/type-aliases/InputBlockProof.md | 15 - .../MandatoryProtocolModulesRecord.md | 37 - .../MandatorySettlementModulesRecord.md | 29 - .../type-aliases/ProtocolModulesRecord.md | 15 - .../protocol/type-aliases/ReturnType.md | 19 - .../type-aliases/RuntimeMethodIdMapping.md | 15 - .../RuntimeMethodInvocationType.md | 15 - .../protocol/type-aliases/RuntimeProof.md | 15 - .../type-aliases/SettlementContractConfig.md | 21 - .../type-aliases/SettlementHookInputs.md | 41 - .../type-aliases/SettlementModulesRecord.md | 15 - .../type-aliases/SettlementStateRecord.md | 37 - .../SmartContractClassFromInterface.md | 19 - .../type-aliases/StateTransitionProof.md | 15 - .../protocol/type-aliases/Subclass.md | 25 - .../protocol/variables/ACTIONS_EMPTY_HASH.md | 15 - .../variables/BATCH_SIGNATURE_PREFIX.md | 15 - .../protocol/variables/MINA_EVENT_PREFIXES.md | 29 - .../variables/OUTGOING_MESSAGE_BATCH_SIZE.md | 15 - .../protocol/variables/ProtocolConstants.md | 21 - .../protocol/variables/treeFeeHeight.md | 15 - src/pages/docs/reference/sdk/README.md | 57 - src/pages/docs/reference/sdk/_meta.tsx | 3 - .../docs/reference/sdk/classes/AppChain.md | 754 ------- .../reference/sdk/classes/AppChainModule.md | 137 -- .../sdk/classes/AppChainTransaction.md | 137 -- .../sdk/classes/AreProofsEnabledFactory.md | 62 - .../docs/reference/sdk/classes/AuroSigner.md | 154 -- .../classes/BlockStorageNetworkStateModule.md | 191 -- .../reference/sdk/classes/ClientAppChain.md | 799 -------- .../reference/sdk/classes/GraphqlClient.md | 142 -- .../GraphqlNetworkStateTransportModule.md | 188 -- .../classes/GraphqlQueryTransportModule.md | 184 -- .../sdk/classes/GraphqlTransactionSender.md | 178 -- .../sdk/classes/InMemoryAreProofsEnabled.md | 67 - .../reference/sdk/classes/InMemorySigner.md | 156 -- .../sdk/classes/InMemoryTransactionSender.md | 194 -- .../sdk/classes/SharedDependencyFactory.md | 54 - .../sdk/classes/StateServiceQueryModule.md | 220 --- .../reference/sdk/classes/TestingAppChain.md | 845 -------- src/pages/docs/reference/sdk/globals.md | 53 - .../sdk/interfaces/AppChainConfig.md | 57 - .../sdk/interfaces/AppChainDefinition.md | 55 - .../interfaces/ExpandAppChainDefinition.md | 31 - .../sdk/interfaces/GraphqlClientConfig.md | 21 - .../sdk/interfaces/InMemorySignerConfig.md | 21 - .../sdk/interfaces/SharedDependencyRecord.md | 37 - .../docs/reference/sdk/interfaces/Signer.md | 31 - .../sdk/interfaces/TransactionSender.md | 120 -- .../sdk/type-aliases/AppChainModulesRecord.md | 15 - .../sdk/type-aliases/ExpandAppChainModules.md | 39 - .../PartialVanillaRuntimeModulesRecord.md | 21 - .../TestingSequencerModulesRecord.md | 49 - .../sdk/variables/randomFeeRecipient.md | 15 - src/pages/docs/reference/sequencer/README.md | 40 - src/pages/docs/reference/sequencer/_meta.tsx | 3 - .../sequencer/classes/AbstractTaskQueue.md | 190 -- .../classes/ArtifactRecordSerializer.md | 59 - .../sequencer/classes/BatchProducerModule.md | 204 -- .../sequencer/classes/BlockProducerModule.md | 229 --- .../sequencer/classes/BlockProofSerializer.md | 43 - .../sequencer/classes/BlockTaskFlowService.md | 144 -- .../sequencer/classes/BlockTriggerBase.md | 296 --- .../classes/CachedMerkleTreeStore.md | 289 --- .../sequencer/classes/CachedStateService.md | 265 --- .../sequencer/classes/CompressedSignature.md | 84 - .../sequencer/classes/DatabasePruneModule.md | 147 -- .../classes/DecodedStateSerializer.md | 59 - .../sequencer/classes/DummyStateService.md | 75 - .../classes/DynamicProofTaskSerializer.md | 167 -- .../docs/reference/sequencer/classes/Flow.md | 213 -- .../sequencer/classes/FlowCreator.md | 57 - .../sequencer/classes/FlowTaskWorker.md | 121 -- .../classes/InMemoryAsyncMerkleTreeStore.md | 103 - .../sequencer/classes/InMemoryBatchStorage.md | 104 - .../sequencer/classes/InMemoryBlockStorage.md | 201 -- .../sequencer/classes/InMemoryDatabase.md | 217 --- .../classes/InMemoryMessageStorage.md | 81 - .../classes/InMemorySettlementStorage.md | 57 - .../classes/InMemoryTransactionStorage.md | 104 - .../sequencer/classes/ListenerList.md | 93 - .../sequencer/classes/LocalTaskQueue.md | 290 --- .../classes/LocalTaskWorkerModule.md | 682 ------- .../sequencer/classes/ManualBlockTrigger.md | 339 ---- .../sequencer/classes/MinaBaseLayer.md | 220 --- .../classes/MinaIncomingMessageAdapter.md | 82 - .../classes/MinaSimulationService.md | 83 - .../classes/MinaTransactionSender.md | 65 - .../classes/MinaTransactionSimulator.md | 203 -- .../sequencer/classes/NetworkStateQuery.md | 73 - .../NewBlockProvingParametersSerializer.md | 83 - .../sequencer/classes/NewBlockTask.md | 206 -- .../sequencer/classes/NoopBaseLayer.md | 171 -- .../classes/PairProofTaskSerializer.md | 85 - .../sequencer/classes/PendingTransaction.md | 298 --- .../classes/PreFilledStateService.md | 102 - .../sequencer/classes/PrivateMempool.md | 241 --- .../sequencer/classes/ProofTaskSerializer.md | 167 -- .../classes/ProvenSettlementPermissions.md | 91 - .../sequencer/classes/ReductionTaskFlow.md | 152 -- .../RuntimeProofParametersSerializer.md | 71 - .../sequencer/classes/RuntimeProvingTask.md | 222 --- ...imeVerificationKeyAttestationSerializer.md | 97 - .../reference/sequencer/classes/Sequencer.md | 687 ------- .../sequencer/classes/SequencerModule.md | 155 -- .../classes/SequencerStartupModule.md | 205 -- .../sequencer/classes/SettlementModule.md | 422 ---- .../classes/SettlementProvingTask.md | 217 --- .../classes/SignedSettlementPermissions.md | 91 - .../sequencer/classes/SomeProofSubclass.md | 301 --- .../StateTransitionParametersSerializer.md | 71 - .../classes/StateTransitionReductionTask.md | 214 -- .../sequencer/classes/StateTransitionTask.md | 214 -- .../classes/SyncCachedMerkleTreeStore.md | 123 -- .../sequencer/classes/TaskWorkerModule.md | 114 -- .../sequencer/classes/TimedBlockTrigger.md | 345 ---- .../classes/TransactionExecutionService.md | 65 - .../classes/TransactionProvingTask.md | 214 -- ...ansactionProvingTaskParameterSerializer.md | 83 - .../classes/TransactionTraceService.md | 130 -- .../sequencer/classes/UnsignedTransaction.md | 220 --- .../sequencer/classes/UntypedOption.md | 264 --- .../classes/UntypedStateTransition.md | 231 --- .../classes/VanillaTaskWorkerModules.md | 163 -- .../classes/VerificationKeySerializer.md | 59 - .../sequencer/classes/WithdrawalEvent.md | 489 ----- .../sequencer/classes/WithdrawalKey.md | 421 ---- .../sequencer/classes/WithdrawalQueue.md | 214 -- .../sequencer/classes/WorkerReadyModule.md | 46 - .../sequencer/functions/closeable.md | 29 - .../reference/sequencer/functions/distinct.md | 37 - .../functions/distinctByPredicate.md | 47 - .../sequencer/functions/distinctByString.md | 37 - .../functions/executeWithExecutionContext.md | 37 - .../sequencer/functions/sequencerModule.md | 32 - src/pages/docs/reference/sequencer/globals.md | 198 -- .../interfaces/AsyncMerkleTreeStore.md | 73 - .../sequencer/interfaces/AsyncStateService.md | 95 - .../sequencer/interfaces/BaseLayer.md | 44 - .../BaseLayerContractPermissions.md | 61 - .../interfaces/BaseLayerDependencyRecord.md | 37 - .../reference/sequencer/interfaces/Batch.md | 41 - .../sequencer/interfaces/BatchStorage.md | 55 - .../sequencer/interfaces/BatchTransaction.md | 37 - .../reference/sequencer/interfaces/Block.md | 109 -- .../sequencer/interfaces/BlockConfig.md | 29 - .../interfaces/BlockProverParameters.md | 45 - .../sequencer/interfaces/BlockQueue.md | 73 - .../sequencer/interfaces/BlockResult.md | 61 - .../sequencer/interfaces/BlockStorage.md | 55 - .../sequencer/interfaces/BlockTrace.md | 37 - .../sequencer/interfaces/BlockTrigger.md | 16 - .../interfaces/BlockWithMaybeResult.md | 29 - .../interfaces/BlockWithPreviousResult.md | 29 - .../sequencer/interfaces/BlockWithResult.md | 33 - .../sequencer/interfaces/Closeable.md | 30 - .../sequencer/interfaces/Database.md | 94 - .../interfaces/HistoricalBatchStorage.md | 31 - .../interfaces/HistoricalBlockStorage.md | 49 - .../interfaces/IncomingMessageAdapter.md | 50 - .../sequencer/interfaces/InstantiatedQueue.md | 105 - .../interfaces/LocalTaskQueueConfig.md | 21 - .../reference/sequencer/interfaces/Mempool.md | 75 - .../sequencer/interfaces/MerkleTreeNode.md | 49 - .../interfaces/MerkleTreeNodeQuery.md | 33 - .../sequencer/interfaces/MessageStorage.md | 59 - .../interfaces/MinaBaseLayerConfig.md | 21 - .../interfaces/NetworkStateTransportModule.md | 49 - .../interfaces/NewBlockProverParameters.md | 45 - .../sequencer/interfaces/OutgoingMessage.md | 33 - .../interfaces/OutgoingMessageQueue.md | 68 - .../interfaces/PairingDerivedInput.md | 48 - .../sequencer/interfaces/QueryGetterState.md | 53 - .../interfaces/QueryGetterStateMap.md | 73 - .../interfaces/QueryTransportModule.md | 49 - .../interfaces/RuntimeProofParameters.md | 37 - .../sequencer/interfaces/Sequenceable.md | 25 - .../sequencer/interfaces/SettleableBatch.md | 69 - .../sequencer/interfaces/Settlement.md | 29 - .../interfaces/SettlementModuleConfig.md | 29 - .../sequencer/interfaces/SettlementStorage.md | 31 - .../sequencer/interfaces/StateEntry.md | 29 - .../StateTransitionProofParameters.md | 45 - .../interfaces/StorageDependencyFactory.md | 48 - .../StorageDependencyMinimumDependencies.md | 109 -- .../reference/sequencer/interfaces/Task.md | 81 - .../sequencer/interfaces/TaskPayload.md | 53 - .../sequencer/interfaces/TaskQueue.md | 62 - .../sequencer/interfaces/TaskSerializer.md | 53 - .../interfaces/TimedBlockTriggerConfig.md | 51 - .../interfaces/TimedBlockTriggerEvent.md | 61 - .../interfaces/TransactionExecutionResult.md | 69 - .../interfaces/TransactionStorage.md | 66 - .../sequencer/interfaces/TransactionTrace.md | 37 - .../sequencer/interfaces/TxEvents.md | 45 - .../type-aliases/AllTaskWorkerModules.md | 15 - .../sequencer/type-aliases/BlockEvents.md | 29 - .../type-aliases/ChainStateTaskArgs.md | 25 - .../type-aliases/DatabasePruneConfig.md | 21 - .../type-aliases/JSONEncodableState.md | 15 - .../type-aliases/MapStateMapToQuery.md | 19 - .../sequencer/type-aliases/MapStateToQuery.md | 19 - .../sequencer/type-aliases/MempoolEvents.md | 21 - .../sequencer/type-aliases/ModuleQuery.md | 19 - .../type-aliases/NewBlockProvingParameters.md | 15 - .../sequencer/type-aliases/PairTuple.md | 19 - .../sequencer/type-aliases/PickByType.md | 21 - .../type-aliases/PickStateMapProperties.md | 19 - .../type-aliases/PickStateProperties.md | 19 - .../reference/sequencer/type-aliases/Query.md | 21 - .../RuntimeContextReducedExecutionResult.md | 15 - .../type-aliases/SequencerModulesRecord.md | 15 - .../type-aliases/SerializedArtifactRecord.md | 15 - .../type-aliases/SettlementModuleEvents.md | 21 - .../type-aliases/SomeRuntimeMethod.md | 25 - .../sequencer/type-aliases/StateRecord.md | 15 - .../sequencer/type-aliases/TaskStateRecord.md | 15 - .../type-aliases/TaskWorkerModulesRecord.md | 15 - .../TaskWorkerModulesWithoutSettlement.md | 15 - .../TransactionProvingTaskParameters.md | 15 - .../type-aliases/TransactionTaskArgs.md | 25 - .../type-aliases/TransactionTaskResult.md | 21 - .../sequencer/type-aliases/TypedClass.md | 29 - .../type-aliases/UnsignedTransactionBody.md | 44 - .../type-aliases/VerificationKeyJSON.md | 25 - .../reference/sequencer/variables/Block.md | 45 - .../sequencer/variables/BlockWithResult.md | 109 -- .../sequencer/variables/JSONTaskSerializer.md | 27 - .../variables/QueryBuilderFactory.md | 77 - src/pages/docs/reference/stack/README.md | 15 - src/pages/docs/reference/stack/_meta.tsx | 3 - .../reference/stack/classes/TestBalances.md | 491 ----- .../reference/stack/functions/startServer.md | 19 - src/pages/docs/reference/stack/globals.md | 19 - 634 files changed, 95425 deletions(-) delete mode 100644 src/pages/docs/reference/_meta.tsx delete mode 100644 src/pages/docs/reference/api/README.md delete mode 100644 src/pages/docs/reference/api/_meta.tsx delete mode 100644 src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md delete mode 100644 src/pages/docs/reference/api/classes/BatchStorageResolver.md delete mode 100644 src/pages/docs/reference/api/classes/BlockModel.md delete mode 100644 src/pages/docs/reference/api/classes/BlockResolver.md delete mode 100644 src/pages/docs/reference/api/classes/ComputedBlockModel.md delete mode 100644 src/pages/docs/reference/api/classes/GraphqlModule.md delete mode 100644 src/pages/docs/reference/api/classes/GraphqlSequencerModule.md delete mode 100644 src/pages/docs/reference/api/classes/GraphqlServer.md delete mode 100644 src/pages/docs/reference/api/classes/MempoolResolver.md delete mode 100644 src/pages/docs/reference/api/classes/MerkleWitnessDTO.md delete mode 100644 src/pages/docs/reference/api/classes/MerkleWitnessResolver.md delete mode 100644 src/pages/docs/reference/api/classes/NodeInformationObject.md delete mode 100644 src/pages/docs/reference/api/classes/NodeStatusObject.md delete mode 100644 src/pages/docs/reference/api/classes/NodeStatusResolver.md delete mode 100644 src/pages/docs/reference/api/classes/NodeStatusService.md delete mode 100644 src/pages/docs/reference/api/classes/ProcessInformationObject.md delete mode 100644 src/pages/docs/reference/api/classes/QueryGraphqlModule.md delete mode 100644 src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md delete mode 100644 src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md delete mode 100644 src/pages/docs/reference/api/classes/Signature.md delete mode 100644 src/pages/docs/reference/api/classes/TransactionObject.md delete mode 100644 src/pages/docs/reference/api/classes/VanillaGraphqlModules.md delete mode 100644 src/pages/docs/reference/api/functions/graphqlModule.md delete mode 100644 src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md delete mode 100644 src/pages/docs/reference/api/interfaces/NodeInformation.md delete mode 100644 src/pages/docs/reference/api/interfaces/ProcessInformation.md delete mode 100644 src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md delete mode 100644 src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md delete mode 100644 src/pages/docs/reference/common/README.md delete mode 100644 src/pages/docs/reference/common/_meta.tsx delete mode 100644 src/pages/docs/reference/common/classes/AtomicCompileHelper.md delete mode 100644 src/pages/docs/reference/common/classes/ChildVerificationKeyService.md delete mode 100644 src/pages/docs/reference/common/classes/CompileRegistry.md delete mode 100644 src/pages/docs/reference/common/classes/ConfigurableModule.md delete mode 100644 src/pages/docs/reference/common/classes/EventEmitter.md delete mode 100644 src/pages/docs/reference/common/classes/EventEmitterProxy.md delete mode 100644 src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md delete mode 100644 src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md delete mode 100644 src/pages/docs/reference/common/classes/ModuleContainer.md delete mode 100644 src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md delete mode 100644 src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md delete mode 100644 src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md delete mode 100644 src/pages/docs/reference/common/classes/RollupMerkleTree.md delete mode 100644 src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md delete mode 100644 src/pages/docs/reference/common/classes/ZkProgrammable.md delete mode 100644 src/pages/docs/reference/common/functions/assertValidTextLogLevel.md delete mode 100644 src/pages/docs/reference/common/functions/compileToMockable.md delete mode 100644 src/pages/docs/reference/common/functions/createMerkleTree.md delete mode 100644 src/pages/docs/reference/common/functions/dummyValue.md delete mode 100644 src/pages/docs/reference/common/functions/expectDefined.md delete mode 100644 src/pages/docs/reference/common/functions/filterNonNull.md delete mode 100644 src/pages/docs/reference/common/functions/filterNonUndefined.md delete mode 100644 src/pages/docs/reference/common/functions/getInjectAliases.md delete mode 100644 src/pages/docs/reference/common/functions/hashWithPrefix.md delete mode 100644 src/pages/docs/reference/common/functions/implement.md delete mode 100644 src/pages/docs/reference/common/functions/injectAlias.md delete mode 100644 src/pages/docs/reference/common/functions/injectOptional.md delete mode 100644 src/pages/docs/reference/common/functions/isSubtypeOfName.md delete mode 100644 src/pages/docs/reference/common/functions/mapSequential.md delete mode 100644 src/pages/docs/reference/common/functions/noop.md delete mode 100644 src/pages/docs/reference/common/functions/prefixToField.md delete mode 100644 src/pages/docs/reference/common/functions/provableMethod.md delete mode 100644 src/pages/docs/reference/common/functions/range.md delete mode 100644 src/pages/docs/reference/common/functions/reduceSequential.md delete mode 100644 src/pages/docs/reference/common/functions/requireTrue.md delete mode 100644 src/pages/docs/reference/common/functions/safeParseJson.md delete mode 100644 src/pages/docs/reference/common/functions/sleep.md delete mode 100644 src/pages/docs/reference/common/functions/splitArray.md delete mode 100644 src/pages/docs/reference/common/functions/toProver.md delete mode 100644 src/pages/docs/reference/common/functions/verifyToMockable.md delete mode 100644 src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md delete mode 100644 src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md delete mode 100644 src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md delete mode 100644 src/pages/docs/reference/common/interfaces/AreProofsEnabled.md delete mode 100644 src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md delete mode 100644 src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md delete mode 100644 src/pages/docs/reference/common/interfaces/ChildContainerProvider.md delete mode 100644 src/pages/docs/reference/common/interfaces/CompilableModule.md delete mode 100644 src/pages/docs/reference/common/interfaces/Compile.md delete mode 100644 src/pages/docs/reference/common/interfaces/CompileArtifact.md delete mode 100644 src/pages/docs/reference/common/interfaces/Configurable.md delete mode 100644 src/pages/docs/reference/common/interfaces/DependencyFactory.md delete mode 100644 src/pages/docs/reference/common/interfaces/EventEmittingComponent.md delete mode 100644 src/pages/docs/reference/common/interfaces/EventEmittingContainer.md delete mode 100644 src/pages/docs/reference/common/interfaces/MerkleTreeStore.md delete mode 100644 src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md delete mode 100644 src/pages/docs/reference/common/interfaces/ModulesRecord.md delete mode 100644 src/pages/docs/reference/common/interfaces/PlainZkProgram.md delete mode 100644 src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md delete mode 100644 src/pages/docs/reference/common/interfaces/ToFieldable.md delete mode 100644 src/pages/docs/reference/common/interfaces/ToFieldableStatic.md delete mode 100644 src/pages/docs/reference/common/interfaces/ToJSONableStatic.md delete mode 100644 src/pages/docs/reference/common/interfaces/Verify.md delete mode 100644 src/pages/docs/reference/common/interfaces/WithZkProgrammable.md delete mode 100644 src/pages/docs/reference/common/type-aliases/ArgumentTypes.md delete mode 100644 src/pages/docs/reference/common/type-aliases/ArrayElement.md delete mode 100644 src/pages/docs/reference/common/type-aliases/ArtifactRecord.md delete mode 100644 src/pages/docs/reference/common/type-aliases/BaseModuleType.md delete mode 100644 src/pages/docs/reference/common/type-aliases/CapitalizeAny.md delete mode 100644 src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md delete mode 100644 src/pages/docs/reference/common/type-aliases/CompileTarget.md delete mode 100644 src/pages/docs/reference/common/type-aliases/ContainerEvents.md delete mode 100644 src/pages/docs/reference/common/type-aliases/DecoratedMethod.md delete mode 100644 src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md delete mode 100644 src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md delete mode 100644 src/pages/docs/reference/common/type-aliases/DependencyRecord.md delete mode 100644 src/pages/docs/reference/common/type-aliases/EventListenable.md delete mode 100644 src/pages/docs/reference/common/type-aliases/EventsRecord.md delete mode 100644 src/pages/docs/reference/common/type-aliases/FilterNeverValues.md delete mode 100644 src/pages/docs/reference/common/type-aliases/FlattenObject.md delete mode 100644 src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md delete mode 100644 src/pages/docs/reference/common/type-aliases/InferDependencies.md delete mode 100644 src/pages/docs/reference/common/type-aliases/InferProofBase.md delete mode 100644 src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md delete mode 100644 src/pages/docs/reference/common/type-aliases/MergeObjects.md delete mode 100644 src/pages/docs/reference/common/type-aliases/ModuleEvents.md delete mode 100644 src/pages/docs/reference/common/type-aliases/ModulesConfig.md delete mode 100644 src/pages/docs/reference/common/type-aliases/NoConfig.md delete mode 100644 src/pages/docs/reference/common/type-aliases/NonMethods.md delete mode 100644 src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md delete mode 100644 src/pages/docs/reference/common/type-aliases/OmitKeys.md delete mode 100644 src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md delete mode 100644 src/pages/docs/reference/common/type-aliases/Preset.md delete mode 100644 src/pages/docs/reference/common/type-aliases/Presets.md delete mode 100644 src/pages/docs/reference/common/type-aliases/ProofTypes.md delete mode 100644 src/pages/docs/reference/common/type-aliases/RecursivePartial.md delete mode 100644 src/pages/docs/reference/common/type-aliases/ResolvableModules.md delete mode 100644 src/pages/docs/reference/common/type-aliases/StringKeyOf.md delete mode 100644 src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md delete mode 100644 src/pages/docs/reference/common/type-aliases/TypedClass.md delete mode 100644 src/pages/docs/reference/common/type-aliases/UnTypedClass.md delete mode 100644 src/pages/docs/reference/common/type-aliases/UnionToIntersection.md delete mode 100644 src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md delete mode 100644 src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md delete mode 100644 src/pages/docs/reference/common/variables/MAX_FIELD.md delete mode 100644 src/pages/docs/reference/common/variables/MOCK_PROOF.md delete mode 100644 src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md delete mode 100644 src/pages/docs/reference/common/variables/ModuleContainerErrors.md delete mode 100644 src/pages/docs/reference/common/variables/injectAliasMetadataKey.md delete mode 100644 src/pages/docs/reference/common/variables/log.md delete mode 100644 src/pages/docs/reference/deployment/README.md delete mode 100644 src/pages/docs/reference/deployment/_meta.tsx delete mode 100644 src/pages/docs/reference/deployment/classes/BullQueue.md delete mode 100644 src/pages/docs/reference/deployment/classes/Environment.md delete mode 100644 src/pages/docs/reference/deployment/globals.md delete mode 100644 src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md delete mode 100644 src/pages/docs/reference/deployment/interfaces/Startable.md delete mode 100644 src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md delete mode 100644 src/pages/docs/reference/indexer/README.md delete mode 100644 src/pages/docs/reference/indexer/_meta.tsx delete mode 100644 src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md delete mode 100644 src/pages/docs/reference/indexer/classes/IndexBlockTask.md delete mode 100644 src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md delete mode 100644 src/pages/docs/reference/indexer/classes/Indexer.md delete mode 100644 src/pages/docs/reference/indexer/classes/IndexerModule.md delete mode 100644 src/pages/docs/reference/indexer/classes/IndexerNotifier.md delete mode 100644 src/pages/docs/reference/indexer/functions/ValidateTakeArg.md delete mode 100644 src/pages/docs/reference/indexer/functions/cleanResolvers.md delete mode 100644 src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md delete mode 100644 src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md delete mode 100644 src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md delete mode 100644 src/pages/docs/reference/library/README.md delete mode 100644 src/pages/docs/reference/library/_meta.tsx delete mode 100644 src/pages/docs/reference/library/classes/Balance.md delete mode 100644 src/pages/docs/reference/library/classes/Balances.md delete mode 100644 src/pages/docs/reference/library/classes/BalancesKey.md delete mode 100644 src/pages/docs/reference/library/classes/FeeTree.md delete mode 100644 src/pages/docs/reference/library/classes/InMemorySequencerModules.md delete mode 100644 src/pages/docs/reference/library/classes/MethodFeeConfigData.md delete mode 100644 src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md delete mode 100644 src/pages/docs/reference/library/classes/SimpleSequencerModules.md delete mode 100644 src/pages/docs/reference/library/classes/TokenId.md delete mode 100644 src/pages/docs/reference/library/classes/TransactionFeeHook.md delete mode 100644 src/pages/docs/reference/library/classes/UInt.md delete mode 100644 src/pages/docs/reference/library/classes/UInt112.md delete mode 100644 src/pages/docs/reference/library/classes/UInt224.md delete mode 100644 src/pages/docs/reference/library/classes/UInt32.md delete mode 100644 src/pages/docs/reference/library/classes/UInt64.md delete mode 100644 src/pages/docs/reference/library/classes/VanillaProtocolModules.md delete mode 100644 src/pages/docs/reference/library/classes/VanillaRuntimeModules.md delete mode 100644 src/pages/docs/reference/library/classes/WithdrawalEvent.md delete mode 100644 src/pages/docs/reference/library/classes/WithdrawalKey.md delete mode 100644 src/pages/docs/reference/library/classes/Withdrawals.md delete mode 100644 src/pages/docs/reference/library/interfaces/BalancesEvents.md delete mode 100644 src/pages/docs/reference/library/interfaces/FeeIndexes.md delete mode 100644 src/pages/docs/reference/library/interfaces/FeeTreeValues.md delete mode 100644 src/pages/docs/reference/library/interfaces/MethodFeeConfig.md delete mode 100644 src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md delete mode 100644 src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md delete mode 100644 src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md delete mode 100644 src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md delete mode 100644 src/pages/docs/reference/library/type-aliases/MinimalBalances.md delete mode 100644 src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md delete mode 100644 src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md delete mode 100644 src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md delete mode 100644 src/pages/docs/reference/library/type-aliases/UIntConstructor.md delete mode 100644 src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md delete mode 100644 src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md delete mode 100644 src/pages/docs/reference/library/variables/errors.md delete mode 100644 src/pages/docs/reference/library/variables/treeFeeHeight.md delete mode 100644 src/pages/docs/reference/module/README.md delete mode 100644 src/pages/docs/reference/module/_meta.tsx delete mode 100644 src/pages/docs/reference/module/classes/InMemoryStateService.md delete mode 100644 src/pages/docs/reference/module/classes/MethodIdFactory.md delete mode 100644 src/pages/docs/reference/module/classes/MethodIdResolver.md delete mode 100644 src/pages/docs/reference/module/classes/MethodParameterEncoder.md delete mode 100644 src/pages/docs/reference/module/classes/Runtime.md delete mode 100644 src/pages/docs/reference/module/classes/RuntimeEvents.md delete mode 100644 src/pages/docs/reference/module/classes/RuntimeModule.md delete mode 100644 src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md delete mode 100644 src/pages/docs/reference/module/functions/combineMethodName.md delete mode 100644 src/pages/docs/reference/module/functions/getAllPropertyNames.md delete mode 100644 src/pages/docs/reference/module/functions/isRuntimeMethod.md delete mode 100644 src/pages/docs/reference/module/functions/runtimeMessage.md delete mode 100644 src/pages/docs/reference/module/functions/runtimeMethod.md delete mode 100644 src/pages/docs/reference/module/functions/runtimeModule.md delete mode 100644 src/pages/docs/reference/module/functions/state.md delete mode 100644 src/pages/docs/reference/module/functions/toEventsHash.md delete mode 100644 src/pages/docs/reference/module/functions/toStateTransitionsHash.md delete mode 100644 src/pages/docs/reference/module/functions/toWrappedMethod.md delete mode 100644 src/pages/docs/reference/module/globals.md delete mode 100644 src/pages/docs/reference/module/interfaces/RuntimeDefinition.md delete mode 100644 src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md delete mode 100644 src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md delete mode 100644 src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md delete mode 100644 src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md delete mode 100644 src/pages/docs/reference/module/type-aliases/WrappedMethod.md delete mode 100644 src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md delete mode 100644 src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md delete mode 100644 src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md delete mode 100644 src/pages/docs/reference/persistance/README.md delete mode 100644 src/pages/docs/reference/persistance/_meta.tsx delete mode 100644 src/pages/docs/reference/persistance/classes/BatchMapper.md delete mode 100644 src/pages/docs/reference/persistance/classes/BlockMapper.md delete mode 100644 src/pages/docs/reference/persistance/classes/BlockResultMapper.md delete mode 100644 src/pages/docs/reference/persistance/classes/FieldMapper.md delete mode 100644 src/pages/docs/reference/persistance/classes/PrismaBatchStore.md delete mode 100644 src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md delete mode 100644 src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md delete mode 100644 src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md delete mode 100644 src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md delete mode 100644 src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md delete mode 100644 src/pages/docs/reference/persistance/classes/PrismaStateService.md delete mode 100644 src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md delete mode 100644 src/pages/docs/reference/persistance/classes/RedisConnectionModule.md delete mode 100644 src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md delete mode 100644 src/pages/docs/reference/persistance/classes/SettlementMapper.md delete mode 100644 src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md delete mode 100644 src/pages/docs/reference/persistance/classes/StateTransitionMapper.md delete mode 100644 src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md delete mode 100644 src/pages/docs/reference/persistance/classes/TransactionMapper.md delete mode 100644 src/pages/docs/reference/persistance/interfaces/PrismaConnection.md delete mode 100644 src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md delete mode 100644 src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md delete mode 100644 src/pages/docs/reference/persistance/interfaces/RedisConnection.md delete mode 100644 src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md delete mode 100644 src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md delete mode 100644 src/pages/docs/reference/processor/README.md delete mode 100644 src/pages/docs/reference/processor/_meta.tsx delete mode 100644 src/pages/docs/reference/processor/classes/BlockFetching.md delete mode 100644 src/pages/docs/reference/processor/classes/Database.md delete mode 100644 src/pages/docs/reference/processor/classes/DatabasePruneModule.md delete mode 100644 src/pages/docs/reference/processor/classes/HandlersExecutor.md delete mode 100644 src/pages/docs/reference/processor/classes/Processor.md delete mode 100644 src/pages/docs/reference/processor/classes/ProcessorModule.md delete mode 100644 src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md delete mode 100644 src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md delete mode 100644 src/pages/docs/reference/processor/functions/ValidateTakeArg.md delete mode 100644 src/pages/docs/reference/processor/functions/cleanResolvers.md delete mode 100644 src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md delete mode 100644 src/pages/docs/reference/processor/interfaces/BlockResponse.md delete mode 100644 src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md delete mode 100644 src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md delete mode 100644 src/pages/docs/reference/processor/interfaces/HandlersRecord.md delete mode 100644 src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md delete mode 100644 src/pages/docs/reference/processor/type-aliases/BlockHandler.md delete mode 100644 src/pages/docs/reference/processor/type-aliases/ClientTransaction.md delete mode 100644 src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md delete mode 100644 src/pages/docs/reference/protocol/README.md delete mode 100644 src/pages/docs/reference/protocol/_meta.tsx delete mode 100644 src/pages/docs/reference/protocol/classes/AccountState.md delete mode 100644 src/pages/docs/reference/protocol/classes/AccountStateHook.md delete mode 100644 src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md delete mode 100644 src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md delete mode 100644 src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md delete mode 100644 src/pages/docs/reference/protocol/classes/BlockHeightHook.md delete mode 100644 src/pages/docs/reference/protocol/classes/BlockProver.md delete mode 100644 src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md delete mode 100644 src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md delete mode 100644 src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md delete mode 100644 src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md delete mode 100644 src/pages/docs/reference/protocol/classes/BridgeContract.md delete mode 100644 src/pages/docs/reference/protocol/classes/BridgeContractBase.md delete mode 100644 src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md delete mode 100644 src/pages/docs/reference/protocol/classes/ContractModule.md delete mode 100644 src/pages/docs/reference/protocol/classes/CurrentBlock.md delete mode 100644 src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md delete mode 100644 src/pages/docs/reference/protocol/classes/Deposit.md delete mode 100644 src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md delete mode 100644 src/pages/docs/reference/protocol/classes/DispatchSmartContract.md delete mode 100644 src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md delete mode 100644 src/pages/docs/reference/protocol/classes/DynamicBlockProof.md delete mode 100644 src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md delete mode 100644 src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md delete mode 100644 src/pages/docs/reference/protocol/classes/MethodPublicOutput.md delete mode 100644 src/pages/docs/reference/protocol/classes/MethodVKConfigData.md delete mode 100644 src/pages/docs/reference/protocol/classes/MinaActions.md delete mode 100644 src/pages/docs/reference/protocol/classes/MinaActionsHashList.md delete mode 100644 src/pages/docs/reference/protocol/classes/MinaEvents.md delete mode 100644 src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md delete mode 100644 src/pages/docs/reference/protocol/classes/NetworkState.md delete mode 100644 src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md delete mode 100644 src/pages/docs/reference/protocol/classes/Option.md delete mode 100644 src/pages/docs/reference/protocol/classes/OptionBase.md delete mode 100644 src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md delete mode 100644 src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md delete mode 100644 src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md delete mode 100644 src/pages/docs/reference/protocol/classes/Path.md delete mode 100644 src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md delete mode 100644 src/pages/docs/reference/protocol/classes/PreviousBlock.md delete mode 100644 src/pages/docs/reference/protocol/classes/Protocol.md delete mode 100644 src/pages/docs/reference/protocol/classes/ProtocolModule.md delete mode 100644 src/pages/docs/reference/protocol/classes/ProvableBlockHook.md delete mode 100644 src/pages/docs/reference/protocol/classes/ProvableHashList.md delete mode 100644 src/pages/docs/reference/protocol/classes/ProvableOption.md delete mode 100644 src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md delete mode 100644 src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md delete mode 100644 src/pages/docs/reference/protocol/classes/ProvableStateTransition.md delete mode 100644 src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md delete mode 100644 src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md delete mode 100644 src/pages/docs/reference/protocol/classes/PublicKeyOption.md delete mode 100644 src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md delete mode 100644 src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md delete mode 100644 src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md delete mode 100644 src/pages/docs/reference/protocol/classes/RuntimeTransaction.md delete mode 100644 src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md delete mode 100644 src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md delete mode 100644 src/pages/docs/reference/protocol/classes/SettlementContractModule.md delete mode 100644 src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md delete mode 100644 src/pages/docs/reference/protocol/classes/SettlementSmartContract.md delete mode 100644 src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md delete mode 100644 src/pages/docs/reference/protocol/classes/SignedTransaction.md delete mode 100644 src/pages/docs/reference/protocol/classes/State.md delete mode 100644 src/pages/docs/reference/protocol/classes/StateMap.md delete mode 100644 src/pages/docs/reference/protocol/classes/StateServiceProvider.md delete mode 100644 src/pages/docs/reference/protocol/classes/StateTransition.md delete mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md delete mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionProver.md delete mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md delete mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md delete mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md delete mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md delete mode 100644 src/pages/docs/reference/protocol/classes/StateTransitionType.md delete mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md delete mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md delete mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md delete mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeTree.md delete mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md delete mode 100644 src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md delete mode 100644 src/pages/docs/reference/protocol/classes/TokenMapping.md delete mode 100644 src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md delete mode 100644 src/pages/docs/reference/protocol/classes/UInt64Option.md delete mode 100644 src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md delete mode 100644 src/pages/docs/reference/protocol/classes/VKTree.md delete mode 100644 src/pages/docs/reference/protocol/classes/VKTreeWitness.md delete mode 100644 src/pages/docs/reference/protocol/classes/WithPath.md delete mode 100644 src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md delete mode 100644 src/pages/docs/reference/protocol/classes/Withdrawal.md delete mode 100644 src/pages/docs/reference/protocol/functions/assert.md delete mode 100644 src/pages/docs/reference/protocol/functions/emptyActions.md delete mode 100644 src/pages/docs/reference/protocol/functions/emptyEvents.md delete mode 100644 src/pages/docs/reference/protocol/functions/notInCircuit.md delete mode 100644 src/pages/docs/reference/protocol/functions/protocolState.md delete mode 100644 src/pages/docs/reference/protocol/functions/reduceStateTransitions.md delete mode 100644 src/pages/docs/reference/protocol/functions/singleFieldToString.md delete mode 100644 src/pages/docs/reference/protocol/functions/stringToField.md delete mode 100644 src/pages/docs/reference/protocol/globals.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/BlockProvable.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/BlockProverState.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/BlockProverType.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/DispatchContractType.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/RuntimeLike.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/SettlementContractType.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md delete mode 100644 src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/BlockProof.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/ReturnType.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md delete mode 100644 src/pages/docs/reference/protocol/type-aliases/Subclass.md delete mode 100644 src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md delete mode 100644 src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md delete mode 100644 src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md delete mode 100644 src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md delete mode 100644 src/pages/docs/reference/protocol/variables/ProtocolConstants.md delete mode 100644 src/pages/docs/reference/protocol/variables/treeFeeHeight.md delete mode 100644 src/pages/docs/reference/sdk/README.md delete mode 100644 src/pages/docs/reference/sdk/_meta.tsx delete mode 100644 src/pages/docs/reference/sdk/classes/AppChain.md delete mode 100644 src/pages/docs/reference/sdk/classes/AppChainModule.md delete mode 100644 src/pages/docs/reference/sdk/classes/AppChainTransaction.md delete mode 100644 src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md delete mode 100644 src/pages/docs/reference/sdk/classes/AuroSigner.md delete mode 100644 src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md delete mode 100644 src/pages/docs/reference/sdk/classes/ClientAppChain.md delete mode 100644 src/pages/docs/reference/sdk/classes/GraphqlClient.md delete mode 100644 src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md delete mode 100644 src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md delete mode 100644 src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md delete mode 100644 src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md delete mode 100644 src/pages/docs/reference/sdk/classes/InMemorySigner.md delete mode 100644 src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md delete mode 100644 src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md delete mode 100644 src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md delete mode 100644 src/pages/docs/reference/sdk/classes/TestingAppChain.md delete mode 100644 src/pages/docs/reference/sdk/globals.md delete mode 100644 src/pages/docs/reference/sdk/interfaces/AppChainConfig.md delete mode 100644 src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md delete mode 100644 src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md delete mode 100644 src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md delete mode 100644 src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md delete mode 100644 src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md delete mode 100644 src/pages/docs/reference/sdk/interfaces/Signer.md delete mode 100644 src/pages/docs/reference/sdk/interfaces/TransactionSender.md delete mode 100644 src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md delete mode 100644 src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md delete mode 100644 src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md delete mode 100644 src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md delete mode 100644 src/pages/docs/reference/sdk/variables/randomFeeRecipient.md delete mode 100644 src/pages/docs/reference/sequencer/README.md delete mode 100644 src/pages/docs/reference/sequencer/_meta.tsx delete mode 100644 src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md delete mode 100644 src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/BatchProducerModule.md delete mode 100644 src/pages/docs/reference/sequencer/classes/BlockProducerModule.md delete mode 100644 src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md delete mode 100644 src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md delete mode 100644 src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md delete mode 100644 src/pages/docs/reference/sequencer/classes/CachedStateService.md delete mode 100644 src/pages/docs/reference/sequencer/classes/CompressedSignature.md delete mode 100644 src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md delete mode 100644 src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/DummyStateService.md delete mode 100644 src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/Flow.md delete mode 100644 src/pages/docs/reference/sequencer/classes/FlowCreator.md delete mode 100644 src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md delete mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md delete mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md delete mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md delete mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md delete mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md delete mode 100644 src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md delete mode 100644 src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md delete mode 100644 src/pages/docs/reference/sequencer/classes/ListenerList.md delete mode 100644 src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md delete mode 100644 src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md delete mode 100644 src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md delete mode 100644 src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md delete mode 100644 src/pages/docs/reference/sequencer/classes/MinaSimulationService.md delete mode 100644 src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md delete mode 100644 src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md delete mode 100644 src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md delete mode 100644 src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/NewBlockTask.md delete mode 100644 src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/PendingTransaction.md delete mode 100644 src/pages/docs/reference/sequencer/classes/PreFilledStateService.md delete mode 100644 src/pages/docs/reference/sequencer/classes/PrivateMempool.md delete mode 100644 src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md delete mode 100644 src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md delete mode 100644 src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md delete mode 100644 src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/Sequencer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/SequencerModule.md delete mode 100644 src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md delete mode 100644 src/pages/docs/reference/sequencer/classes/SettlementModule.md delete mode 100644 src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md delete mode 100644 src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md delete mode 100644 src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md delete mode 100644 src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md delete mode 100644 src/pages/docs/reference/sequencer/classes/StateTransitionTask.md delete mode 100644 src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md delete mode 100644 src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md delete mode 100644 src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md delete mode 100644 src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md delete mode 100644 src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md delete mode 100644 src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/TransactionTraceService.md delete mode 100644 src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md delete mode 100644 src/pages/docs/reference/sequencer/classes/UntypedOption.md delete mode 100644 src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md delete mode 100644 src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md delete mode 100644 src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md delete mode 100644 src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md delete mode 100644 src/pages/docs/reference/sequencer/classes/WithdrawalKey.md delete mode 100644 src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md delete mode 100644 src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md delete mode 100644 src/pages/docs/reference/sequencer/functions/closeable.md delete mode 100644 src/pages/docs/reference/sequencer/functions/distinct.md delete mode 100644 src/pages/docs/reference/sequencer/functions/distinctByPredicate.md delete mode 100644 src/pages/docs/reference/sequencer/functions/distinctByString.md delete mode 100644 src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md delete mode 100644 src/pages/docs/reference/sequencer/functions/sequencerModule.md delete mode 100644 src/pages/docs/reference/sequencer/globals.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BaseLayer.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/Batch.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BatchStorage.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/Block.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockConfig.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockQueue.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockResult.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockStorage.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockTrace.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/Closeable.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/Database.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/Mempool.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/MessageStorage.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/Sequenceable.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/Settlement.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/StateEntry.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/Task.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/TaskPayload.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/TaskQueue.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md delete mode 100644 src/pages/docs/reference/sequencer/interfaces/TxEvents.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/PairTuple.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/PickByType.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/Query.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/StateRecord.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/TypedClass.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md delete mode 100644 src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md delete mode 100644 src/pages/docs/reference/sequencer/variables/Block.md delete mode 100644 src/pages/docs/reference/sequencer/variables/BlockWithResult.md delete mode 100644 src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md delete mode 100644 src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md delete mode 100644 src/pages/docs/reference/stack/README.md delete mode 100644 src/pages/docs/reference/stack/_meta.tsx delete mode 100644 src/pages/docs/reference/stack/classes/TestBalances.md delete mode 100644 src/pages/docs/reference/stack/functions/startServer.md delete mode 100644 src/pages/docs/reference/stack/globals.md diff --git a/src/pages/docs/reference/_meta.tsx b/src/pages/docs/reference/_meta.tsx deleted file mode 100644 index fc34595..0000000 --- a/src/pages/docs/reference/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "api": "@proto-kit/api","common": "@proto-kit/common","deployment": "@proto-kit/deployment","indexer": "@proto-kit/indexer","library": "@proto-kit/library","module": "@proto-kit/module","persistance": "@proto-kit/persistance","processor": "@proto-kit/processor","protocol": "@proto-kit/protocol","sdk": "@proto-kit/sdk","sequencer": "@proto-kit/sequencer","stack": "@proto-kit/stack" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/api/README.md b/src/pages/docs/reference/api/README.md deleted file mode 100644 index 5415109..0000000 --- a/src/pages/docs/reference/api/README.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "@proto-kit/api" ---- - -**@proto-kit/api** - -*** - -[Documentation](../../README.md) / @proto-kit/api - -# @proto-kit/api - -## Classes - -- [AdvancedNodeStatusResolver](classes/AdvancedNodeStatusResolver.md) -- [BatchStorageResolver](classes/BatchStorageResolver.md) -- [BlockModel](classes/BlockModel.md) -- [BlockResolver](classes/BlockResolver.md) -- [ComputedBlockModel](classes/ComputedBlockModel.md) -- [GraphqlModule](classes/GraphqlModule.md) -- [GraphqlSequencerModule](classes/GraphqlSequencerModule.md) -- [GraphqlServer](classes/GraphqlServer.md) -- [MempoolResolver](classes/MempoolResolver.md) -- [MerkleWitnessDTO](classes/MerkleWitnessDTO.md) -- [MerkleWitnessResolver](classes/MerkleWitnessResolver.md) -- [NodeInformationObject](classes/NodeInformationObject.md) -- [NodeStatusObject](classes/NodeStatusObject.md) -- [NodeStatusResolver](classes/NodeStatusResolver.md) -- [NodeStatusService](classes/NodeStatusService.md) -- [ProcessInformationObject](classes/ProcessInformationObject.md) -- [QueryGraphqlModule](classes/QueryGraphqlModule.md) -- [ResolverFactoryGraphqlModule](classes/ResolverFactoryGraphqlModule.md) -- [SchemaGeneratingGraphqlModule](classes/SchemaGeneratingGraphqlModule.md) -- [Signature](classes/Signature.md) -- [TransactionObject](classes/TransactionObject.md) -- [VanillaGraphqlModules](classes/VanillaGraphqlModules.md) - -## Interfaces - -- [GraphqlModulesDefintion](interfaces/GraphqlModulesDefintion.md) -- [NodeInformation](interfaces/NodeInformation.md) -- [ProcessInformation](interfaces/ProcessInformation.md) - -## Type Aliases - -- [GraphqlModulesRecord](type-aliases/GraphqlModulesRecord.md) -- [VanillaGraphqlModulesRecord](type-aliases/VanillaGraphqlModulesRecord.md) - -## Functions - -- [graphqlModule](functions/graphqlModule.md) diff --git a/src/pages/docs/reference/api/_meta.tsx b/src/pages/docs/reference/api/_meta.tsx deleted file mode 100644 index a31554d..0000000 --- a/src/pages/docs/reference/api/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md b/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md deleted file mode 100644 index 10abe78..0000000 --- a/src/pages/docs/reference/api/classes/AdvancedNodeStatusResolver.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: AdvancedNodeStatusResolver ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / AdvancedNodeStatusResolver - -# Class: AdvancedNodeStatusResolver - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L74) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`GraphqlModule`](GraphqlModule.md) - -## Constructors - -### new AdvancedNodeStatusResolver() - -> **new AdvancedNodeStatusResolver**(`nodeStatusService`): [`AdvancedNodeStatusResolver`](AdvancedNodeStatusResolver.md) - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L75) - -#### Parameters - -##### nodeStatusService - -[`NodeStatusService`](NodeStatusService.md) - -#### Returns - -[`AdvancedNodeStatusResolver`](AdvancedNodeStatusResolver.md) - -#### Overrides - -[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) - -*** - -### node() - -> **node**(): `Promise`\<[`NodeStatusObject`](NodeStatusObject.md)\> - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L83) - -#### Returns - -`Promise`\<[`NodeStatusObject`](NodeStatusObject.md)\> diff --git a/src/pages/docs/reference/api/classes/BatchStorageResolver.md b/src/pages/docs/reference/api/classes/BatchStorageResolver.md deleted file mode 100644 index ed4960a..0000000 --- a/src/pages/docs/reference/api/classes/BatchStorageResolver.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: BatchStorageResolver ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / BatchStorageResolver - -# Class: BatchStorageResolver - -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L41) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`GraphqlModule`](GraphqlModule.md) - -## Constructors - -### new BatchStorageResolver() - -> **new BatchStorageResolver**(`batchStorage`, `blockResolver`): [`BatchStorageResolver`](BatchStorageResolver.md) - -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L43) - -#### Parameters - -##### batchStorage - -[`BatchStorage`](../../sequencer/interfaces/BatchStorage.md) & [`HistoricalBatchStorage`](../../sequencer/interfaces/HistoricalBatchStorage.md) - -##### blockResolver - -[`BlockResolver`](BlockResolver.md) - -#### Returns - -[`BatchStorageResolver`](BatchStorageResolver.md) - -#### Overrides - -[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) - -## Methods - -### batches() - -> **batches**(`height`): `Promise`\<`undefined` \| [`ComputedBlockModel`](ComputedBlockModel.md)\> - -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L56) - -#### Parameters - -##### height - -`undefined` | `number` - -#### Returns - -`Promise`\<`undefined` \| [`ComputedBlockModel`](ComputedBlockModel.md)\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) diff --git a/src/pages/docs/reference/api/classes/BlockModel.md b/src/pages/docs/reference/api/classes/BlockModel.md deleted file mode 100644 index 980f4e8..0000000 --- a/src/pages/docs/reference/api/classes/BlockModel.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: BlockModel ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / BlockModel - -# Class: BlockModel - -Defined in: [api/src/graphql/modules/BlockResolver.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L14) - -## Properties - -### hash - -> **hash**: `string` - -Defined in: [api/src/graphql/modules/BlockResolver.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L32) - -*** - -### height - -> **height**: `number` - -Defined in: [api/src/graphql/modules/BlockResolver.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L38) - -*** - -### previousBlockHash - -> **previousBlockHash**: `undefined` \| `string` - -Defined in: [api/src/graphql/modules/BlockResolver.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L35) - -*** - -### transactionsHash - -> **transactionsHash**: `string` - -Defined in: [api/src/graphql/modules/BlockResolver.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L44) - -*** - -### txs - -> **txs**: `BatchTransactionModel`[] - -Defined in: [api/src/graphql/modules/BlockResolver.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L41) - -## Methods - -### fromServiceLayerModel() - -> `static` **fromServiceLayerModel**(`block`): [`BlockModel`](BlockModel.md) - -Defined in: [api/src/graphql/modules/BlockResolver.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L15) - -#### Parameters - -##### block - -[`Block`](../../sequencer/interfaces/Block.md) - -#### Returns - -[`BlockModel`](BlockModel.md) diff --git a/src/pages/docs/reference/api/classes/BlockResolver.md b/src/pages/docs/reference/api/classes/BlockResolver.md deleted file mode 100644 index 879ec83..0000000 --- a/src/pages/docs/reference/api/classes/BlockResolver.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: BlockResolver ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / BlockResolver - -# Class: BlockResolver - -Defined in: [api/src/graphql/modules/BlockResolver.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L62) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`GraphqlModule`](GraphqlModule.md)\<`object`\> - -## Constructors - -### new BlockResolver() - -> **new BlockResolver**(`blockStorage`): [`BlockResolver`](BlockResolver.md) - -Defined in: [api/src/graphql/modules/BlockResolver.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L63) - -#### Parameters - -##### blockStorage - -[`HistoricalBlockStorage`](../../sequencer/interfaces/HistoricalBlockStorage.md) & [`BlockStorage`](../../sequencer/interfaces/BlockStorage.md) - -#### Returns - -[`BlockResolver`](BlockResolver.md) - -#### Overrides - -[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `object` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) - -## Methods - -### block() - -> **block**(`height`, `hash`): `Promise`\<`undefined` \| [`BlockModel`](BlockModel.md)\> - -Defined in: [api/src/graphql/modules/BlockResolver.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BlockResolver.ts#L75) - -#### Parameters - -##### height - -`undefined` | `number` - -##### hash - -`undefined` | `string` - -#### Returns - -`Promise`\<`undefined` \| [`BlockModel`](BlockModel.md)\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) diff --git a/src/pages/docs/reference/api/classes/ComputedBlockModel.md b/src/pages/docs/reference/api/classes/ComputedBlockModel.md deleted file mode 100644 index aba43e2..0000000 --- a/src/pages/docs/reference/api/classes/ComputedBlockModel.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: ComputedBlockModel ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / ComputedBlockModel - -# Class: ComputedBlockModel - -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L15) - -## Constructors - -### new ComputedBlockModel() - -> **new ComputedBlockModel**(`blocks`, `proof`): [`ComputedBlockModel`](ComputedBlockModel.md) - -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L34) - -#### Parameters - -##### blocks - -[`BlockModel`](BlockModel.md)[] - -##### proof - -`string` - -#### Returns - -[`ComputedBlockModel`](ComputedBlockModel.md) - -## Properties - -### blocks - -> **blocks**: [`BlockModel`](BlockModel.md)[] - -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L29) - -*** - -### proof - -> **proof**: `string` - -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L32) - -## Methods - -### fromServiceLayerModel() - -> `static` **fromServiceLayerModel**(`__namedParameters`, `blocks`): [`ComputedBlockModel`](ComputedBlockModel.md) - -Defined in: [api/src/graphql/modules/BatchStorageResolver.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/BatchStorageResolver.ts#L16) - -#### Parameters - -##### \_\_namedParameters - -[`Batch`](../../sequencer/interfaces/Batch.md) - -##### blocks - -(`undefined` \| [`BlockModel`](BlockModel.md))[] - -#### Returns - -[`ComputedBlockModel`](ComputedBlockModel.md) diff --git a/src/pages/docs/reference/api/classes/GraphqlModule.md b/src/pages/docs/reference/api/classes/GraphqlModule.md deleted file mode 100644 index d5425ed..0000000 --- a/src/pages/docs/reference/api/classes/GraphqlModule.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: GraphqlModule ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / GraphqlModule - -# Class: `abstract` GraphqlModule\ - -Defined in: [api/src/graphql/GraphqlModule.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L8) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> - -## Extended by - -- [`MempoolResolver`](MempoolResolver.md) -- [`BatchStorageResolver`](BatchStorageResolver.md) -- [`BlockResolver`](BlockResolver.md) -- [`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md) -- [`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md) -- [`NodeStatusResolver`](NodeStatusResolver.md) -- [`AdvancedNodeStatusResolver`](AdvancedNodeStatusResolver.md) -- [`MerkleWitnessResolver`](MerkleWitnessResolver.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -## Constructors - -### new GraphqlModule() - -> **new GraphqlModule**\<`Config`\>(): [`GraphqlModule`](GraphqlModule.md)\<`Config`\> - -Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L11) - -#### Returns - -[`GraphqlModule`](GraphqlModule.md)\<`Config`\> - -#### Overrides - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) diff --git a/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md b/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md deleted file mode 100644 index f320979..0000000 --- a/src/pages/docs/reference/api/classes/GraphqlSequencerModule.md +++ /dev/null @@ -1,662 +0,0 @@ ---- -title: GraphqlSequencerModule ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / GraphqlSequencerModule - -# Class: GraphqlSequencerModule\ - -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L33) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`GraphQLModules`\> - -## Type Parameters - -• **GraphQLModules** *extends* [`GraphqlModulesRecord`](../type-aliases/GraphqlModulesRecord.md) - -## Implements - -- [`Configurable`](../../common/interfaces/Configurable.md)\<`unknown`\> -- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`unknown`\> -- [`Closeable`](../../sequencer/interfaces/Closeable.md) - -## Constructors - -### new GraphqlSequencerModule() - -> **new GraphqlSequencerModule**\<`GraphQLModules`\>(`definition`): [`GraphqlSequencerModule`](GraphqlSequencerModule.md)\<`GraphQLModules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:68 - -#### Parameters - -##### definition - -[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`GraphQLModules`\> - -#### Returns - -[`GraphqlSequencerModule`](GraphqlSequencerModule.md)\<`GraphQLModules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`GraphQLModules`\> - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Implementation of - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) - -*** - -### definition - -> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`GraphQLModules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:60 - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Implementation of - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` - -Defined in: common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) - -*** - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:98](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L98) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Closeable`](../../sequencer/interfaces/Closeable.md).[`close`](../../sequencer/interfaces/Closeable.md#close) - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`GraphQLModules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`GraphQLModules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L49) - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Implementation of - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) - -*** - -### decorateModule() - -> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:134 - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`GraphQLModules`\> - -##### containedModule - -`InstanceType`\<`GraphQLModules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`GraphQLModules`\>\]\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`GraphQLModules`\>[] - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` - -Defined in: common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -`GraphQLModules` - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`GraphQLModules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -`GraphQLModules` - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`GraphQLModules`\>\[`KeyType`\]\> - -Defined in: common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`GraphQLModules`\>\[`KeyType`\]\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L55) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`GraphQLModules`\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`GraphQLModules`\>(`definition`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](GraphqlSequencerModule.md)\<`GraphQLModules`\>\> - -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L37) - -#### Type Parameters - -• **GraphQLModules** *extends* [`GraphqlModulesRecord`](../type-aliases/GraphqlModulesRecord.md) - -#### Parameters - -##### definition - -[`GraphqlModulesDefintion`](../interfaces/GraphqlModulesDefintion.md)\<`GraphQLModules`\> - -#### Returns - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](GraphqlSequencerModule.md)\<`GraphQLModules`\>\> diff --git a/src/pages/docs/reference/api/classes/GraphqlServer.md b/src/pages/docs/reference/api/classes/GraphqlServer.md deleted file mode 100644 index 0874a11..0000000 --- a/src/pages/docs/reference/api/classes/GraphqlServer.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -title: GraphqlServer ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / GraphqlServer - -# Class: GraphqlServer - -Defined in: [api/src/graphql/GraphqlServer.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L30) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`GraphqlServerOptions`\> - -## Constructors - -### new GraphqlServer() - -> **new GraphqlServer**(): [`GraphqlServer`](GraphqlServer.md) - -#### Returns - -[`GraphqlServer`](GraphqlServer.md) - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`constructor`](../../sequencer/classes/SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `GraphqlServerOptions` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> - -Defined in: sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`presets`](../../sequencer/classes/SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [api/src/graphql/GraphqlServer.ts:148](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L148) - -#### Returns - -`Promise`\<`void`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) - -*** - -### registerModule() - -> **registerModule**(`module`): `void` - -Defined in: [api/src/graphql/GraphqlServer.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L55) - -#### Parameters - -##### module - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlModule`](GraphqlModule.md)\<`unknown`\>\> - -#### Returns - -`void` - -*** - -### registerResolvers() - -> **registerResolvers**(`resolvers`): `void` - -Defined in: [api/src/graphql/GraphqlServer.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L63) - -#### Parameters - -##### resolvers - -`NonEmptyArray`\<`Function`\> - -#### Returns - -`void` - -*** - -### registerSchema() - -> **registerSchema**(`schema`): `void` - -Defined in: [api/src/graphql/GraphqlServer.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L59) - -#### Parameters - -##### schema - -`GraphQLSchema` - -#### Returns - -`void` - -*** - -### setContainer() - -> **setContainer**(`container`): `void` - -Defined in: [api/src/graphql/GraphqlServer.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L43) - -#### Parameters - -##### container - -`DependencyContainer` - -#### Returns - -`void` - -*** - -### setContext() - -> **setContext**(`context`): `void` - -Defined in: [api/src/graphql/GraphqlServer.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L71) - -#### Parameters - -##### context - -#### Returns - -`void` - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [api/src/graphql/GraphqlServer.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L75) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) - -*** - -### startServer() - -> **startServer**(): `Promise`\<`void`\> - -Defined in: [api/src/graphql/GraphqlServer.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlServer.ts#L79) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/api/classes/MempoolResolver.md b/src/pages/docs/reference/api/classes/MempoolResolver.md deleted file mode 100644 index 148cfb3..0000000 --- a/src/pages/docs/reference/api/classes/MempoolResolver.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: MempoolResolver ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / MempoolResolver - -# Class: MempoolResolver - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:121](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L121) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`GraphqlModule`](GraphqlModule.md) - -## Constructors - -### new MempoolResolver() - -> **new MempoolResolver**(`mempool`, `transactionStorage`): [`MempoolResolver`](MempoolResolver.md) - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L122) - -#### Parameters - -##### mempool - -[`Mempool`](../../sequencer/interfaces/Mempool.md) - -##### transactionStorage - -[`TransactionStorage`](../../sequencer/interfaces/TransactionStorage.md) - -#### Returns - -[`MempoolResolver`](MempoolResolver.md) - -#### Overrides - -[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) - -*** - -### submitTx() - -> **submitTx**(`tx`): `Promise`\<`string`\> - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:133](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L133) - -#### Parameters - -##### tx - -[`TransactionObject`](TransactionObject.md) - -#### Returns - -`Promise`\<`string`\> - -*** - -### transactions() - -> **transactions**(): `Promise`\<`string`[]\> - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:169](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L169) - -#### Returns - -`Promise`\<`string`[]\> - -*** - -### transactionState() - -> **transactionState**(`hash`): `Promise`\<`InclusionStatus`\> - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:144](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L144) - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<`InclusionStatus`\> diff --git a/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md b/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md deleted file mode 100644 index c592148..0000000 --- a/src/pages/docs/reference/api/classes/MerkleWitnessDTO.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: MerkleWitnessDTO ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / MerkleWitnessDTO - -# Class: MerkleWitnessDTO - -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L13) - -## Constructors - -### new MerkleWitnessDTO() - -> **new MerkleWitnessDTO**(`siblings`, `isLefts`): [`MerkleWitnessDTO`](MerkleWitnessDTO.md) - -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L20) - -#### Parameters - -##### siblings - -`string`[] - -##### isLefts - -`boolean`[] - -#### Returns - -[`MerkleWitnessDTO`](MerkleWitnessDTO.md) - -## Properties - -### isLefts - -> **isLefts**: `boolean`[] - -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L31) - -*** - -### siblings - -> **siblings**: `string`[] - -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L27) - -## Methods - -### fromServiceLayerObject() - -> `static` **fromServiceLayerObject**(`witness`): [`MerkleWitnessDTO`](MerkleWitnessDTO.md) - -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L14) - -#### Parameters - -##### witness - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) - -#### Returns - -[`MerkleWitnessDTO`](MerkleWitnessDTO.md) diff --git a/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md b/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md deleted file mode 100644 index 6f5d9ad..0000000 --- a/src/pages/docs/reference/api/classes/MerkleWitnessResolver.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: MerkleWitnessResolver ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / MerkleWitnessResolver - -# Class: MerkleWitnessResolver - -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L35) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`GraphqlModule`](GraphqlModule.md)\<`object`\> - -## Constructors - -### new MerkleWitnessResolver() - -> **new MerkleWitnessResolver**(`treeStore`): [`MerkleWitnessResolver`](MerkleWitnessResolver.md) - -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L36) - -#### Parameters - -##### treeStore - -[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md) - -#### Returns - -[`MerkleWitnessResolver`](MerkleWitnessResolver.md) - -#### Overrides - -[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `object` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) - -*** - -### witness() - -> **witness**(`path`): `Promise`\<[`MerkleWitnessDTO`](MerkleWitnessDTO.md)\> - -Defined in: [api/src/graphql/modules/MerkleWitnessResolver.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MerkleWitnessResolver.ts#L46) - -#### Parameters - -##### path - -`string` - -#### Returns - -`Promise`\<[`MerkleWitnessDTO`](MerkleWitnessDTO.md)\> diff --git a/src/pages/docs/reference/api/classes/NodeInformationObject.md b/src/pages/docs/reference/api/classes/NodeInformationObject.md deleted file mode 100644 index 4e7ec6d..0000000 --- a/src/pages/docs/reference/api/classes/NodeInformationObject.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: NodeInformationObject ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / NodeInformationObject - -# Class: NodeInformationObject - -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L10) - -## Constructors - -### new NodeInformationObject() - -> **new NodeInformationObject**(`blockHeight`, `batchHeight`): [`NodeInformationObject`](NodeInformationObject.md) - -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L21) - -#### Parameters - -##### blockHeight - -`number` - -##### batchHeight - -`number` - -#### Returns - -[`NodeInformationObject`](NodeInformationObject.md) - -## Properties - -### batchHeight - -> **batchHeight**: `number` - -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L19) - -*** - -### blockHeight - -> **blockHeight**: `number` - -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L16) - -## Methods - -### fromServiceLayerModel() - -> `static` **fromServiceLayerModel**(`status`): [`NodeInformationObject`](NodeInformationObject.md) - -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L11) - -#### Parameters - -##### status - -[`NodeInformation`](../interfaces/NodeInformation.md) - -#### Returns - -[`NodeInformationObject`](NodeInformationObject.md) diff --git a/src/pages/docs/reference/api/classes/NodeStatusObject.md b/src/pages/docs/reference/api/classes/NodeStatusObject.md deleted file mode 100644 index 8656250..0000000 --- a/src/pages/docs/reference/api/classes/NodeStatusObject.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: NodeStatusObject ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / NodeStatusObject - -# Class: NodeStatusObject - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L53) - -## Constructors - -### new NodeStatusObject() - -> **new NodeStatusObject**(`node`, `process`): [`NodeStatusObject`](NodeStatusObject.md) - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L67) - -#### Parameters - -##### node - -[`NodeInformation`](../interfaces/NodeInformation.md) - -##### process - -[`ProcessInformation`](../interfaces/ProcessInformation.md) - -#### Returns - -[`NodeStatusObject`](NodeStatusObject.md) - -## Properties - -### node - -> **node**: [`NodeInformationObject`](NodeInformationObject.md) - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L65) - -*** - -### process - -> **process**: [`ProcessInformationObject`](ProcessInformationObject.md) - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L62) - -## Methods - -### fromServiceLayerModel() - -> `static` **fromServiceLayerModel**(`node`, `process`): [`NodeStatusObject`](NodeStatusObject.md) - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L54) - -#### Parameters - -##### node - -[`NodeInformation`](../interfaces/NodeInformation.md) - -##### process - -[`ProcessInformation`](../interfaces/ProcessInformation.md) - -#### Returns - -[`NodeStatusObject`](NodeStatusObject.md) diff --git a/src/pages/docs/reference/api/classes/NodeStatusResolver.md b/src/pages/docs/reference/api/classes/NodeStatusResolver.md deleted file mode 100644 index f1563c0..0000000 --- a/src/pages/docs/reference/api/classes/NodeStatusResolver.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: NodeStatusResolver ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / NodeStatusResolver - -# Class: NodeStatusResolver - -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L28) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`GraphqlModule`](GraphqlModule.md) - -## Constructors - -### new NodeStatusResolver() - -> **new NodeStatusResolver**(`nodeStatusService`): [`NodeStatusResolver`](NodeStatusResolver.md) - -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L29) - -#### Parameters - -##### nodeStatusService - -[`NodeStatusService`](NodeStatusService.md) - -#### Returns - -[`NodeStatusResolver`](NodeStatusResolver.md) - -#### Overrides - -[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) - -*** - -### node() - -> **node**(): `Promise`\<[`NodeInformationObject`](NodeInformationObject.md)\> - -Defined in: [api/src/graphql/modules/NodeStatusResolver.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/NodeStatusResolver.ts#L36) - -#### Returns - -`Promise`\<[`NodeInformationObject`](NodeInformationObject.md)\> diff --git a/src/pages/docs/reference/api/classes/NodeStatusService.md b/src/pages/docs/reference/api/classes/NodeStatusService.md deleted file mode 100644 index 71464ef..0000000 --- a/src/pages/docs/reference/api/classes/NodeStatusService.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: NodeStatusService ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / NodeStatusService - -# Class: NodeStatusService - -Defined in: [api/src/graphql/services/NodeStatusService.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L27) - -## Constructors - -### new NodeStatusService() - -> **new NodeStatusService**(`blockStorage`, `batchStorage`, `settlementStorage`): [`NodeStatusService`](NodeStatusService.md) - -Defined in: [api/src/graphql/services/NodeStatusService.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L28) - -#### Parameters - -##### blockStorage - -[`BlockStorage`](../../sequencer/interfaces/BlockStorage.md) - -##### batchStorage - -[`BatchStorage`](../../sequencer/interfaces/BatchStorage.md) - -##### settlementStorage - -[`SettlementStorage`](../../sequencer/interfaces/SettlementStorage.md) - -#### Returns - -[`NodeStatusService`](NodeStatusService.md) - -## Methods - -### getNodeInformation() - -> **getNodeInformation**(): `Promise`\<[`NodeInformation`](../interfaces/NodeInformation.md)\> - -Defined in: [api/src/graphql/services/NodeStatusService.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L56) - -#### Returns - -`Promise`\<[`NodeInformation`](../interfaces/NodeInformation.md)\> - -*** - -### getProcessInfo() - -> **getProcessInfo**(): [`ProcessInformation`](../interfaces/ProcessInformation.md) - -Defined in: [api/src/graphql/services/NodeStatusService.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L36) - -#### Returns - -[`ProcessInformation`](../interfaces/ProcessInformation.md) diff --git a/src/pages/docs/reference/api/classes/ProcessInformationObject.md b/src/pages/docs/reference/api/classes/ProcessInformationObject.md deleted file mode 100644 index 5f1d1fa..0000000 --- a/src/pages/docs/reference/api/classes/ProcessInformationObject.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: ProcessInformationObject ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / ProcessInformationObject - -# Class: ProcessInformationObject - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L13) - -## Constructors - -### new ProcessInformationObject() - -> **new ProcessInformationObject**(`process`): [`ProcessInformationObject`](ProcessInformationObject.md) - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L39) - -#### Parameters - -##### process - -[`ProcessInformation`](../interfaces/ProcessInformation.md) - -#### Returns - -[`ProcessInformationObject`](ProcessInformationObject.md) - -## Properties - -### arch - -> **arch**: `string` - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L34) - -*** - -### headTotal - -> **headTotal**: `number` - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L28) - -*** - -### headUsed - -> **headUsed**: `number` - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L25) - -*** - -### nodeVersion - -> **nodeVersion**: `string` - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L31) - -*** - -### platform - -> **platform**: `string` - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L37) - -*** - -### uptime - -> **uptime**: `number` - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L19) - -*** - -### uptimeHumanReadable - -> **uptimeHumanReadable**: `string` - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L22) - -## Methods - -### fromServiceLayerModel() - -> `static` **fromServiceLayerModel**(`process`): [`ProcessInformationObject`](ProcessInformationObject.md) - -Defined in: [api/src/graphql/modules/AdvancedNodeStatusResolver.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/AdvancedNodeStatusResolver.ts#L14) - -#### Parameters - -##### process - -[`ProcessInformation`](../interfaces/ProcessInformation.md) - -#### Returns - -[`ProcessInformationObject`](ProcessInformationObject.md) diff --git a/src/pages/docs/reference/api/classes/QueryGraphqlModule.md b/src/pages/docs/reference/api/classes/QueryGraphqlModule.md deleted file mode 100644 index ab6a32b..0000000 --- a/src/pages/docs/reference/api/classes/QueryGraphqlModule.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -title: QueryGraphqlModule ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / QueryGraphqlModule - -# Class: QueryGraphqlModule\ - -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L69) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md) - -## Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -## Constructors - -### new QueryGraphqlModule() - -> **new QueryGraphqlModule**\<`RuntimeModules`\>(`queryTransportModule`, `networkStateTransportModule`, `runtime`, `protocol`, `blockStorage`): [`QueryGraphqlModule`](QueryGraphqlModule.md)\<`RuntimeModules`\> - -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L72) - -#### Parameters - -##### queryTransportModule - -[`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md) - -##### networkStateTransportModule - -[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md) - -##### runtime - -[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> - -##### blockStorage - -[`BlockStorage`](../../sequencer/interfaces/BlockStorage.md) & [`HistoricalBlockStorage`](../../sequencer/interfaces/HistoricalBlockStorage.md) - -#### Returns - -[`QueryGraphqlModule`](QueryGraphqlModule.md)\<`RuntimeModules`\> - -#### Overrides - -[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md).[`constructor`](SchemaGeneratingGraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md).[`currentConfig`](SchemaGeneratingGraphqlModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md).[`config`](SchemaGeneratingGraphqlModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md).[`create`](SchemaGeneratingGraphqlModule.md#create) - -*** - -### generateSchema() - -> **generateSchema**(): `GraphQLSchema` - -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:361](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L361) - -#### Returns - -`GraphQLSchema` - -#### Overrides - -[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md).[`generateSchema`](SchemaGeneratingGraphqlModule.md#generateschema) - -*** - -### generateSchemaForQuery() - -> **generateSchemaForQuery**\<`ModuleType`, `ContainerModulesRecord`\>(`container`, `containerQuery`, `namePrefix`): `ObjMap`\<`GraphQLFieldConfig`\<`unknown`, `unknown`\>\> - -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:310](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L310) - -#### Type Parameters - -• **ModuleType** *extends* [`BaseModuleType`](../../common/type-aliases/BaseModuleType.md) - -• **ContainerModulesRecord** *extends* [`ModulesRecord`](../../common/interfaces/ModulesRecord.md) - -#### Parameters - -##### container - -[`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`ContainerModulesRecord`\> - -##### containerQuery - -[`Query`](../../sequencer/type-aliases/Query.md)\<`ModuleType`, `any`\> - -##### namePrefix - -`string` - -#### Returns - -`ObjMap`\<`GraphQLFieldConfig`\<`unknown`, `unknown`\>\> - -*** - -### generateStateMapResolver() - -> **generateStateMapResolver**\<`Key`, `Value`\>(`fieldKey`, `query`, `stateMap`): `GraphQLFieldConfig`\<`unknown`, `unknown`\> - -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:222](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L222) - -#### Type Parameters - -• **Key** - -• **Value** - -#### Parameters - -##### fieldKey - -`string` - -##### query - -[`QueryGetterStateMap`](../../sequencer/interfaces/QueryGetterStateMap.md)\<`Key`, `Value`\> - -##### stateMap - -[`StateMap`](../../protocol/classes/StateMap.md)\<`Key`, `Value`\> - -#### Returns - -`GraphQLFieldConfig`\<`unknown`, `unknown`\> - -*** - -### generateStateResolver() - -> **generateStateResolver**\<`Value`\>(`fieldKey`, `query`, `state`): `object` - -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:276](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L276) - -#### Type Parameters - -• **Value** - -#### Parameters - -##### fieldKey - -`string` - -##### query - -[`QueryGetterState`](../../sequencer/interfaces/QueryGetterState.md)\<`Value`\> - -##### state - -[`State`](../../protocol/classes/State.md)\<`Value`\> - -#### Returns - -`object` - -##### args - -> **args**: `object` = `{}` - -##### resolve() - -> **resolve**: () => `Promise`\<`any`\> - -###### Returns - -`Promise`\<`any`\> - -##### type - -> **type**: `GraphQLScalarType` \| `GraphQLObjectType` = `valueType` - -*** - -### state() - -> **state**(`path`): `Promise`\<`undefined` \| `string`[]\> - -Defined in: [api/src/graphql/modules/QueryGraphqlModule.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/QueryGraphqlModule.ts#L93) - -#### Parameters - -##### path - -`string` - -#### Returns - -`Promise`\<`undefined` \| `string`[]\> diff --git a/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md b/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md deleted file mode 100644 index 4cd0f3e..0000000 --- a/src/pages/docs/reference/api/classes/ResolverFactoryGraphqlModule.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: ResolverFactoryGraphqlModule ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / ResolverFactoryGraphqlModule - -# Class: `abstract` ResolverFactoryGraphqlModule\ - -Defined in: [api/src/graphql/GraphqlModule.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L30) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`GraphqlModule`](GraphqlModule.md)\<`Config`\> - -## Extended by - -- [`GeneratedResolverFactoryGraphqlModule`](../../indexer/classes/GeneratedResolverFactoryGraphqlModule.md) -- [`ResolverFactoryGraphqlModule`](../../processor/classes/ResolverFactoryGraphqlModule.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -## Constructors - -### new ResolverFactoryGraphqlModule() - -> **new ResolverFactoryGraphqlModule**\<`Config`\>(): [`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`Config`\> - -Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L11) - -#### Returns - -[`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`Config`\> - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) - -*** - -### resolvers() - -> `abstract` **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> - -Defined in: [api/src/graphql/GraphqlModule.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L33) - -#### Returns - -`Promise`\<`NonEmptyArray`\<`Function`\>\> diff --git a/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md b/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md deleted file mode 100644 index 5733920..0000000 --- a/src/pages/docs/reference/api/classes/SchemaGeneratingGraphqlModule.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: SchemaGeneratingGraphqlModule ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / SchemaGeneratingGraphqlModule - -# Class: `abstract` SchemaGeneratingGraphqlModule\ - -Defined in: [api/src/graphql/GraphqlModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L24) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`GraphqlModule`](GraphqlModule.md)\<`Config`\> - -## Extended by - -- [`QueryGraphqlModule`](QueryGraphqlModule.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -## Constructors - -### new SchemaGeneratingGraphqlModule() - -> **new SchemaGeneratingGraphqlModule**\<`Config`\>(): [`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md)\<`Config`\> - -Defined in: [api/src/graphql/GraphqlModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L11) - -#### Returns - -[`SchemaGeneratingGraphqlModule`](SchemaGeneratingGraphqlModule.md)\<`Config`\> - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`constructor`](GraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`currentConfig`](GraphqlModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`config`](GraphqlModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`GraphqlModule`](GraphqlModule.md).[`create`](GraphqlModule.md#create) - -*** - -### generateSchema() - -> `abstract` **generateSchema**(): `GraphQLSchema` - -Defined in: [api/src/graphql/GraphqlModule.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L27) - -#### Returns - -`GraphQLSchema` diff --git a/src/pages/docs/reference/api/classes/Signature.md b/src/pages/docs/reference/api/classes/Signature.md deleted file mode 100644 index c3d0ce4..0000000 --- a/src/pages/docs/reference/api/classes/Signature.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Signature ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / Signature - -# Class: Signature - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L22) - -## Constructors - -### new Signature() - -> **new Signature**(`r`, `s`): [`Signature`](Signature.md) - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L31) - -#### Parameters - -##### r - -`string` - -##### s - -`string` - -#### Returns - -[`Signature`](Signature.md) - -## Properties - -### r - -> **r**: `string` - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L25) - -*** - -### s - -> **s**: `string` - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L29) diff --git a/src/pages/docs/reference/api/classes/TransactionObject.md b/src/pages/docs/reference/api/classes/TransactionObject.md deleted file mode 100644 index 06f1d78..0000000 --- a/src/pages/docs/reference/api/classes/TransactionObject.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: TransactionObject ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / TransactionObject - -# Class: TransactionObject - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L39) - -## Constructors - -### new TransactionObject() - -> **new TransactionObject**(`hash`, `methodId`, `sender`, `nonce`, `signature`, `argsFields`, `auxiliaryData`, `isMessage`): [`TransactionObject`](TransactionObject.md) - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L88) - -#### Parameters - -##### hash - -`string` - -##### methodId - -`string` - -##### sender - -`string` - -##### nonce - -`string` - -##### signature - -[`Signature`](Signature.md) - -##### argsFields - -`string`[] - -##### auxiliaryData - -`string`[] - -##### isMessage - -`boolean` - -#### Returns - -[`TransactionObject`](TransactionObject.md) - -## Properties - -### argsFields - -> **argsFields**: `string`[] - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L80) - -*** - -### auxiliaryData - -> **auxiliaryData**: `string`[] - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L83) - -*** - -### hash - -> **hash**: `string` - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L63) - -*** - -### isMessage - -> **isMessage**: `boolean` - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L86) - -*** - -### methodId - -> **methodId**: `string` - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L67) - -*** - -### nonce - -> **nonce**: `string` - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L74) - -*** - -### sender - -> **sender**: `string` - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L70) - -*** - -### signature - -> **signature**: [`Signature`](Signature.md) - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L77) - -## Methods - -### fromServiceLayerModel() - -> `static` **fromServiceLayerModel**(`pt`): [`TransactionObject`](TransactionObject.md) - -Defined in: [api/src/graphql/modules/MempoolResolver.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/modules/MempoolResolver.ts#L40) - -#### Parameters - -##### pt - -[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) - -#### Returns - -[`TransactionObject`](TransactionObject.md) diff --git a/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md b/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md deleted file mode 100644 index 051b56a..0000000 --- a/src/pages/docs/reference/api/classes/VanillaGraphqlModules.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: VanillaGraphqlModules ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / VanillaGraphqlModules - -# Class: VanillaGraphqlModules - -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/VanillaGraphqlModules.ts#L20) - -## Constructors - -### new VanillaGraphqlModules() - -> **new VanillaGraphqlModules**(): [`VanillaGraphqlModules`](VanillaGraphqlModules.md) - -#### Returns - -[`VanillaGraphqlModules`](VanillaGraphqlModules.md) - -## Methods - -### defaultConfig() - -> `static` **defaultConfig**(): `object` - -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/VanillaGraphqlModules.ts#L35) - -#### Returns - -`object` - -##### BatchStorageResolver - -> **BatchStorageResolver**: `object` = `{}` - -##### BlockResolver - -> **BlockResolver**: `object` = `{}` - -##### MempoolResolver - -> **MempoolResolver**: `object` = `{}` - -##### MerkleWitnessResolver - -> **MerkleWitnessResolver**: `object` = `{}` - -##### NodeStatusResolver - -> **NodeStatusResolver**: `object` = `{}` - -##### QueryGraphqlModule - -> **QueryGraphqlModule**: `object` = `{}` - -*** - -### with() - -> `static` **with**\<`AdditionalModules`\>(`additionalModules`): `object` & `AdditionalModules` - -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/VanillaGraphqlModules.ts#L21) - -#### Type Parameters - -• **AdditionalModules** *extends* [`GraphqlModulesRecord`](../type-aliases/GraphqlModulesRecord.md) - -#### Parameters - -##### additionalModules - -`AdditionalModules` - -#### Returns - -`object` & `AdditionalModules` diff --git a/src/pages/docs/reference/api/functions/graphqlModule.md b/src/pages/docs/reference/api/functions/graphqlModule.md deleted file mode 100644 index 922b17d..0000000 --- a/src/pages/docs/reference/api/functions/graphqlModule.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: graphqlModule ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / graphqlModule - -# Function: graphqlModule() - -> **graphqlModule**(): (`target`) => `void` - -Defined in: [api/src/graphql/GraphqlModule.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlModule.ts#L36) - -## Returns - -`Function` - -### Parameters - -#### target - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlModule`](../classes/GraphqlModule.md)\<`unknown`\>\> - -Check if the target class extends GraphqlModule, while -also providing static config presets - -### Returns - -`void` diff --git a/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md b/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md deleted file mode 100644 index 0c7cbaa..0000000 --- a/src/pages/docs/reference/api/interfaces/GraphqlModulesDefintion.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: GraphqlModulesDefintion ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / GraphqlModulesDefintion - -# Interface: GraphqlModulesDefintion\ - -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L25) - -## Type Parameters - -• **GraphQLModules** *extends* [`GraphqlModulesRecord`](../type-aliases/GraphqlModulesRecord.md) - -## Properties - -### config? - -> `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`GraphQLModules`\> - -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L29) - -*** - -### modules - -> **modules**: `GraphQLModules` - -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L28) diff --git a/src/pages/docs/reference/api/interfaces/NodeInformation.md b/src/pages/docs/reference/api/interfaces/NodeInformation.md deleted file mode 100644 index 5483a7d..0000000 --- a/src/pages/docs/reference/api/interfaces/NodeInformation.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: NodeInformation ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / NodeInformation - -# Interface: NodeInformation - -Defined in: [api/src/graphql/services/NodeStatusService.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L21) - -## Properties - -### batchHeight - -> **batchHeight**: `number` - -Defined in: [api/src/graphql/services/NodeStatusService.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L23) - -*** - -### blockHeight - -> **blockHeight**: `number` - -Defined in: [api/src/graphql/services/NodeStatusService.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L22) diff --git a/src/pages/docs/reference/api/interfaces/ProcessInformation.md b/src/pages/docs/reference/api/interfaces/ProcessInformation.md deleted file mode 100644 index 53d756a..0000000 --- a/src/pages/docs/reference/api/interfaces/ProcessInformation.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: ProcessInformation ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / ProcessInformation - -# Interface: ProcessInformation - -Defined in: [api/src/graphql/services/NodeStatusService.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L11) - -## Properties - -### arch - -> **arch**: `string` - -Defined in: [api/src/graphql/services/NodeStatusService.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L17) - -*** - -### headTotal - -> **headTotal**: `number` - -Defined in: [api/src/graphql/services/NodeStatusService.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L15) - -*** - -### headUsed - -> **headUsed**: `number` - -Defined in: [api/src/graphql/services/NodeStatusService.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L14) - -*** - -### nodeVersion - -> **nodeVersion**: `string` - -Defined in: [api/src/graphql/services/NodeStatusService.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L16) - -*** - -### platform - -> **platform**: `string` - -Defined in: [api/src/graphql/services/NodeStatusService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L18) - -*** - -### uptime - -> **uptime**: `number` - -Defined in: [api/src/graphql/services/NodeStatusService.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L12) - -*** - -### uptimeHumanReadable - -> **uptimeHumanReadable**: `string` - -Defined in: [api/src/graphql/services/NodeStatusService.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/services/NodeStatusService.ts#L13) diff --git a/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md b/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md deleted file mode 100644 index 058054d..0000000 --- a/src/pages/docs/reference/api/type-aliases/GraphqlModulesRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: GraphqlModulesRecord ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / GraphqlModulesRecord - -# Type Alias: GraphqlModulesRecord - -> **GraphqlModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlModule`](../classes/GraphqlModule.md)\<`unknown`\>\>\> - -Defined in: [api/src/graphql/GraphqlSequencerModule.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/GraphqlSequencerModule.ts#L21) diff --git a/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md b/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md deleted file mode 100644 index 6ce699e..0000000 --- a/src/pages/docs/reference/api/type-aliases/VanillaGraphqlModulesRecord.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: VanillaGraphqlModulesRecord ---- - -[**@proto-kit/api**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/api](../README.md) / VanillaGraphqlModulesRecord - -# Type Alias: VanillaGraphqlModulesRecord - -> **VanillaGraphqlModulesRecord**: `object` - -Defined in: [api/src/graphql/VanillaGraphqlModules.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/api/src/graphql/VanillaGraphqlModules.ts#L11) - -## Type declaration - -### BatchStorageResolver - -> **BatchStorageResolver**: *typeof* [`BatchStorageResolver`](../classes/BatchStorageResolver.md) - -### BlockResolver - -> **BlockResolver**: *typeof* [`BlockResolver`](../classes/BlockResolver.md) - -### MempoolResolver - -> **MempoolResolver**: *typeof* [`MempoolResolver`](../classes/MempoolResolver.md) - -### MerkleWitnessResolver - -> **MerkleWitnessResolver**: *typeof* [`MerkleWitnessResolver`](../classes/MerkleWitnessResolver.md) - -### NodeStatusResolver - -> **NodeStatusResolver**: *typeof* [`NodeStatusResolver`](../classes/NodeStatusResolver.md) - -### QueryGraphqlModule - -> **QueryGraphqlModule**: *typeof* [`QueryGraphqlModule`](../classes/QueryGraphqlModule.md) diff --git a/src/pages/docs/reference/common/README.md b/src/pages/docs/reference/common/README.md deleted file mode 100644 index 08e48ed..0000000 --- a/src/pages/docs/reference/common/README.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -title: "@proto-kit/common" ---- - -**@proto-kit/common** - -*** - -[Documentation](../../README.md) / @proto-kit/common - -# @proto-kit/common - -## Classes - -- [AtomicCompileHelper](classes/AtomicCompileHelper.md) -- [ChildVerificationKeyService](classes/ChildVerificationKeyService.md) -- [CompileRegistry](classes/CompileRegistry.md) -- [ConfigurableModule](classes/ConfigurableModule.md) -- [EventEmitter](classes/EventEmitter.md) -- [EventEmitterProxy](classes/EventEmitterProxy.md) -- [InMemoryMerkleTreeStorage](classes/InMemoryMerkleTreeStorage.md) -- [MockAsyncMerkleTreeStore](classes/MockAsyncMerkleTreeStore.md) -- [ModuleContainer](classes/ModuleContainer.md) -- [ProvableMethodExecutionContext](classes/ProvableMethodExecutionContext.md) -- [ProvableMethodExecutionResult](classes/ProvableMethodExecutionResult.md) -- [ReplayingSingleUseEventEmitter](classes/ReplayingSingleUseEventEmitter.md) -- [RollupMerkleTree](classes/RollupMerkleTree.md) -- [RollupMerkleTreeWitness](classes/RollupMerkleTreeWitness.md) -- [ZkProgrammable](classes/ZkProgrammable.md) - -## Interfaces - -- [AbstractMerkleTree](interfaces/AbstractMerkleTree.md) -- [AbstractMerkleTreeClass](interfaces/AbstractMerkleTreeClass.md) -- [AbstractMerkleWitness](interfaces/AbstractMerkleWitness.md) -- [AreProofsEnabled](interfaces/AreProofsEnabled.md) -- [BaseModuleInstanceType](interfaces/BaseModuleInstanceType.md) -- [ChildContainerCreatable](interfaces/ChildContainerCreatable.md) -- [ChildContainerProvider](interfaces/ChildContainerProvider.md) -- [CompilableModule](interfaces/CompilableModule.md) -- [Compile](interfaces/Compile.md) -- [CompileArtifact](interfaces/CompileArtifact.md) -- [Configurable](interfaces/Configurable.md) -- [DependencyFactory](interfaces/DependencyFactory.md) -- [EventEmittingComponent](interfaces/EventEmittingComponent.md) -- [EventEmittingContainer](interfaces/EventEmittingContainer.md) -- [MerkleTreeStore](interfaces/MerkleTreeStore.md) -- [ModuleContainerDefinition](interfaces/ModuleContainerDefinition.md) -- [ModulesRecord](interfaces/ModulesRecord.md) -- [PlainZkProgram](interfaces/PlainZkProgram.md) -- [StaticConfigurableModule](interfaces/StaticConfigurableModule.md) -- [ToFieldable](interfaces/ToFieldable.md) -- [ToFieldableStatic](interfaces/ToFieldableStatic.md) -- [ToJSONableStatic](interfaces/ToJSONableStatic.md) -- [Verify](interfaces/Verify.md) -- [WithZkProgrammable](interfaces/WithZkProgrammable.md) - -## Type Aliases - -- [ArgumentTypes](type-aliases/ArgumentTypes.md) -- [ArrayElement](type-aliases/ArrayElement.md) -- [ArtifactRecord](type-aliases/ArtifactRecord.md) -- [BaseModuleType](type-aliases/BaseModuleType.md) -- [CapitalizeAny](type-aliases/CapitalizeAny.md) -- [CastToEventsRecord](type-aliases/CastToEventsRecord.md) -- [CompileTarget](type-aliases/CompileTarget.md) -- [ContainerEvents](type-aliases/ContainerEvents.md) -- [DecoratedMethod](type-aliases/DecoratedMethod.md) -- [DependenciesFromModules](type-aliases/DependenciesFromModules.md) -- [DependencyDeclaration](type-aliases/DependencyDeclaration.md) -- [DependencyRecord](type-aliases/DependencyRecord.md) -- [EventListenable](type-aliases/EventListenable.md) -- [EventsRecord](type-aliases/EventsRecord.md) -- [FilterNeverValues](type-aliases/FilterNeverValues.md) -- [FlattenedContainerEvents](type-aliases/FlattenedContainerEvents.md) -- [FlattenObject](type-aliases/FlattenObject.md) -- [InferDependencies](type-aliases/InferDependencies.md) -- [InferProofBase](type-aliases/InferProofBase.md) -- [MapDependencyRecordToTypes](type-aliases/MapDependencyRecordToTypes.md) -- [MergeObjects](type-aliases/MergeObjects.md) -- [ModuleEvents](type-aliases/ModuleEvents.md) -- [ModulesConfig](type-aliases/ModulesConfig.md) -- [NoConfig](type-aliases/NoConfig.md) -- [NonMethods](type-aliases/NonMethods.md) -- [O1JSPrimitive](type-aliases/O1JSPrimitive.md) -- [OmitKeys](type-aliases/OmitKeys.md) -- [OverwriteObjectType](type-aliases/OverwriteObjectType.md) -- [Preset](type-aliases/Preset.md) -- [Presets](type-aliases/Presets.md) -- [ProofTypes](type-aliases/ProofTypes.md) -- [RecursivePartial](type-aliases/RecursivePartial.md) -- [ResolvableModules](type-aliases/ResolvableModules.md) -- [StringKeyOf](type-aliases/StringKeyOf.md) -- [TypedClass](type-aliases/TypedClass.md) -- [TypeFromDependencyDeclaration](type-aliases/TypeFromDependencyDeclaration.md) -- [UnionToIntersection](type-aliases/UnionToIntersection.md) -- [UnTypedClass](type-aliases/UnTypedClass.md) - -## Variables - -- [EMPTY\_PUBLICKEY](variables/EMPTY_PUBLICKEY.md) -- [EMPTY\_PUBLICKEY\_X](variables/EMPTY_PUBLICKEY_X.md) -- [injectAliasMetadataKey](variables/injectAliasMetadataKey.md) -- [log](variables/log.md) -- [MAX\_FIELD](variables/MAX_FIELD.md) -- [MOCK\_PROOF](variables/MOCK_PROOF.md) -- [MOCK\_VERIFICATION\_KEY](variables/MOCK_VERIFICATION_KEY.md) -- [ModuleContainerErrors](variables/ModuleContainerErrors.md) - -## Functions - -- [assertValidTextLogLevel](functions/assertValidTextLogLevel.md) -- [compileToMockable](functions/compileToMockable.md) -- [createMerkleTree](functions/createMerkleTree.md) -- [dummyValue](functions/dummyValue.md) -- [expectDefined](functions/expectDefined.md) -- [filterNonNull](functions/filterNonNull.md) -- [filterNonUndefined](functions/filterNonUndefined.md) -- [getInjectAliases](functions/getInjectAliases.md) -- [hashWithPrefix](functions/hashWithPrefix.md) -- [implement](functions/implement.md) -- [injectAlias](functions/injectAlias.md) -- [injectOptional](functions/injectOptional.md) -- [isSubtypeOfName](functions/isSubtypeOfName.md) -- [mapSequential](functions/mapSequential.md) -- [noop](functions/noop.md) -- [prefixToField](functions/prefixToField.md) -- [provableMethod](functions/provableMethod.md) -- [range](functions/range.md) -- [reduceSequential](functions/reduceSequential.md) -- [requireTrue](functions/requireTrue.md) -- [safeParseJson](functions/safeParseJson.md) -- [sleep](functions/sleep.md) -- [splitArray](functions/splitArray.md) -- [toProver](functions/toProver.md) -- [verifyToMockable](functions/verifyToMockable.md) diff --git a/src/pages/docs/reference/common/_meta.tsx b/src/pages/docs/reference/common/_meta.tsx deleted file mode 100644 index 5602e3c..0000000 --- a/src/pages/docs/reference/common/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/common/classes/AtomicCompileHelper.md b/src/pages/docs/reference/common/classes/AtomicCompileHelper.md deleted file mode 100644 index adfb31b..0000000 --- a/src/pages/docs/reference/common/classes/AtomicCompileHelper.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: AtomicCompileHelper ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / AtomicCompileHelper - -# Class: AtomicCompileHelper - -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/AtomicCompileHelper.ts#L17) - -## Constructors - -### new AtomicCompileHelper() - -> **new AtomicCompileHelper**(`areProofsEnabled`): [`AtomicCompileHelper`](AtomicCompileHelper.md) - -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/AtomicCompileHelper.ts#L18) - -#### Parameters - -##### areProofsEnabled - -[`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) - -#### Returns - -[`AtomicCompileHelper`](AtomicCompileHelper.md) - -## Methods - -### compileContract() - -> **compileContract**(`contract`, `overrideProofsEnabled`?): `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> - -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/AtomicCompileHelper.ts#L24) - -#### Parameters - -##### contract - -[`CompileTarget`](../type-aliases/CompileTarget.md) - -##### overrideProofsEnabled? - -`boolean` - -#### Returns - -`Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> diff --git a/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md b/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md deleted file mode 100644 index 84d223a..0000000 --- a/src/pages/docs/reference/common/classes/ChildVerificationKeyService.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: ChildVerificationKeyService ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ChildVerificationKeyService - -# Class: ChildVerificationKeyService - -Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L7) - -## Constructors - -### new ChildVerificationKeyService() - -> **new ChildVerificationKeyService**(): [`ChildVerificationKeyService`](ChildVerificationKeyService.md) - -#### Returns - -[`ChildVerificationKeyService`](ChildVerificationKeyService.md) - -## Methods - -### getVerificationKey() - -> **getVerificationKey**(`name`): `object` - -Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L14) - -#### Parameters - -##### name - -`string` - -#### Returns - -`object` - -##### data - -> **data**: `string` - -##### hash - -> **hash**: `Field` - -*** - -### setCompileRegistry() - -> **setCompileRegistry**(`registry`): `void` - -Defined in: [packages/common/src/compiling/services/ChildVerificationKeyService.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/services/ChildVerificationKeyService.ts#L10) - -#### Parameters - -##### registry - -[`CompileRegistry`](CompileRegistry.md) - -#### Returns - -`void` diff --git a/src/pages/docs/reference/common/classes/CompileRegistry.md b/src/pages/docs/reference/common/classes/CompileRegistry.md deleted file mode 100644 index e06daf9..0000000 --- a/src/pages/docs/reference/common/classes/CompileRegistry.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: CompileRegistry ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CompileRegistry - -# Class: CompileRegistry - -Defined in: [packages/common/src/compiling/CompileRegistry.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L21) - -The CompileRegistry compiles "compilable modules" -(i.e. zkprograms, contracts or contractmodules) -while making sure they don't get compiled twice in the same process in parallel. - -## Constructors - -### new CompileRegistry() - -> **new CompileRegistry**(`areProofsEnabled`): [`CompileRegistry`](CompileRegistry.md) - -Defined in: [packages/common/src/compiling/CompileRegistry.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L22) - -#### Parameters - -##### areProofsEnabled - -[`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) - -#### Returns - -[`CompileRegistry`](CompileRegistry.md) - -## Methods - -### addArtifactsRaw() - -> **addArtifactsRaw**(`artifacts`): `void` - -Defined in: [packages/common/src/compiling/CompileRegistry.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L68) - -#### Parameters - -##### artifacts - -[`ArtifactRecord`](../type-aliases/ArtifactRecord.md) - -#### Returns - -`void` - -*** - -### compile() - -> **compile**(`target`): `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> - -Defined in: [packages/common/src/compiling/CompileRegistry.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L49) - -#### Parameters - -##### target - -[`CompileTarget`](../type-aliases/CompileTarget.md) - -#### Returns - -`Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> - -*** - -### forceProverExists() - -> **forceProverExists**(`f`): `Promise`\<`void`\> - -Defined in: [packages/common/src/compiling/CompileRegistry.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L41) - -This function forces compilation even if the artifact itself is in the registry. -Basically the statement is: The artifact along is not enough, we need to -actually have the prover compiled. -This is true for non-sideloaded circuit dependencies. - -#### Parameters - -##### f - -(`registry`) => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -*** - -### getAllArtifacts() - -> **getAllArtifacts**(): [`ArtifactRecord`](../type-aliases/ArtifactRecord.md) - -Defined in: [packages/common/src/compiling/CompileRegistry.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L75) - -#### Returns - -[`ArtifactRecord`](../type-aliases/ArtifactRecord.md) - -*** - -### getArtifact() - -> **getArtifact**(`name`): `undefined` \| [`CompileArtifact`](../interfaces/CompileArtifact.md) - -Defined in: [packages/common/src/compiling/CompileRegistry.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompileRegistry.ts#L58) - -#### Parameters - -##### name - -`string` - -#### Returns - -`undefined` \| [`CompileArtifact`](../interfaces/CompileArtifact.md) diff --git a/src/pages/docs/reference/common/classes/ConfigurableModule.md b/src/pages/docs/reference/common/classes/ConfigurableModule.md deleted file mode 100644 index 60a6b9d..0000000 --- a/src/pages/docs/reference/common/classes/ConfigurableModule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: ConfigurableModule ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ConfigurableModule - -# Class: ConfigurableModule\ - -Defined in: [packages/common/src/config/ConfigurableModule.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L27) - -Used by various module sub-types that may need to be configured - -## Extended by - -- [`ModuleContainer`](ModuleContainer.md) -- [`GraphqlModule`](../../api/classes/GraphqlModule.md) -- [`IndexerModule`](../../indexer/classes/IndexerModule.md) -- [`RuntimeFeeAnalyzerService`](../../library/classes/RuntimeFeeAnalyzerService.md) -- [`RuntimeModule`](../../module/classes/RuntimeModule.md) -- [`ProcessorModule`](../../processor/classes/ProcessorModule.md) -- [`ContractModule`](../../protocol/classes/ContractModule.md) -- [`ProtocolModule`](../../protocol/classes/ProtocolModule.md) -- [`AppChainModule`](../../sdk/classes/AppChainModule.md) -- [`SequencerModule`](../../sequencer/classes/SequencerModule.md) -- [`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../type-aliases/NoConfig.md) - -## Implements - -- [`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md) - -## Constructors - -### new ConfigurableModule() - -> **new ConfigurableModule**\<`Config`\>(): [`ConfigurableModule`](ConfigurableModule.md)\<`Config`\> - -#### Returns - -[`ConfigurableModule`](ConfigurableModule.md)\<`Config`\> - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L34) - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: [packages/common/src/config/ConfigurableModule.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L37) - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: [packages/common/src/config/ConfigurableModule.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L45) - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Implementation of - -[`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md).[`config`](../interfaces/BaseModuleInstanceType.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/common/src/config/ConfigurableModule.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L49) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Implementation of - -[`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md).[`create`](../interfaces/BaseModuleInstanceType.md#create) diff --git a/src/pages/docs/reference/common/classes/EventEmitter.md b/src/pages/docs/reference/common/classes/EventEmitter.md deleted file mode 100644 index dbcb722..0000000 --- a/src/pages/docs/reference/common/classes/EventEmitter.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -title: EventEmitter ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventEmitter - -# Class: EventEmitter\ - -Defined in: [packages/common/src/events/EventEmitter.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L7) - -## Extended by - -- [`EventEmitterProxy`](EventEmitterProxy.md) -- [`ReplayingSingleUseEventEmitter`](ReplayingSingleUseEventEmitter.md) - -## Type Parameters - -• **Events** *extends* [`EventsRecord`](../type-aliases/EventsRecord.md) - -## Constructors - -### new EventEmitter() - -> **new EventEmitter**\<`Events`\>(): [`EventEmitter`](EventEmitter.md)\<`Events`\> - -#### Returns - -[`EventEmitter`](EventEmitter.md)\<`Events`\> - -## Properties - -### listeners - -> `protected` `readonly` **listeners**: `ListenersHolder`\<`Events`\> = `{}` - -Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L8) - -*** - -### wildcardListeners - -> `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` - -Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L10) - -#### Parameters - -##### event - -keyof `Events` - -##### args - -`Events`\[keyof `Events`\] - -#### Returns - -`void` - -## Methods - -### emit() - -> **emit**\<`Key`\>(`event`, ...`parameters`): `void` - -Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L15) - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### event - -`Key` - -##### parameters - -...`Events`\[`Key`\] - -#### Returns - -`void` - -*** - -### off() - -> **off**\<`Key`\>(`event`, `listener`): `void` - -Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L45) - -Primitive .off() with identity comparison for now. -Could be replaced by returning an id in .on() and using that. - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### event - -`Key` - -##### listener - -(...`args`) => `void` - -#### Returns - -`void` - -*** - -### on() - -> **on**\<`Key`\>(`event`, `listener`): `void` - -Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L34) - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### event - -`Key` - -##### listener - -(...`args`) => `void` - -#### Returns - -`void` - -*** - -### onAll() - -> **onAll**(`listener`): `void` - -Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L30) - -#### Parameters - -##### listener - -(`event`, `args`) => `void` - -#### Returns - -`void` diff --git a/src/pages/docs/reference/common/classes/EventEmitterProxy.md b/src/pages/docs/reference/common/classes/EventEmitterProxy.md deleted file mode 100644 index d3883e4..0000000 --- a/src/pages/docs/reference/common/classes/EventEmitterProxy.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: EventEmitterProxy ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventEmitterProxy - -# Class: EventEmitterProxy\ - -Defined in: [packages/common/src/events/EventEmitterProxy.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L42) - -## Extends - -- [`EventEmitter`](EventEmitter.md)\<[`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`FlattenedContainerEvents`](../type-aliases/FlattenedContainerEvents.md)\<`Modules`\>\>\> - -## Type Parameters - -• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) - -## Constructors - -### new EventEmitterProxy() - -> **new EventEmitterProxy**\<`Modules`\>(`container`): [`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> - -Defined in: [packages/common/src/events/EventEmitterProxy.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L45) - -#### Parameters - -##### container - -[`ModuleContainer`](ModuleContainer.md)\<`Modules`\> - -#### Returns - -[`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> - -#### Overrides - -[`EventEmitter`](EventEmitter.md).[`constructor`](EventEmitter.md#constructors) - -## Properties - -### listeners - -> `protected` `readonly` **listeners**: `ListenersHolder`\<[`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\>\> = `{}` - -Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L8) - -#### Inherited from - -[`EventEmitter`](EventEmitter.md).[`listeners`](EventEmitter.md#listeners) - -*** - -### wildcardListeners - -> `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` - -Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L10) - -#### Parameters - -##### event - -keyof [`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\> - -##### args - -[`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\>\[keyof [`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\>\] - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](EventEmitter.md).[`wildcardListeners`](EventEmitter.md#wildcardlisteners) - -## Methods - -### emit() - -> **emit**\<`Key`\>(`event`, ...`parameters`): `void` - -Defined in: [packages/common/src/events/EventEmitter.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L15) - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### event - -`Key` - -##### parameters - -...[`CastToEventsRecord`](../type-aliases/CastToEventsRecord.md)\<[`UnionToIntersection`](../type-aliases/UnionToIntersection.md)\<[`ContainerEvents`](../type-aliases/ContainerEvents.md)\<`Modules`\>\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\>\>\[`Key`\] - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](EventEmitter.md).[`emit`](EventEmitter.md#emit) - -*** - -### off() - -> **off**\<`Key`\>(`event`, `listener`): `void` - -Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L45) - -Primitive .off() with identity comparison for now. -Could be replaced by returning an id in .on() and using that. - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### event - -`Key` - -##### listener - -(...`args`) => `void` - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](EventEmitter.md).[`off`](EventEmitter.md#off) - -*** - -### on() - -> **on**\<`Key`\>(`event`, `listener`): `void` - -Defined in: [packages/common/src/events/EventEmitter.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L34) - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### event - -`Key` - -##### listener - -(...`args`) => `void` - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](EventEmitter.md).[`on`](EventEmitter.md#on) - -*** - -### onAll() - -> **onAll**(`listener`): `void` - -Defined in: [packages/common/src/events/EventEmitter.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L30) - -#### Parameters - -##### listener - -(`event`, `args`) => `void` - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](EventEmitter.md).[`onAll`](EventEmitter.md#onall) diff --git a/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md b/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md deleted file mode 100644 index 4c3e4bc..0000000 --- a/src/pages/docs/reference/common/classes/InMemoryMerkleTreeStorage.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: InMemoryMerkleTreeStorage ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / InMemoryMerkleTreeStorage - -# Class: InMemoryMerkleTreeStorage - -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L3) - -## Extended by - -- [`CachedMerkleTreeStore`](../../sequencer/classes/CachedMerkleTreeStore.md) -- [`SyncCachedMerkleTreeStore`](../../sequencer/classes/SyncCachedMerkleTreeStore.md) - -## Implements - -- [`MerkleTreeStore`](../interfaces/MerkleTreeStore.md) - -## Constructors - -### new InMemoryMerkleTreeStorage() - -> **new InMemoryMerkleTreeStorage**(): [`InMemoryMerkleTreeStorage`](InMemoryMerkleTreeStorage.md) - -#### Returns - -[`InMemoryMerkleTreeStorage`](InMemoryMerkleTreeStorage.md) - -## Properties - -### nodes - -> `protected` **nodes**: `object` = `{}` - -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L4) - -#### Index Signature - -\[`key`: `number`\]: `object` - -## Methods - -### getNode() - -> **getNode**(`key`, `level`): `undefined` \| `bigint` - -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L10) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -#### Returns - -`undefined` \| `bigint` - -#### Implementation of - -[`MerkleTreeStore`](../interfaces/MerkleTreeStore.md).[`getNode`](../interfaces/MerkleTreeStore.md#getnode) - -*** - -### setNode() - -> **setNode**(`key`, `level`, `value`): `void` - -Defined in: [packages/common/src/trees/InMemoryMerkleTreeStorage.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/InMemoryMerkleTreeStorage.ts#L14) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -##### value - -`bigint` - -#### Returns - -`void` - -#### Implementation of - -[`MerkleTreeStore`](../interfaces/MerkleTreeStore.md).[`setNode`](../interfaces/MerkleTreeStore.md#setnode) diff --git a/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md b/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md deleted file mode 100644 index c001175..0000000 --- a/src/pages/docs/reference/common/classes/MockAsyncMerkleTreeStore.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: MockAsyncMerkleTreeStore ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MockAsyncMerkleTreeStore - -# Class: MockAsyncMerkleTreeStore - -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L5) - -## Constructors - -### new MockAsyncMerkleTreeStore() - -> **new MockAsyncMerkleTreeStore**(): [`MockAsyncMerkleTreeStore`](MockAsyncMerkleTreeStore.md) - -#### Returns - -[`MockAsyncMerkleTreeStore`](MockAsyncMerkleTreeStore.md) - -## Properties - -### store - -> `readonly` **store**: [`InMemoryMerkleTreeStorage`](InMemoryMerkleTreeStorage.md) - -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L6) - -## Methods - -### commit() - -> **commit**(): `void` - -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L8) - -#### Returns - -`void` - -*** - -### getNodeAsync() - -> **getNodeAsync**(`key`, `level`): `Promise`\<`undefined` \| `bigint`\> - -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L16) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -#### Returns - -`Promise`\<`undefined` \| `bigint`\> - -*** - -### openTransaction() - -> **openTransaction**(): `void` - -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L12) - -#### Returns - -`void` - -*** - -### setNodeAsync() - -> **setNodeAsync**(`key`, `level`, `value`): `Promise`\<`void`\> - -Defined in: [packages/common/src/trees/MockAsyncMerkleStore.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MockAsyncMerkleStore.ts#L23) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -##### value - -`bigint` - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/common/classes/ModuleContainer.md b/src/pages/docs/reference/common/classes/ModuleContainer.md deleted file mode 100644 index ac8f44d..0000000 --- a/src/pages/docs/reference/common/classes/ModuleContainer.md +++ /dev/null @@ -1,520 +0,0 @@ ---- -title: ModuleContainer ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModuleContainer - -# Class: ModuleContainer\ - -Defined in: [packages/common/src/config/ModuleContainer.ts:145](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L145) - -Reusable module container facilitating registration, resolution -configuration, decoration and validation of modules - -## Extends - -- [`ConfigurableModule`](ConfigurableModule.md)\<[`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\>\> - -## Extended by - -- [`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md) -- [`Indexer`](../../indexer/classes/Indexer.md) -- [`Runtime`](../../module/classes/Runtime.md) -- [`Processor`](../../processor/classes/Processor.md) -- [`Protocol`](../../protocol/classes/Protocol.md) -- [`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md) -- [`AppChain`](../../sdk/classes/AppChain.md) -- [`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md) -- [`Sequencer`](../../sequencer/classes/Sequencer.md) - -## Type Parameters - -• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) - -## Constructors - -### new ModuleContainer() - -> **new ModuleContainer**\<`Modules`\>(`definition`): [`ModuleContainer`](ModuleContainer.md)\<`Modules`\> - -Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L159) - -#### Parameters - -##### definition - -[`ModuleContainerDefinition`](../interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -#### Returns - -[`ModuleContainer`](ModuleContainer.md)\<`Modules`\> - -#### Overrides - -[`ConfigurableModule`](ConfigurableModule.md).[`constructor`](ConfigurableModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: [packages/common/src/config/ConfigurableModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L34) - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](ConfigurableModule.md).[`currentConfig`](ConfigurableModule.md#currentconfig) - -*** - -### definition - -> **definition**: [`ModuleContainerDefinition`](../interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -Defined in: [packages/common/src/config/ModuleContainer.ts:159](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L159) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: [packages/common/src/config/ModuleContainer.ts:317](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L317) - -##### Returns - -[`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:321](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L321) - -##### Parameters - -###### config - -[`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Overrides - -[`ConfigurableModule`](ConfigurableModule.md).[`config`](ConfigurableModule.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: [packages/common/src/config/ModuleContainer.ts:199](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L199) - -##### Returns - -`DependencyContainer` - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> - -Defined in: [packages/common/src/config/ModuleContainer.ts:270](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L270) - -##### Returns - -[`EventEmitterProxy`](EventEmitterProxy.md)\<`Modules`\> - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: [packages/common/src/config/ModuleContainer.ts:166](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L166) - -##### Returns - -`string`[] - -list of module names - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: [packages/common/src/config/ModuleContainer.ts:224](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L224) - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` - -Defined in: [packages/common/src/config/ModuleContainer.ts:209](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L209) - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf` - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:306](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L306) - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Returns - -`void` - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:310](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L310) - -#### Parameters - -##### config - -[`RecursivePartial`](../type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\>\> - -#### Returns - -`void` - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:477](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L477) - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Overrides - -[`ConfigurableModule`](ConfigurableModule.md).[`create`](ConfigurableModule.md#create) - -*** - -### decorateModule() - -> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L364) - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -`InstanceType`\<`Modules`\[[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>\]\> - -#### Returns - -`void` - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:389](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L389) - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\>[] - -#### Returns - -`void` - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` - -Defined in: [packages/common/src/config/ModuleContainer.ts:217](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L217) - -#### Parameters - -##### modules - -`Modules` - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf` - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:449](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L449) - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\> - -#### Returns - -`void` - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:232](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L232) - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:288](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L288) - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:249](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L249) - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -`Modules` - -#### Returns - -`void` - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L282) - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -Defined in: [packages/common/src/config/ModuleContainer.ts:338](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L338) - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: [packages/common/src/config/ModuleContainer.ts:346](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L346) - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: [packages/common/src/config/ModuleContainer.ts:177](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L177) - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -[`ConfigurableModule`](ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` diff --git a/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md b/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md deleted file mode 100644 index eff13e2..0000000 --- a/src/pages/docs/reference/common/classes/ProvableMethodExecutionContext.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -title: ProvableMethodExecutionContext ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ProvableMethodExecutionContext - -# Class: ProvableMethodExecutionContext - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L48) - -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 - -- [`RuntimeMethodExecutionContext`](../../protocol/classes/RuntimeMethodExecutionContext.md) - -## Constructors - -### new ProvableMethodExecutionContext() - -> **new ProvableMethodExecutionContext**(): [`ProvableMethodExecutionContext`](ProvableMethodExecutionContext.md) - -#### Returns - -[`ProvableMethodExecutionContext`](ProvableMethodExecutionContext.md) - -## Properties - -### id - -> **id**: `string` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L49) - -*** - -### methods - -> **methods**: `string`[] = `[]` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L51) - -*** - -### result - -> **result**: [`ProvableMethodExecutionResult`](ProvableMethodExecutionResult.md) - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L53) - -## Accessors - -### isFinished - -#### Get Signature - -> **get** **isFinished**(): `boolean` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L102) - -##### Returns - -`boolean` - -*** - -### isTopLevel - -#### Get Signature - -> **get** **isTopLevel**(): `boolean` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:98](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L98) - -##### Returns - -`boolean` - -## Methods - -### afterMethod() - -> **afterMethod**(): `void` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L94) - -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` - -*** - -### beforeMethod() - -> **beforeMethod**(`moduleName`, `methodName`, `args`): `void` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L74) - -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`](../type-aliases/ArgumentTypes.md) - -#### Returns - -`void` - -*** - -### clear() - -> **clear**(): `void` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:119](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L119) - -Manually clears/resets the execution context - -#### Returns - -`void` - -*** - -### current() - -> **current**(): `object` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L109) - -#### Returns - -`object` - -- Current execution context state - -##### isFinished - -> **isFinished**: `boolean` - -##### result - -> **result**: [`ProvableMethodExecutionResult`](ProvableMethodExecutionResult.md) - -*** - -### setProver() - -> **setProver**(`prover`): `void` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L64) - -Adds a method prover to the current execution context, -which can be collected and ran asynchronously at a later point in time. - -#### Parameters - -##### prover - -() => `Promise`\<`Proof`\<`unknown`, `unknown`\>\> - -#### Returns - -`void` diff --git a/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md b/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md deleted file mode 100644 index e927474..0000000 --- a/src/pages/docs/reference/common/classes/ProvableMethodExecutionResult.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: ProvableMethodExecutionResult ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ProvableMethodExecutionResult - -# Class: ProvableMethodExecutionResult - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L16) - -## Extended by - -- [`RuntimeProvableMethodExecutionResult`](../../protocol/classes/RuntimeProvableMethodExecutionResult.md) - -## Constructors - -### new ProvableMethodExecutionResult() - -> **new ProvableMethodExecutionResult**(): [`ProvableMethodExecutionResult`](ProvableMethodExecutionResult.md) - -#### Returns - -[`ProvableMethodExecutionResult`](ProvableMethodExecutionResult.md) - -## Properties - -### args? - -> `optional` **args**: [`ArgumentTypes`](../type-aliases/ArgumentTypes.md) - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L21) - -*** - -### methodName? - -> `optional` **methodName**: `string` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L19) - -*** - -### moduleName? - -> `optional` **moduleName**: `string` - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L17) - -*** - -### prover()? - -> `optional` **prover**: () => `Promise`\<`Proof`\<`unknown`, `unknown`\>\> - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L23) - -#### Returns - -`Promise`\<`Proof`\<`unknown`, `unknown`\>\> - -## Methods - -### prove() - -> **prove**\<`ProofType`\>(): `Promise`\<`ProofType`\> - -Defined in: [packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ProvableMethodExecutionContext.ts#L25) - -#### Type Parameters - -• **ProofType** *extends* `Proof`\<`unknown`, `unknown`\> - -#### Returns - -`Promise`\<`ProofType`\> diff --git a/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md b/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md deleted file mode 100644 index eab735c..0000000 --- a/src/pages/docs/reference/common/classes/ReplayingSingleUseEventEmitter.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -title: ReplayingSingleUseEventEmitter ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ReplayingSingleUseEventEmitter - -# Class: ReplayingSingleUseEventEmitter\ - -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L12) - -Event Emitter variant that emits a certain event only once to a registered listener. -Additionally, if a listener registers to a event that has already been emitted, it -re-emits it to said listener. -This pattern is especially useful for listening for inclusions of transactions. -Those events will only occur once, and listeners could come too late to the party, -so we need to make sure they get notified as well in those cases. - -## Extends - -- [`EventEmitter`](EventEmitter.md)\<`Events`\> - -## Type Parameters - -• **Events** *extends* [`EventsRecord`](../type-aliases/EventsRecord.md) - -## Constructors - -### new ReplayingSingleUseEventEmitter() - -> **new ReplayingSingleUseEventEmitter**\<`Events`\>(): [`ReplayingSingleUseEventEmitter`](ReplayingSingleUseEventEmitter.md)\<`Events`\> - -#### Returns - -[`ReplayingSingleUseEventEmitter`](ReplayingSingleUseEventEmitter.md)\<`Events`\> - -#### Inherited from - -[`EventEmitter`](EventEmitter.md).[`constructor`](EventEmitter.md#constructors) - -## Properties - -### emitted - -> **emitted**: `Partial`\<`Events`\> = `{}` - -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L15) - -*** - -### listeners - -> `protected` `readonly` **listeners**: `ListenersHolder`\<`Events`\> = `{}` - -Defined in: [packages/common/src/events/EventEmitter.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L8) - -#### Inherited from - -[`EventEmitter`](EventEmitter.md).[`listeners`](EventEmitter.md#listeners) - -*** - -### wildcardListeners - -> `protected` `readonly` **wildcardListeners**: (`event`, `args`) => `void`[] = `[]` - -Defined in: [packages/common/src/events/EventEmitter.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L10) - -#### Parameters - -##### event - -keyof `Events` - -##### args - -`Events`\[keyof `Events`\] - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](EventEmitter.md).[`wildcardListeners`](EventEmitter.md#wildcardlisteners) - -## Methods - -### emit() - -> **emit**\<`Key`\>(`event`, ...`parameters`): `void` - -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L17) - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### event - -`Key` - -##### parameters - -...`Events`\[`Key`\] - -#### Returns - -`void` - -#### Overrides - -[`EventEmitter`](EventEmitter.md).[`emit`](EventEmitter.md#emit) - -*** - -### off() - -> **off**\<`Key`\>(`event`, `listener`): `void` - -Defined in: [packages/common/src/events/EventEmitter.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L45) - -Primitive .off() with identity comparison for now. -Could be replaced by returning an id in .on() and using that. - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### event - -`Key` - -##### listener - -(...`args`) => `void` - -#### Returns - -`void` - -#### Inherited from - -[`EventEmitter`](EventEmitter.md).[`off`](EventEmitter.md#off) - -*** - -### on() - -> **on**\<`Key`\>(`event`, `listener`): `void` - -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L33) - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### event - -`Key` - -##### listener - -(...`args`) => `void` - -#### Returns - -`void` - -#### Overrides - -[`EventEmitter`](EventEmitter.md).[`on`](EventEmitter.md#on) - -*** - -### onAll() - -> **onAll**(`listener`): `void` - -Defined in: [packages/common/src/events/ReplayingSingleUseEventEmitter.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/ReplayingSingleUseEventEmitter.ts#L26) - -#### Parameters - -##### listener - -(`event`, `args`) => `void` - -#### Returns - -`void` - -#### Overrides - -[`EventEmitter`](EventEmitter.md).[`onAll`](EventEmitter.md#onall) diff --git a/src/pages/docs/reference/common/classes/RollupMerkleTree.md b/src/pages/docs/reference/common/classes/RollupMerkleTree.md deleted file mode 100644 index 3e2d3ca..0000000 --- a/src/pages/docs/reference/common/classes/RollupMerkleTree.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -title: RollupMerkleTree ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / RollupMerkleTree - -# Class: RollupMerkleTree - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:344](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L344) - -## Extends - -- [`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md) - -## Constructors - -### new RollupMerkleTree() - -> **new RollupMerkleTree**(`store`): [`RollupMerkleTree`](RollupMerkleTree.md) - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L85) - -#### Parameters - -##### store - -[`MerkleTreeStore`](../interfaces/MerkleTreeStore.md) - -#### Returns - -[`RollupMerkleTree`](RollupMerkleTree.md) - -#### Inherited from - -`createMerkleTree(256).constructor` - -## Properties - -### leafCount - -> `readonly` **leafCount**: `bigint` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L43) - -#### Inherited from - -[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`leafCount`](../interfaces/AbstractMerkleTree.md#leafcount) - -*** - -### store - -> **store**: [`MerkleTreeStore`](../interfaces/MerkleTreeStore.md) - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L42) - -#### Inherited from - -[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`store`](../interfaces/AbstractMerkleTree.md#store) - -*** - -### EMPTY\_ROOT - -> `static` **EMPTY\_ROOT**: `bigint` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L92) - -#### Inherited from - -`createMerkleTree(256).EMPTY_ROOT` - -*** - -### HEIGHT - -> `static` **HEIGHT**: `number` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L90) - -#### Inherited from - -`createMerkleTree(256).HEIGHT` - -*** - -### WITNESS - -> `static` **WITNESS**: [`TypedClass`](../type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L87) - -#### Type declaration - -##### dummy() - -> **dummy**: () => [`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) - -###### Returns - -[`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) - -#### Inherited from - -`createMerkleTree(256).WITNESS` - -## Accessors - -### leafCount - -#### Get Signature - -> **get** `static` **leafCount**(): `bigint` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L94) - -##### Returns - -`bigint` - -#### Inherited from - -`createMerkleTree(256).leafCount` - -## Methods - -### assertIndexRange() - -> **assertIndexRange**(`index`): `void` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L45) - -#### Parameters - -##### index - -`bigint` - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`assertIndexRange`](../interfaces/AbstractMerkleTree.md#assertindexrange) - -*** - -### fill() - -> **fill**(`leaves`): `void` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L81) - -Fills all leaves of the tree. - -#### Parameters - -##### leaves - -`Field`[] - -Values to fill the leaves with. - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`fill`](../interfaces/AbstractMerkleTree.md#fill) - -*** - -### getNode() - -> **getNode**(`level`, `index`): `Field` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L53) - -Returns a node which lives at a given index and level. - -#### Parameters - -##### level - -`number` - -Level of the node. - -##### index - -`bigint` - -Index of the node. - -#### Returns - -`Field` - -The data of the node. - -#### Inherited from - -[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`getNode`](../interfaces/AbstractMerkleTree.md#getnode) - -*** - -### getRoot() - -> **getRoot**(): `Field` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L59) - -Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). - -#### Returns - -`Field` - -The root of the Merkle Tree. - -#### Inherited from - -[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`getRoot`](../interfaces/AbstractMerkleTree.md#getroot) - -*** - -### getWitness() - -> **getWitness**(`index`): [`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L75) - -Returns the witness (also known as -[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) -for the leaf at the given index. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -#### Returns - -[`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) - -The witness that belongs to the leaf. - -#### Inherited from - -[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`getWitness`](../interfaces/AbstractMerkleTree.md#getwitness) - -*** - -### setLeaf() - -> **setLeaf**(`index`, `leaf`): `void` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L66) - -Sets the value of a leaf node at a given index to a given value. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -##### leaf - -`Field` - -New value. - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../interfaces/AbstractMerkleTree.md).[`setLeaf`](../interfaces/AbstractMerkleTree.md#setleaf) diff --git a/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md b/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md deleted file mode 100644 index ab17916..0000000 --- a/src/pages/docs/reference/common/classes/RollupMerkleTreeWitness.md +++ /dev/null @@ -1,575 +0,0 @@ ---- -title: RollupMerkleTreeWitness ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / RollupMerkleTreeWitness - -# Class: RollupMerkleTreeWitness - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:345](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L345) - -## Extends - -- [`WITNESS`](../interfaces/AbstractMerkleTreeClass.md#witness) - -## Constructors - -### new RollupMerkleTreeWitness() - -> **new RollupMerkleTreeWitness**(`value`): [`RollupMerkleTreeWitness`](RollupMerkleTreeWitness.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### isLeft - -`Bool`[] = `...` - -###### path - -`Field`[] = `...` - -#### Returns - -[`RollupMerkleTreeWitness`](RollupMerkleTreeWitness.md) - -#### Inherited from - -`RollupMerkleTree.WITNESS.constructor` - -## Properties - -### isLeft - -> **isLeft**: `Bool`[] - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L11) - -#### Inherited from - -`RollupMerkleTree.WITNESS.isLeft` - -*** - -### path - -> **path**: `Field`[] - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L10) - -#### Inherited from - -`RollupMerkleTree.WITNESS.path` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`RollupMerkleTree.WITNESS._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### isLeft - -`Bool`[] = `...` - -###### path - -`Field`[] = `...` - -#### Returns - -`void` - -#### Inherited from - -`RollupMerkleTree.WITNESS.check` - -*** - -### dummy() - -> `static` **dummy**: () => [`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L88) - -#### Returns - -[`AbstractMerkleWitness`](../interfaces/AbstractMerkleWitness.md) - -#### Inherited from - -`RollupMerkleTree.WITNESS.dummy` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`RollupMerkleTree.WITNESS.empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`RollupMerkleTree.WITNESS.fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### isLeft - -`boolean`[] = `...` - -###### path - -`string`[] = `...` - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`RollupMerkleTree.WITNESS.fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`RollupMerkleTree.WITNESS.fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### isLeft - -`Bool`[] = `...` - -###### path - -`Field`[] = `...` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`RollupMerkleTree.WITNESS.toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### isLeft - -`Bool`[] = `...` - -###### path - -`Field`[] = `...` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`RollupMerkleTree.WITNESS.toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] = `...` - -###### path - -`Field`[] = `...` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`RollupMerkleTree.WITNESS.toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] = `...` - -###### path - -`Field`[] = `...` - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `boolean`[] - -##### path - -> **path**: `string`[] - -#### Inherited from - -`RollupMerkleTree.WITNESS.toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] = `...` - -###### path - -`Field`[] = `...` - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `boolean`[] - -##### path - -> **path**: `bigint`[] - -#### Inherited from - -`RollupMerkleTree.WITNESS.toValue` - -## Methods - -### calculateIndex() - -> **calculateIndex**(): `Field` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L28) - -Calculates the index of the leaf node that belongs to this Witness. - -#### Returns - -`Field` - -Index of the leaf. - -#### Inherited from - -`RollupMerkleTree.WITNESS.calculateIndex` - -*** - -### calculateRoot() - -> **calculateRoot**(`hash`): `Field` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L22) - -Calculates a root depending on the leaf value. - -#### Parameters - -##### hash - -`Field` - -#### Returns - -`Field` - -The calculated root. - -#### Inherited from - -`RollupMerkleTree.WITNESS.calculateRoot` - -*** - -### checkMembership() - -> **checkMembership**(`root`, `key`, `value`): `Bool` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L30) - -#### Parameters - -##### root - -`Field` - -##### key - -`Field` - -##### value - -`Field` - -#### Returns - -`Bool` - -#### Inherited from - -`RollupMerkleTree.WITNESS.checkMembership` - -*** - -### checkMembershipGetRoots() - -> **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L32) - -#### Parameters - -##### root - -`Field` - -##### key - -`Field` - -##### value - -`Field` - -#### Returns - -\[`Bool`, `Field`, `Field`\] - -#### Inherited from - -`RollupMerkleTree.WITNESS.checkMembershipGetRoots` - -*** - -### height() - -> **height**(): `number` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L15) - -#### Returns - -`number` - -#### Inherited from - -`RollupMerkleTree.WITNESS.height` - -*** - -### toShortenedEntries() - -> **toShortenedEntries**(): `string`[] - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L38) - -#### Returns - -`string`[] - -#### Inherited from - -`RollupMerkleTree.WITNESS.toShortenedEntries` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`RollupMerkleTree.WITNESS.sizeInFields` diff --git a/src/pages/docs/reference/common/classes/ZkProgrammable.md b/src/pages/docs/reference/common/classes/ZkProgrammable.md deleted file mode 100644 index 707e9a7..0000000 --- a/src/pages/docs/reference/common/classes/ZkProgrammable.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: ZkProgrammable ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ZkProgrammable - -# Class: `abstract` ZkProgrammable\ - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:99](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L99) - -## Extended by - -- [`RuntimeZkProgrammable`](../../module/classes/RuntimeZkProgrammable.md) -- [`BlockProverProgrammable`](../../protocol/classes/BlockProverProgrammable.md) -- [`StateTransitionProverProgrammable`](../../protocol/classes/StateTransitionProverProgrammable.md) - -## Type Parameters - -• **PublicInput** = `undefined` - -• **PublicOutput** = `void` - -## Constructors - -### new ZkProgrammable() - -> **new ZkProgrammable**\<`PublicInput`, `PublicOutput`\>(): [`ZkProgrammable`](ZkProgrammable.md)\<`PublicInput`, `PublicOutput`\> - -#### Returns - -[`ZkProgrammable`](ZkProgrammable.md)\<`PublicInput`, `PublicOutput`\> - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** `abstract` **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:103](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L103) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) - -*** - -### zkProgram - -#### Get Signature - -> **get** **zkProgram**(): [`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L113) - -##### Returns - -[`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../interfaces/CompileArtifact.md)\>\> - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L130) - -#### Parameters - -##### registry - -[`CompileRegistry`](CompileRegistry.md) - -#### Returns - -`Promise`\<`Record`\<`string`, [`CompileArtifact`](../interfaces/CompileArtifact.md)\>\> - -*** - -### zkProgramFactory() - -> `abstract` **zkProgramFactory**(): [`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L105) - -#### Returns - -[`PlainZkProgram`](../interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] diff --git a/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md b/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md deleted file mode 100644 index b74858b..0000000 --- a/src/pages/docs/reference/common/functions/assertValidTextLogLevel.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: assertValidTextLogLevel ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / assertValidTextLogLevel - -# Function: assertValidTextLogLevel() - -> **assertValidTextLogLevel**(`level`): `asserts level is LogLevelNames` - -Defined in: [packages/common/src/log.ts:134](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/log.ts#L134) - -## Parameters - -### level - -`string` | `number` - -## Returns - -`asserts level is LogLevelNames` diff --git a/src/pages/docs/reference/common/functions/compileToMockable.md b/src/pages/docs/reference/common/functions/compileToMockable.md deleted file mode 100644 index 752e490..0000000 --- a/src/pages/docs/reference/common/functions/compileToMockable.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: compileToMockable ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / compileToMockable - -# Function: compileToMockable() - -> **compileToMockable**(`compile`, `__namedParameters`): () => `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L84) - -## Parameters - -### compile - -[`Compile`](../interfaces/Compile.md) - -### \_\_namedParameters - -[`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) - -## Returns - -`Function` - -### Returns - -`Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> diff --git a/src/pages/docs/reference/common/functions/createMerkleTree.md b/src/pages/docs/reference/common/functions/createMerkleTree.md deleted file mode 100644 index 3aabee6..0000000 --- a/src/pages/docs/reference/common/functions/createMerkleTree.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: createMerkleTree ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / createMerkleTree - -# Function: createMerkleTree() - -> **createMerkleTree**(`height`): [`AbstractMerkleTreeClass`](../interfaces/AbstractMerkleTreeClass.md) - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:116](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L116) - -A [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree) is a binary tree in -which every leaf is the cryptography hash of a piece of data, -and every node is the hash of the concatenation of its two child nodes. - -A Merkle Tree allows developers to easily and securely verify -the integrity of large amounts of data. - -Take a look at our [documentation](https://docs.minaprotocol.com/en/zkapps) -on how to use Merkle Trees in combination with zkApps and -zero knowledge programming! - -Levels are indexed from leaves (level 0) to root (level N - 1). - -This function takes a height as argument and returns a class -that implements a merkletree with that specified height. - -It also holds the Witness class under tree.WITNESS - -## Parameters - -### height - -`number` - -## Returns - -[`AbstractMerkleTreeClass`](../interfaces/AbstractMerkleTreeClass.md) diff --git a/src/pages/docs/reference/common/functions/dummyValue.md b/src/pages/docs/reference/common/functions/dummyValue.md deleted file mode 100644 index db4d4f0..0000000 --- a/src/pages/docs/reference/common/functions/dummyValue.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: dummyValue ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / dummyValue - -# Function: dummyValue() - -> **dummyValue**\<`Value`\>(`valueType`): `Value` - -Defined in: [packages/common/src/utils.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L93) - -Computes a dummy value for the given value type. - -## Type Parameters - -• **Value** - -## Parameters - -### valueType - -`FlexibleProvablePure`\<`Value`\> - -Value type to generate the dummy value for - -## Returns - -`Value` - -Dummy value for the given value type diff --git a/src/pages/docs/reference/common/functions/expectDefined.md b/src/pages/docs/reference/common/functions/expectDefined.md deleted file mode 100644 index 30d1375..0000000 --- a/src/pages/docs/reference/common/functions/expectDefined.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: expectDefined ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / expectDefined - -# Function: expectDefined() - -> **expectDefined**\<`T`\>(`value`): `asserts value is T` - -Defined in: [packages/common/src/utils.ts:165](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L165) - -## Type Parameters - -• **T** - -## Parameters - -### value - -`undefined` | `T` - -## Returns - -`asserts value is T` diff --git a/src/pages/docs/reference/common/functions/filterNonNull.md b/src/pages/docs/reference/common/functions/filterNonNull.md deleted file mode 100644 index 1b52094..0000000 --- a/src/pages/docs/reference/common/functions/filterNonNull.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: filterNonNull ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / filterNonNull - -# Function: filterNonNull() - -> **filterNonNull**\<`Type`\>(`value`): `value is Type` - -Defined in: [packages/common/src/utils.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L132) - -## Type Parameters - -• **Type** - -## Parameters - -### value - -`null` | `Type` - -## Returns - -`value is Type` diff --git a/src/pages/docs/reference/common/functions/filterNonUndefined.md b/src/pages/docs/reference/common/functions/filterNonUndefined.md deleted file mode 100644 index 1b762fe..0000000 --- a/src/pages/docs/reference/common/functions/filterNonUndefined.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: filterNonUndefined ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / filterNonUndefined - -# Function: filterNonUndefined() - -> **filterNonUndefined**\<`Type`\>(`value`): `value is Type` - -Defined in: [packages/common/src/utils.ts:136](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L136) - -## Type Parameters - -• **Type** - -## Parameters - -### value - -`undefined` | `Type` - -## Returns - -`value is Type` diff --git a/src/pages/docs/reference/common/functions/getInjectAliases.md b/src/pages/docs/reference/common/functions/getInjectAliases.md deleted file mode 100644 index cd7c0a2..0000000 --- a/src/pages/docs/reference/common/functions/getInjectAliases.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: getInjectAliases ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / getInjectAliases - -# Function: getInjectAliases() - -> **getInjectAliases**(`target`): `string`[] - -Defined in: [packages/common/src/config/injectAlias.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/injectAlias.ts#L63) - -## Parameters - -### target - -[`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\> - -## Returns - -`string`[] diff --git a/src/pages/docs/reference/common/functions/hashWithPrefix.md b/src/pages/docs/reference/common/functions/hashWithPrefix.md deleted file mode 100644 index 308f657..0000000 --- a/src/pages/docs/reference/common/functions/hashWithPrefix.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: hashWithPrefix ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / hashWithPrefix - -# Function: hashWithPrefix() - -> **hashWithPrefix**(`prefix`, `input`): `Field` - -Defined in: [packages/common/src/utils.ts:154](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L154) - -## Parameters - -### prefix - -`string` - -### input - -`Field`[] - -## Returns - -`Field` diff --git a/src/pages/docs/reference/common/functions/implement.md b/src/pages/docs/reference/common/functions/implement.md deleted file mode 100644 index c7a335d..0000000 --- a/src/pages/docs/reference/common/functions/implement.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: implement ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / implement - -# Function: implement() - -> **implement**\<`T`\>(`name`): (`target`) => `void` - -Defined in: [packages/common/src/config/injectAlias.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/injectAlias.ts#L51) - -Marks the class to implement a certain interface T, while also attaching -a DI-injection alias as metadata, that will be picked up by the ModuleContainer -to allow resolving by that interface name - -## Type Parameters - -• **T** - -## Parameters - -### name - -`string` - -The name of the injection alias, convention is to use the same as the name of T - -## Returns - -`Function` - -### Parameters - -#### target - -[`TypedClass`](../type-aliases/TypedClass.md)\<`T`\> - -Check if the target class extends RuntimeModule, while -also providing static config presets - -### Returns - -`void` diff --git a/src/pages/docs/reference/common/functions/injectAlias.md b/src/pages/docs/reference/common/functions/injectAlias.md deleted file mode 100644 index 846174e..0000000 --- a/src/pages/docs/reference/common/functions/injectAlias.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: injectAlias ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / injectAlias - -# Function: injectAlias() - -> **injectAlias**(`aliases`): (`target`) => `void` - -Defined in: [packages/common/src/config/injectAlias.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/injectAlias.ts#L11) - -Attaches metadata to the class that the ModuleContainer can pick up -and inject this class in the DI container under the specified aliases. -This method supports inheritance, therefore also gets aliases defined -on superclasses - -## Parameters - -### aliases - -`string`[] - -## Returns - -`Function` - -### Parameters - -#### target - -[`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\> - -### Returns - -`void` diff --git a/src/pages/docs/reference/common/functions/injectOptional.md b/src/pages/docs/reference/common/functions/injectOptional.md deleted file mode 100644 index f17be2e..0000000 --- a/src/pages/docs/reference/common/functions/injectOptional.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: injectOptional ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / injectOptional - -# Function: injectOptional() - -> **injectOptional**\<`T`\>(`token`): (`target`, `propertyKey`, `parameterIndex`) => `any` - -Defined in: [packages/common/src/dependencyFactory/injectOptional.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/injectOptional.ts#L38) - -This function injects a dependency only if it has been registered, otherwise -injects undefined. This can be useful for having optional dependencies, where -tsyringe would normally error out and not be able to resolve. With this -decorator, we can now do this. - -The strategy we employ here is that we inject a dummy into the global -container that is of type UndefinedDisguise. We can't inject undefined -directly, therefore we use this object to disguise itself as undefined. -Then a child container registers something under the same token, it by -default resolves that new dependency. If that doesn't happen, the -resolution hits our disguise, which we then convert into undefined -using the Transform - -## Type Parameters - -• **T** - -## Parameters - -### token - -`string` - -## Returns - -`Function` - -### Parameters - -#### target - -`any` - -#### propertyKey - -`undefined` | `string` | `symbol` - -#### parameterIndex - -`number` - -### Returns - -`any` diff --git a/src/pages/docs/reference/common/functions/isSubtypeOfName.md b/src/pages/docs/reference/common/functions/isSubtypeOfName.md deleted file mode 100644 index 2986ed7..0000000 --- a/src/pages/docs/reference/common/functions/isSubtypeOfName.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: isSubtypeOfName ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / isSubtypeOfName - -# Function: isSubtypeOfName() - -> **isSubtypeOfName**(`clas`, `name`): `boolean` - -Defined in: [packages/common/src/utils.ts:181](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L181) - -Returns a boolean indicating whether a given class is a subclass of another class, -indicated by the name parameter. - -## Parameters - -### clas - -[`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\> - -### name - -`string` - -## Returns - -`boolean` diff --git a/src/pages/docs/reference/common/functions/mapSequential.md b/src/pages/docs/reference/common/functions/mapSequential.md deleted file mode 100644 index 4b06604..0000000 --- a/src/pages/docs/reference/common/functions/mapSequential.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: mapSequential ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / mapSequential - -# Function: mapSequential() - -> **mapSequential**\<`T`, `R`\>(`array`, `f`): `Promise`\<`R`[]\> - -Defined in: [packages/common/src/utils.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L75) - -## Type Parameters - -• **T** - -• **R** - -## Parameters - -### array - -`T`[] - -### f - -(`element`, `index`, `array`) => `Promise`\<`R`\> - -## Returns - -`Promise`\<`R`[]\> diff --git a/src/pages/docs/reference/common/functions/noop.md b/src/pages/docs/reference/common/functions/noop.md deleted file mode 100644 index b9df3dc..0000000 --- a/src/pages/docs/reference/common/functions/noop.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: noop ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / noop - -# Function: noop() - -> **noop**(): `void` - -Defined in: [packages/common/src/utils.ts:103](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L103) - -## Returns - -`void` diff --git a/src/pages/docs/reference/common/functions/prefixToField.md b/src/pages/docs/reference/common/functions/prefixToField.md deleted file mode 100644 index 8aebadc..0000000 --- a/src/pages/docs/reference/common/functions/prefixToField.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: prefixToField ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / prefixToField - -# Function: prefixToField() - -> **prefixToField**(`prefix`): `Field` - -Defined in: [packages/common/src/utils.ts:145](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L145) - -## Parameters - -### prefix - -`string` - -## Returns - -`Field` diff --git a/src/pages/docs/reference/common/functions/provableMethod.md b/src/pages/docs/reference/common/functions/provableMethod.md deleted file mode 100644 index 7d41395..0000000 --- a/src/pages/docs/reference/common/functions/provableMethod.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: provableMethod ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / provableMethod - -# Function: provableMethod() - -> **provableMethod**(`isFirstParameterPublicInput`, `executionContext`): \<`Target`\>(`target`, `methodName`, `descriptor`) => `TypedPropertyDescriptor`\<(...`args`) => `any`\> - -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L70) - -Decorates a provable method on a 'prover class', depending on -if proofs are enabled or not, either runs the respective zkProgram prover, -or simulates the method execution and issues a mock proof. - -## Parameters - -### isFirstParameterPublicInput - -`boolean` = `true` - -### executionContext - -[`ProvableMethodExecutionContext`](../classes/ProvableMethodExecutionContext.md) = `...` - -## Returns - -`Function` - -### Type Parameters - -• **Target** *extends* [`ZkProgrammable`](../classes/ZkProgrammable.md)\<`any`, `any`\> \| [`WithZkProgrammable`](../interfaces/WithZkProgrammable.md)\<`any`, `any`\> - -### Parameters - -#### target - -`Target` - -#### methodName - -`string` - -#### descriptor - -`TypedPropertyDescriptor`\<(...`args`) => `any`\> - -### Returns - -`TypedPropertyDescriptor`\<(...`args`) => `any`\> diff --git a/src/pages/docs/reference/common/functions/range.md b/src/pages/docs/reference/common/functions/range.md deleted file mode 100644 index cb75f1b..0000000 --- a/src/pages/docs/reference/common/functions/range.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: range ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / range - -# Function: range() - -> **range**(`startOrEnd`, `endOrNothing`?): `number`[] - -Defined in: [packages/common/src/utils.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L43) - -## Parameters - -### startOrEnd - -`number` - -### endOrNothing? - -`number` - -## Returns - -`number`[] diff --git a/src/pages/docs/reference/common/functions/reduceSequential.md b/src/pages/docs/reference/common/functions/reduceSequential.md deleted file mode 100644 index 63d7e6a..0000000 --- a/src/pages/docs/reference/common/functions/reduceSequential.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: reduceSequential ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / reduceSequential - -# Function: reduceSequential() - -> **reduceSequential**\<`T`, `U`\>(`array`, `callbackfn`, `initialValue`): `Promise`\<`U`\> - -Defined in: [packages/common/src/utils.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L56) - -## Type Parameters - -• **T** - -• **U** - -## Parameters - -### array - -`T`[] - -### callbackfn - -(`previousValue`, `currentValue`, `currentIndex`, `array`) => `Promise`\<`U`\> - -### initialValue - -`U` - -## Returns - -`Promise`\<`U`\> diff --git a/src/pages/docs/reference/common/functions/requireTrue.md b/src/pages/docs/reference/common/functions/requireTrue.md deleted file mode 100644 index b5b1bb2..0000000 --- a/src/pages/docs/reference/common/functions/requireTrue.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: requireTrue ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / requireTrue - -# Function: requireTrue() - -> **requireTrue**(`condition`, `errorOrFunction`): `void` - -Defined in: [packages/common/src/utils.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L11) - -## Parameters - -### condition - -`boolean` - -### errorOrFunction - -`Error` | () => `Error` - -## Returns - -`void` diff --git a/src/pages/docs/reference/common/functions/safeParseJson.md b/src/pages/docs/reference/common/functions/safeParseJson.md deleted file mode 100644 index dc90b95..0000000 --- a/src/pages/docs/reference/common/functions/safeParseJson.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: safeParseJson ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / safeParseJson - -# Function: safeParseJson() - -> **safeParseJson**\<`T`\>(`json`): `T` - -Defined in: [packages/common/src/utils.ts:197](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L197) - -## Type Parameters - -• **T** - -## Parameters - -### json - -`string` - -## Returns - -`T` diff --git a/src/pages/docs/reference/common/functions/sleep.md b/src/pages/docs/reference/common/functions/sleep.md deleted file mode 100644 index abf5646..0000000 --- a/src/pages/docs/reference/common/functions/sleep.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: sleep ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / sleep - -# Function: sleep() - -> **sleep**(`ms`): `Promise`\<`void`\> - -Defined in: [packages/common/src/utils.ts:126](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L126) - -## Parameters - -### ms - -`number` - -## Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/common/functions/splitArray.md b/src/pages/docs/reference/common/functions/splitArray.md deleted file mode 100644 index 98cde3c..0000000 --- a/src/pages/docs/reference/common/functions/splitArray.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: splitArray ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / splitArray - -# Function: splitArray() - -> **splitArray**\<`T`, `K`\>(`arr`, `split`): `Record`\<`K`, `T`[] \| `undefined`\> - -Defined in: [packages/common/src/utils.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L26) - -Utility function to split an array of type T into a record based on a -function T => K that determines the key of each record - -## Type Parameters - -• **T** - -• **K** *extends* `string` \| `number` - -## Parameters - -### arr - -`T`[] - -### split - -(`t`) => `K` - -## Returns - -`Record`\<`K`, `T`[] \| `undefined`\> diff --git a/src/pages/docs/reference/common/functions/toProver.md b/src/pages/docs/reference/common/functions/toProver.md deleted file mode 100644 index 8fa2183..0000000 --- a/src/pages/docs/reference/common/functions/toProver.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: toProver ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / toProver - -# Function: toProver() - -> **toProver**(`methodName`, `simulatedMethod`, `isFirstParameterPublicInput`, ...`args`): (`this`) => `Promise`\<`Proof`\<`any`, `any`\>\> - -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L20) - -## Parameters - -### methodName - -`string` - -### simulatedMethod - -[`DecoratedMethod`](../type-aliases/DecoratedMethod.md) - -### isFirstParameterPublicInput - -`boolean` - -### args - -...[`ArgumentTypes`](../type-aliases/ArgumentTypes.md) - -## Returns - -`Function` - -### Parameters - -#### this - -[`ZkProgrammable`](../classes/ZkProgrammable.md)\<`any`, `any`\> - -### Returns - -`Promise`\<`Proof`\<`any`, `any`\>\> diff --git a/src/pages/docs/reference/common/functions/verifyToMockable.md b/src/pages/docs/reference/common/functions/verifyToMockable.md deleted file mode 100644 index 180a889..0000000 --- a/src/pages/docs/reference/common/functions/verifyToMockable.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: verifyToMockable ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / verifyToMockable - -# Function: verifyToMockable() - -> **verifyToMockable**\<`PublicInput`, `PublicOutput`\>(`verify`, `__namedParameters`): (`proof`) => `Promise`\<`boolean`\> - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L59) - -## Type Parameters - -• **PublicInput** - -• **PublicOutput** - -## Parameters - -### verify - -[`Verify`](../interfaces/Verify.md)\<`PublicInput`, `PublicOutput`\> - -### \_\_namedParameters - -[`AreProofsEnabled`](../interfaces/AreProofsEnabled.md) - -## Returns - -`Function` - -### Parameters - -#### proof - -`Proof`\<`PublicInput`, `PublicOutput`\> - -### Returns - -`Promise`\<`boolean`\> diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md deleted file mode 100644 index e280113..0000000 --- a/src/pages/docs/reference/common/interfaces/AbstractMerkleTree.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: AbstractMerkleTree ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / AbstractMerkleTree - -# Interface: AbstractMerkleTree - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L41) - -## Extended by - -- [`RollupMerkleTree`](../classes/RollupMerkleTree.md) -- [`FeeTree`](../../library/classes/FeeTree.md) -- [`BlockHashMerkleTree`](../../protocol/classes/BlockHashMerkleTree.md) -- [`TokenBridgeTree`](../../protocol/classes/TokenBridgeTree.md) -- [`VKTree`](../../protocol/classes/VKTree.md) - -## Properties - -### leafCount - -> `readonly` **leafCount**: `bigint` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L43) - -*** - -### store - -> **store**: [`MerkleTreeStore`](MerkleTreeStore.md) - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L42) - -## Methods - -### assertIndexRange() - -> **assertIndexRange**(`index`): `void` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L45) - -#### Parameters - -##### index - -`bigint` - -#### Returns - -`void` - -*** - -### fill() - -> **fill**(`leaves`): `void` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L81) - -Fills all leaves of the tree. - -#### Parameters - -##### leaves - -`Field`[] - -Values to fill the leaves with. - -#### Returns - -`void` - -*** - -### getNode() - -> **getNode**(`level`, `index`): `Field` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L53) - -Returns a node which lives at a given index and level. - -#### Parameters - -##### level - -`number` - -Level of the node. - -##### index - -`bigint` - -Index of the node. - -#### Returns - -`Field` - -The data of the node. - -*** - -### getRoot() - -> **getRoot**(): `Field` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L59) - -Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). - -#### Returns - -`Field` - -The root of the Merkle Tree. - -*** - -### getWitness() - -> **getWitness**(`index`): [`AbstractMerkleWitness`](AbstractMerkleWitness.md) - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L75) - -Returns the witness (also known as -[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) -for the leaf at the given index. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -#### Returns - -[`AbstractMerkleWitness`](AbstractMerkleWitness.md) - -The witness that belongs to the leaf. - -*** - -### setLeaf() - -> **setLeaf**(`index`, `leaf`): `void` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L66) - -Sets the value of a leaf node at a given index to a given value. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -##### leaf - -`Field` - -New value. - -#### Returns - -`void` diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md deleted file mode 100644 index 1fc2c58..0000000 --- a/src/pages/docs/reference/common/interfaces/AbstractMerkleTreeClass.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: AbstractMerkleTreeClass ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / AbstractMerkleTreeClass - -# Interface: AbstractMerkleTreeClass - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L84) - -## Constructors - -### new AbstractMerkleTreeClass() - -> **new AbstractMerkleTreeClass**(`store`): [`AbstractMerkleTree`](AbstractMerkleTree.md) - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L85) - -#### Parameters - -##### store - -[`MerkleTreeStore`](MerkleTreeStore.md) - -#### Returns - -[`AbstractMerkleTree`](AbstractMerkleTree.md) - -## Properties - -### EMPTY\_ROOT - -> **EMPTY\_ROOT**: `bigint` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L92) - -*** - -### HEIGHT - -> **HEIGHT**: `number` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:90](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L90) - -*** - -### WITNESS - -> **WITNESS**: [`TypedClass`](../type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:87](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L87) - -#### Type declaration - -##### dummy() - -> **dummy**: () => [`AbstractMerkleWitness`](AbstractMerkleWitness.md) - -###### Returns - -[`AbstractMerkleWitness`](AbstractMerkleWitness.md) - -## Accessors - -### leafCount - -#### Get Signature - -> **get** **leafCount**(): `bigint` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L94) - -##### Returns - -`bigint` diff --git a/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md b/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md deleted file mode 100644 index 1bffa24..0000000 --- a/src/pages/docs/reference/common/interfaces/AbstractMerkleWitness.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: AbstractMerkleWitness ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / AbstractMerkleWitness - -# Interface: AbstractMerkleWitness - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L14) - -## Extends - -- `StructTemplate` - -## Properties - -### isLeft - -> **isLeft**: `Bool`[] - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L11) - -#### Inherited from - -`StructTemplate.isLeft` - -*** - -### path - -> **path**: `Field`[] - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L10) - -#### Inherited from - -`StructTemplate.path` - -## Methods - -### calculateIndex() - -> **calculateIndex**(): `Field` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L28) - -Calculates the index of the leaf node that belongs to this Witness. - -#### Returns - -`Field` - -Index of the leaf. - -*** - -### calculateRoot() - -> **calculateRoot**(`hash`): `Field` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L22) - -Calculates a root depending on the leaf value. - -#### Parameters - -##### hash - -`Field` - -#### Returns - -`Field` - -The calculated root. - -*** - -### checkMembership() - -> **checkMembership**(`root`, `key`, `value`): `Bool` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L30) - -#### Parameters - -##### root - -`Field` - -##### key - -`Field` - -##### value - -`Field` - -#### Returns - -`Bool` - -*** - -### checkMembershipGetRoots() - -> **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L32) - -#### Parameters - -##### root - -`Field` - -##### key - -`Field` - -##### value - -`Field` - -#### Returns - -\[`Bool`, `Field`, `Field`\] - -*** - -### height() - -> **height**(): `number` - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L15) - -#### Returns - -`number` - -*** - -### toShortenedEntries() - -> **toShortenedEntries**(): `string`[] - -Defined in: [packages/common/src/trees/RollupMerkleTree.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/RollupMerkleTree.ts#L38) - -#### Returns - -`string`[] diff --git a/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md b/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md deleted file mode 100644 index 1b986e8..0000000 --- a/src/pages/docs/reference/common/interfaces/AreProofsEnabled.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: AreProofsEnabled ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / AreProofsEnabled - -# Interface: AreProofsEnabled - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L23) - -## Properties - -### areProofsEnabled - -> **areProofsEnabled**: `boolean` - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L24) - -*** - -### setProofsEnabled() - -> **setProofsEnabled**: (`areProofsEnabled`) => `void` - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L25) - -#### Parameters - -##### areProofsEnabled - -`boolean` - -#### Returns - -`void` diff --git a/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md b/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md deleted file mode 100644 index 0f3b43a..0000000 --- a/src/pages/docs/reference/common/interfaces/BaseModuleInstanceType.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: BaseModuleInstanceType ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / BaseModuleInstanceType - -# Interface: BaseModuleInstanceType - -Defined in: [packages/common/src/config/ModuleContainer.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L73) - -## Extends - -- [`ChildContainerCreatable`](ChildContainerCreatable.md).[`Configurable`](Configurable.md)\<`unknown`\> - -## Properties - -### config - -> **config**: `unknown` - -Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L19) - -#### Inherited from - -[`Configurable`](Configurable.md).[`config`](Configurable.md#config) - -*** - -### create() - -> **create**: (`childContainerProvider`) => `void` - -Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ChildContainerCreatable.ts#L4) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ChildContainerCreatable`](ChildContainerCreatable.md).[`create`](ChildContainerCreatable.md#create) diff --git a/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md b/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md deleted file mode 100644 index 5d37ba1..0000000 --- a/src/pages/docs/reference/common/interfaces/ChildContainerCreatable.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ChildContainerCreatable ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ChildContainerCreatable - -# Interface: ChildContainerCreatable - -Defined in: [packages/common/src/config/ChildContainerCreatable.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ChildContainerCreatable.ts#L3) - -## Extended by - -- [`BaseModuleInstanceType`](BaseModuleInstanceType.md) - -## Properties - -### create() - -> **create**: (`childContainerProvider`) => `void` - -Defined in: [packages/common/src/config/ChildContainerCreatable.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ChildContainerCreatable.ts#L4) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](ChildContainerProvider.md) - -#### Returns - -`void` diff --git a/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md b/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md deleted file mode 100644 index 10fb096..0000000 --- a/src/pages/docs/reference/common/interfaces/ChildContainerProvider.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: ChildContainerProvider ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ChildContainerProvider - -# Interface: ChildContainerProvider() - -Defined in: [packages/common/src/config/ChildContainerProvider.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ChildContainerProvider.ts#L3) - -> **ChildContainerProvider**(): `DependencyContainer` - -Defined in: [packages/common/src/config/ChildContainerProvider.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ChildContainerProvider.ts#L4) - -## Returns - -`DependencyContainer` diff --git a/src/pages/docs/reference/common/interfaces/CompilableModule.md b/src/pages/docs/reference/common/interfaces/CompilableModule.md deleted file mode 100644 index b642ef2..0000000 --- a/src/pages/docs/reference/common/interfaces/CompilableModule.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: CompilableModule ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CompilableModule - -# Interface: CompilableModule - -Defined in: [packages/common/src/compiling/CompilableModule.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompilableModule.ts#L4) - -## Extended by - -- [`BlockProvable`](../../protocol/interfaces/BlockProvable.md) -- [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../type-aliases/ArtifactRecord.md)\> - -Defined in: [packages/common/src/compiling/CompilableModule.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/CompilableModule.ts#L5) - -#### Parameters - -##### registry - -[`CompileRegistry`](../classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`void` \| [`ArtifactRecord`](../type-aliases/ArtifactRecord.md)\> diff --git a/src/pages/docs/reference/common/interfaces/Compile.md b/src/pages/docs/reference/common/interfaces/Compile.md deleted file mode 100644 index 861085b..0000000 --- a/src/pages/docs/reference/common/interfaces/Compile.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Compile ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / Compile - -# Interface: Compile() - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L32) - -> **Compile**(): `Promise`\<[`CompileArtifact`](CompileArtifact.md)\> - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L33) - -## Returns - -`Promise`\<[`CompileArtifact`](CompileArtifact.md)\> diff --git a/src/pages/docs/reference/common/interfaces/CompileArtifact.md b/src/pages/docs/reference/common/interfaces/CompileArtifact.md deleted file mode 100644 index 5cdda97..0000000 --- a/src/pages/docs/reference/common/interfaces/CompileArtifact.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: CompileArtifact ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CompileArtifact - -# Interface: CompileArtifact - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L16) - -## Properties - -### verificationKey - -> **verificationKey**: `object` - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L17) - -#### data - -> **data**: `string` - -#### hash - -> **hash**: `Field` diff --git a/src/pages/docs/reference/common/interfaces/Configurable.md b/src/pages/docs/reference/common/interfaces/Configurable.md deleted file mode 100644 index 171c4ad..0000000 --- a/src/pages/docs/reference/common/interfaces/Configurable.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Configurable ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / Configurable - -# Interface: Configurable\ - -Defined in: [packages/common/src/config/ConfigurableModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L18) - -## Extended by - -- [`BaseModuleInstanceType`](BaseModuleInstanceType.md) - -## Type Parameters - -• **Config** - -## Properties - -### config - -> **config**: `Config` - -Defined in: [packages/common/src/config/ConfigurableModule.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L19) diff --git a/src/pages/docs/reference/common/interfaces/DependencyFactory.md b/src/pages/docs/reference/common/interfaces/DependencyFactory.md deleted file mode 100644 index b015e54..0000000 --- a/src/pages/docs/reference/common/interfaces/DependencyFactory.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: DependencyFactory ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / DependencyFactory - -# Interface: DependencyFactory - -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L34) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Extended by - -- [`BaseLayer`](../../sequencer/interfaces/BaseLayer.md) -- [`StorageDependencyFactory`](../../sequencer/interfaces/StorageDependencyFactory.md) - -## Properties - -### dependencies() - -> **dependencies**: () => [`DependencyRecord`](../type-aliases/DependencyRecord.md) - -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L35) - -#### Returns - -[`DependencyRecord`](../type-aliases/DependencyRecord.md) diff --git a/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md b/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md deleted file mode 100644 index 6367180..0000000 --- a/src/pages/docs/reference/common/interfaces/EventEmittingComponent.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: EventEmittingComponent ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventEmittingComponent - -# Interface: EventEmittingComponent\ - -Defined in: [packages/common/src/events/EventEmittingComponent.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmittingComponent.ts#L5) - -## Extended by - -- [`Mempool`](../../sequencer/interfaces/Mempool.md) - -## Type Parameters - -• **Events** *extends* [`EventsRecord`](../type-aliases/EventsRecord.md) - -## Properties - -### events - -> **events**: [`EventEmitter`](../classes/EventEmitter.md)\<`Events`\> - -Defined in: [packages/common/src/events/EventEmittingComponent.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmittingComponent.ts#L6) diff --git a/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md b/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md deleted file mode 100644 index 86f99f9..0000000 --- a/src/pages/docs/reference/common/interfaces/EventEmittingContainer.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: EventEmittingContainer ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventEmittingContainer - -# Interface: EventEmittingContainer\ - -Defined in: [packages/common/src/events/EventEmittingComponent.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmittingComponent.ts#L9) - -## Type Parameters - -• **Events** *extends* [`EventsRecord`](../type-aliases/EventsRecord.md) - -## Properties - -### containerEvents - -> **containerEvents**: [`EventEmitter`](../classes/EventEmitter.md)\<`Events`\> - -Defined in: [packages/common/src/events/EventEmittingComponent.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmittingComponent.ts#L10) diff --git a/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md b/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md deleted file mode 100644 index 9df5a97..0000000 --- a/src/pages/docs/reference/common/interfaces/MerkleTreeStore.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: MerkleTreeStore ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MerkleTreeStore - -# Interface: MerkleTreeStore - -Defined in: [packages/common/src/trees/MerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MerkleTreeStore.ts#L1) - -## Properties - -### getNode() - -> **getNode**: (`key`, `level`) => `undefined` \| `bigint` - -Defined in: [packages/common/src/trees/MerkleTreeStore.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MerkleTreeStore.ts#L4) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -#### Returns - -`undefined` \| `bigint` - -*** - -### setNode() - -> **setNode**: (`key`, `level`, `value`) => `void` - -Defined in: [packages/common/src/trees/MerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/trees/MerkleTreeStore.ts#L2) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -##### value - -`bigint` - -#### Returns - -`void` diff --git a/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md b/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md deleted file mode 100644 index 7d325a1..0000000 --- a/src/pages/docs/reference/common/interfaces/ModuleContainerDefinition.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: ModuleContainerDefinition ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModuleContainerDefinition - -# Interface: ModuleContainerDefinition\ - -Defined in: [packages/common/src/config/ModuleContainer.ts:115](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L115) - -Parameters required when creating a module container instance - -## Type Parameters - -• **Modules** *extends* [`ModulesRecord`](ModulesRecord.md) - -## Properties - -### ~~config?~~ - -> `optional` **config**: [`ModulesConfig`](../type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: [packages/common/src/config/ModuleContainer.ts:121](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L121) - -#### Deprecated - -*** - -### modules - -> **modules**: `Modules` - -Defined in: [packages/common/src/config/ModuleContainer.ts:116](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L116) diff --git a/src/pages/docs/reference/common/interfaces/ModulesRecord.md b/src/pages/docs/reference/common/interfaces/ModulesRecord.md deleted file mode 100644 index 1b53685..0000000 --- a/src/pages/docs/reference/common/interfaces/ModulesRecord.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: ModulesRecord ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModulesRecord - -# Interface: ModulesRecord\ - -Defined in: [packages/common/src/config/ModuleContainer.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L81) - -## Type Parameters - -• **ModuleType** *extends* [`BaseModuleType`](../type-aliases/BaseModuleType.md) = [`BaseModuleType`](../type-aliases/BaseModuleType.md) - -## Indexable - -\[`name`: `string`\]: `ModuleType` diff --git a/src/pages/docs/reference/common/interfaces/PlainZkProgram.md b/src/pages/docs/reference/common/interfaces/PlainZkProgram.md deleted file mode 100644 index 154cf2e..0000000 --- a/src/pages/docs/reference/common/interfaces/PlainZkProgram.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -title: PlainZkProgram ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / PlainZkProgram - -# Interface: PlainZkProgram\ - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L36) - -## Type Parameters - -• **PublicInput** = `undefined` - -• **PublicOutput** = `void` - -## Properties - -### analyzeMethods() - -> **analyzeMethods**: () => `Promise`\<`Record`\<`string`, \{ `digest`: `string`; `gates`: `Gate`[]; `publicInputSize`: `number`; `rows`: `number`; `print`: `void`; `summary`: `Partial`\<`Record`\<`GateType` \| `"Total rows"`, `number`\>\>; \}\>\> - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L54) - -#### Returns - -`Promise`\<`Record`\<`string`, \{ `digest`: `string`; `gates`: `Gate`[]; `publicInputSize`: `number`; `rows`: `number`; `print`: `void`; `summary`: `Partial`\<`Record`\<`GateType` \| `"Total rows"`, `number`\>\>; \}\>\> - -*** - -### compile - -> **compile**: [`Compile`](Compile.md) - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L38) - -*** - -### methods - -> **methods**: `Record`\<`string`, (...`args`) => `Promise`\<`Proof`\<`PublicInput`, `PublicOutput`\>\> \| (`publicInput`, ...`args`) => `Promise`\<`Proof`\<`PublicInput`, `PublicOutput`\>\>\> - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L46) - -*** - -### name - -> **name**: `string` - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L37) - -*** - -### Proof() - -> **Proof**: (`__namedParameters`) => `object` - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L40) - -#### Parameters - -##### \_\_namedParameters - -###### maxProofsVerified - -`0` \| `1` \| `2` - -###### proof - -`unknown` - -###### publicInput - -`PublicInput` \| `StructPure`\<`PublicInput`\> *extends* `GenericProvable`\<`PublicInput`, `any`, `Field`\> ? `PublicInput` : `PublicInput` - -###### publicOutput - -`PublicOutput` \| `StructPure`\<`PublicOutput`\> *extends* `GenericProvable`\<`PublicOutput`, `any`, `Field`\> ? `PublicOutput` : `PublicOutput` - -#### Returns - -`object` - -##### maxProofsVerified - -> **maxProofsVerified**: `0` \| `1` \| `2` - -##### proof - -> **proof**: `unknown` - -##### publicInput - -> **publicInput**: `PublicInput` \| `StructPure`\<`PublicInput`\> *extends* `GenericProvable`\<`PublicInput`, `any`, `Field`\> ? `PublicInput` : `PublicInput` - -##### publicOutput - -> **publicOutput**: `PublicOutput` \| `StructPure`\<`PublicOutput`\> *extends* `GenericProvable`\<`PublicOutput`, `any`, `Field`\> ? `PublicOutput` : `PublicOutput` - -##### shouldVerify - -> **shouldVerify**: `Bool` - -##### toJSON() - -###### Returns - -`JsonProof` - -##### verify() - -###### Returns - -`void` - -##### verifyIf() - -###### Parameters - -###### condition - -`Bool` - -###### Returns - -`void` - -#### publicInputType - -> **publicInputType**: `FlexibleProvablePure`\<`PublicInput`\> - -#### publicOutputType - -> **publicOutputType**: `FlexibleProvablePure`\<`PublicOutput`\> - -#### tag() - -> **tag**: () => `object` - -##### Returns - -`object` - -###### name - -> **name**: `string` - -###### publicInputType - -> **publicInputType**: `FlexibleProvablePure`\<`PublicInput`\> - -###### publicOutputType - -> **publicOutputType**: `FlexibleProvablePure`\<`PublicOutput`\> - -#### dummy() - -Dummy proof. This can be useful for ZkPrograms that handle the base case in the same -method as the inductive case, using a pattern like this: - -```ts -method(proof: SelfProof, isRecursive: Bool) { - proof.verifyIf(isRecursive); - // ... -} -``` - -To use such a method in the base case, you need a dummy proof: - -```ts -let dummy = await MyProof.dummy(publicInput, publicOutput, 1); -await myProgram.myMethod(dummy, Bool(false)); -``` - -**Note**: The types of `publicInput` and `publicOutput`, as well as the `maxProofsVerified` parameter, -must match your ZkProgram. `maxProofsVerified` is the maximum number of proofs that any of your methods take as arguments. - -##### Type Parameters - -• **Input** - -• **OutPut** - -##### Parameters - -###### publicInput - -`Input` - -###### publicOutput - -`OutPut` - -###### maxProofsVerified - -`0` | `1` | `2` - -###### domainLog2? - -`number` - -##### Returns - -`Promise`\<`Proof`\<`Input`, `OutPut`\>\> - -#### fromJSON() - -##### Type Parameters - -• **S** *extends* `Subclass`\<*typeof* `Proof`\> - -##### Parameters - -###### this - -`S` - -###### \_\_namedParameters - -`JsonProof` - -##### Returns - -`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -*** - -### verify - -> **verify**: [`Verify`](Verify.md)\<`PublicInput`, `PublicOutput`\> - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L39) diff --git a/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md b/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md deleted file mode 100644 index de82ab9..0000000 --- a/src/pages/docs/reference/common/interfaces/StaticConfigurableModule.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: StaticConfigurableModule ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / StaticConfigurableModule - -# Interface: StaticConfigurableModule\ - -Defined in: [packages/common/src/config/ConfigurableModule.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L55) - -## Type Parameters - -• **Config** - -## Properties - -### presets - -> **presets**: [`Presets`](../type-aliases/Presets.md)\<`Config`\> - -Defined in: [packages/common/src/config/ConfigurableModule.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L56) diff --git a/src/pages/docs/reference/common/interfaces/ToFieldable.md b/src/pages/docs/reference/common/interfaces/ToFieldable.md deleted file mode 100644 index 969e8a9..0000000 --- a/src/pages/docs/reference/common/interfaces/ToFieldable.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: ToFieldable ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ToFieldable - -# Interface: ToFieldable - -Defined in: [packages/common/src/utils.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L105) - -## Properties - -### toFields() - -> **toFields**: () => `Field`[] - -Defined in: [packages/common/src/utils.ts:106](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L106) - -#### Returns - -`Field`[] diff --git a/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md b/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md deleted file mode 100644 index 45ecb23..0000000 --- a/src/pages/docs/reference/common/interfaces/ToFieldableStatic.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: ToFieldableStatic ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ToFieldableStatic - -# Interface: ToFieldableStatic - -Defined in: [packages/common/src/utils.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L109) - -## Properties - -### toFields() - -> **toFields**: (`value`) => `Field`[] - -Defined in: [packages/common/src/utils.ts:110](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L110) - -#### Parameters - -##### value - -`unknown` - -#### Returns - -`Field`[] diff --git a/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md b/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md deleted file mode 100644 index 9bd0372..0000000 --- a/src/pages/docs/reference/common/interfaces/ToJSONableStatic.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: ToJSONableStatic ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ToJSONableStatic - -# Interface: ToJSONableStatic - -Defined in: [packages/common/src/utils.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L113) - -## Properties - -### toJSON() - -> **toJSON**: (`value`) => `any` - -Defined in: [packages/common/src/utils.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L114) - -#### Parameters - -##### value - -`unknown` - -#### Returns - -`any` diff --git a/src/pages/docs/reference/common/interfaces/Verify.md b/src/pages/docs/reference/common/interfaces/Verify.md deleted file mode 100644 index a7426bf..0000000 --- a/src/pages/docs/reference/common/interfaces/Verify.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Verify ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / Verify - -# Interface: Verify()\ - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L28) - -## Type Parameters - -• **PublicInput** - -• **PublicOutput** - -> **Verify**(`proof`): `Promise`\<`boolean`\> - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L29) - -## Parameters - -### proof - -`Proof`\<`PublicInput`, `PublicOutput`\> - -## Returns - -`Promise`\<`boolean`\> diff --git a/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md b/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md deleted file mode 100644 index bd04531..0000000 --- a/src/pages/docs/reference/common/interfaces/WithZkProgrammable.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: WithZkProgrammable ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / WithZkProgrammable - -# Interface: WithZkProgrammable\ - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:146](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L146) - -## Extended by - -- [`RuntimeEnvironment`](../../module/interfaces/RuntimeEnvironment.md) -- [`BlockProvable`](../../protocol/interfaces/BlockProvable.md) -- [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) - -## Type Parameters - -• **PublicInput** = `undefined` - -• **PublicOutput** = `void` - -## Properties - -### zkProgrammable - -> **zkProgrammable**: [`ZkProgrammable`](../classes/ZkProgrammable.md)\<`PublicInput`, `PublicOutput`\> - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:150](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L150) diff --git a/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md b/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md deleted file mode 100644 index 3a1e06b..0000000 --- a/src/pages/docs/reference/common/type-aliases/ArgumentTypes.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: ArgumentTypes ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ArgumentTypes - -# Type Alias: ArgumentTypes - -> **ArgumentTypes**: ([`O1JSPrimitive`](O1JSPrimitive.md) \| `Proof`\<`unknown`, `unknown`\> \| `DynamicProof`\<`unknown`, `unknown`\>)[] - -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L9) diff --git a/src/pages/docs/reference/common/type-aliases/ArrayElement.md b/src/pages/docs/reference/common/type-aliases/ArrayElement.md deleted file mode 100644 index d92b1a5..0000000 --- a/src/pages/docs/reference/common/type-aliases/ArrayElement.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: ArrayElement ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ArrayElement - -# Type Alias: ArrayElement\ - -> **ArrayElement**\<`ArrayType`\>: `ArrayType` *extends* readonly infer ElementType[] ? `ElementType` : `never` - -Defined in: [packages/common/src/types.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L18) - -Utility type to infer element type from an array type - -## Type Parameters - -• **ArrayType** *extends* readonly `unknown`[] diff --git a/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md b/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md deleted file mode 100644 index f366ad1..0000000 --- a/src/pages/docs/reference/common/type-aliases/ArtifactRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: ArtifactRecord ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ArtifactRecord - -# Type Alias: ArtifactRecord - -> **ArtifactRecord**: `Record`\<`string`, [`CompileArtifact`](../interfaces/CompileArtifact.md)\> - -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/AtomicCompileHelper.ts#L10) diff --git a/src/pages/docs/reference/common/type-aliases/BaseModuleType.md b/src/pages/docs/reference/common/type-aliases/BaseModuleType.md deleted file mode 100644 index 85b0e1b..0000000 --- a/src/pages/docs/reference/common/type-aliases/BaseModuleType.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: BaseModuleType ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / BaseModuleType - -# Type Alias: BaseModuleType - -> **BaseModuleType**: [`TypedClass`](TypedClass.md)\<[`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md)\> - -Defined in: [packages/common/src/config/ModuleContainer.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L78) diff --git a/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md b/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md deleted file mode 100644 index c29bca9..0000000 --- a/src/pages/docs/reference/common/type-aliases/CapitalizeAny.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: CapitalizeAny ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CapitalizeAny - -# Type Alias: CapitalizeAny\ - -> **CapitalizeAny**\<`Key`\>: `Key` *extends* `string` ? `Capitalize`\<`Key`\> : `Key` - -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L45) - -## Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` diff --git a/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md b/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md deleted file mode 100644 index 107f650..0000000 --- a/src/pages/docs/reference/common/type-aliases/CastToEventsRecord.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: CastToEventsRecord ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CastToEventsRecord - -# Type Alias: CastToEventsRecord\ - -> **CastToEventsRecord**\<`Record`\>: `Record` *extends* [`EventsRecord`](EventsRecord.md) ? `Record` : `object` - -Defined in: [packages/common/src/events/EventEmitterProxy.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L15) - -## Type Parameters - -• **Record** diff --git a/src/pages/docs/reference/common/type-aliases/CompileTarget.md b/src/pages/docs/reference/common/type-aliases/CompileTarget.md deleted file mode 100644 index 8c6fffc..0000000 --- a/src/pages/docs/reference/common/type-aliases/CompileTarget.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: CompileTarget ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / CompileTarget - -# Type Alias: CompileTarget - -> **CompileTarget**: `object` - -Defined in: [packages/common/src/compiling/AtomicCompileHelper.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/compiling/AtomicCompileHelper.ts#L12) - -## Type declaration - -### compile() - -> **compile**: () => `Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> - -#### Returns - -`Promise`\<[`CompileArtifact`](../interfaces/CompileArtifact.md)\> - -### name - -> **name**: `string` diff --git a/src/pages/docs/reference/common/type-aliases/ContainerEvents.md b/src/pages/docs/reference/common/type-aliases/ContainerEvents.md deleted file mode 100644 index adc977a..0000000 --- a/src/pages/docs/reference/common/type-aliases/ContainerEvents.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: ContainerEvents ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ContainerEvents - -# Type Alias: ContainerEvents\ - -> **ContainerEvents**\<`Modules`\>: `{ [Key in StringKeyOf]: ModuleEvents }` - -Defined in: [packages/common/src/events/EventEmitterProxy.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L32) - -## Type Parameters - -• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md b/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md deleted file mode 100644 index da41624..0000000 --- a/src/pages/docs/reference/common/type-aliases/DecoratedMethod.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: DecoratedMethod ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / DecoratedMethod - -# Type Alias: DecoratedMethod() - -> **DecoratedMethod**: (...`args`) => `Promise`\<`unknown`\> - -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L15) - -## Parameters - -### args - -...[`ArgumentTypes`](ArgumentTypes.md) - -## Returns - -`Promise`\<`unknown`\> diff --git a/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md b/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md deleted file mode 100644 index 4aff5c2..0000000 --- a/src/pages/docs/reference/common/type-aliases/DependenciesFromModules.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: DependenciesFromModules ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / DependenciesFromModules - -# Type Alias: DependenciesFromModules\ - -> **DependenciesFromModules**\<`Modules`\>: [`FilterNeverValues`](FilterNeverValues.md)\<`{ [Key in keyof Modules]: Modules[Key] extends TypedClass ? InferDependencies> : never }`\> - -Defined in: [packages/common/src/config/ModuleContainer.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L129) - -## Type Parameters - -• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md b/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md deleted file mode 100644 index 575b402..0000000 --- a/src/pages/docs/reference/common/type-aliases/DependencyDeclaration.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: DependencyDeclaration ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / DependencyDeclaration - -# Type Alias: DependencyDeclaration\ - -> **DependencyDeclaration**\<`Dependency`\>: `ClassProvider`\<`Dependency`\> \| `FactoryProvider`\<`Dependency`\> \| `TokenProvider`\<`Dependency`\> \| `ValueProvider`\<`Dependency`\> - -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L11) - -## Type Parameters - -• **Dependency** diff --git a/src/pages/docs/reference/common/type-aliases/DependencyRecord.md b/src/pages/docs/reference/common/type-aliases/DependencyRecord.md deleted file mode 100644 index 4491936..0000000 --- a/src/pages/docs/reference/common/type-aliases/DependencyRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: DependencyRecord ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / DependencyRecord - -# Type Alias: DependencyRecord - -> **DependencyRecord**: `Record`\<`string`, [`DependencyDeclaration`](DependencyDeclaration.md)\<`unknown`\> & `object`\> - -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L17) diff --git a/src/pages/docs/reference/common/type-aliases/EventListenable.md b/src/pages/docs/reference/common/type-aliases/EventListenable.md deleted file mode 100644 index e1e80ce..0000000 --- a/src/pages/docs/reference/common/type-aliases/EventListenable.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: EventListenable ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventListenable - -# Type Alias: EventListenable\ - -> **EventListenable**\<`Events`\>: `Pick`\<[`EventEmitter`](../classes/EventEmitter.md)\<`Events`\>, `"on"` \| `"onAll"` \| `"off"`\> - -Defined in: [packages/common/src/events/EventEmitter.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitter.ts#L58) - -## Type Parameters - -• **Events** *extends* [`EventsRecord`](EventsRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/EventsRecord.md b/src/pages/docs/reference/common/type-aliases/EventsRecord.md deleted file mode 100644 index 1493ed2..0000000 --- a/src/pages/docs/reference/common/type-aliases/EventsRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: EventsRecord ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EventsRecord - -# Type Alias: EventsRecord - -> **EventsRecord**: `Record`\<`string`, `unknown`[]\> - -Defined in: [packages/common/src/events/EventEmittingComponent.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmittingComponent.ts#L3) diff --git a/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md b/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md deleted file mode 100644 index 5465185..0000000 --- a/src/pages/docs/reference/common/type-aliases/FilterNeverValues.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: FilterNeverValues ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / FilterNeverValues - -# Type Alias: FilterNeverValues\ - -> **FilterNeverValues**\<`Type`\>: `{ [Key in keyof Type as Type[Key] extends never ? never : Key]: Type[Key] }` - -Defined in: [packages/common/src/config/ModuleContainer.ts:125](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L125) - -## Type Parameters - -• **Type** *extends* `Record`\<`string`, `unknown`\> diff --git a/src/pages/docs/reference/common/type-aliases/FlattenObject.md b/src/pages/docs/reference/common/type-aliases/FlattenObject.md deleted file mode 100644 index 79bb820..0000000 --- a/src/pages/docs/reference/common/type-aliases/FlattenObject.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: FlattenObject ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / FlattenObject - -# Type Alias: FlattenObject\ - -> **FlattenObject**\<`Target`\>: [`UnionToIntersection`](UnionToIntersection.md)\<`Target`\[keyof `Target`\]\> - -Defined in: [packages/common/src/events/EventEmitterProxy.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L36) - -## Type Parameters - -• **Target** *extends* `Record`\<`string`, [`EventsRecord`](EventsRecord.md)\> diff --git a/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md b/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md deleted file mode 100644 index 8c74b24..0000000 --- a/src/pages/docs/reference/common/type-aliases/FlattenedContainerEvents.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: FlattenedContainerEvents ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / FlattenedContainerEvents - -# Type Alias: FlattenedContainerEvents\ - -> **FlattenedContainerEvents**\<`Modules`\>: [`FlattenObject`](FlattenObject.md)\<[`ContainerEvents`](ContainerEvents.md)\<`Modules`\>\> - -Defined in: [packages/common/src/events/EventEmitterProxy.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L39) - -## Type Parameters - -• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/InferDependencies.md b/src/pages/docs/reference/common/type-aliases/InferDependencies.md deleted file mode 100644 index 489da77..0000000 --- a/src/pages/docs/reference/common/type-aliases/InferDependencies.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: InferDependencies ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / InferDependencies - -# Type Alias: InferDependencies\ - -> **InferDependencies**\<`Class`\>: `Class` *extends* [`DependencyFactory`](../interfaces/DependencyFactory.md) ? [`MapDependencyRecordToTypes`](MapDependencyRecordToTypes.md)\<`ReturnType`\<`Class`\[`"dependencies"`\]\>\> : `never` - -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L54) - -## Type Parameters - -• **Class** *extends* [`BaseModuleInstanceType`](../interfaces/BaseModuleInstanceType.md) diff --git a/src/pages/docs/reference/common/type-aliases/InferProofBase.md b/src/pages/docs/reference/common/type-aliases/InferProofBase.md deleted file mode 100644 index 76e0342..0000000 --- a/src/pages/docs/reference/common/type-aliases/InferProofBase.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: InferProofBase ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / InferProofBase - -# Type Alias: InferProofBase\ - -> **InferProofBase**\<`ProofType`\>: `ProofType` *extends* `Proof`\ ? `ProofBase`\<`PI`, `PO`\> : `ProofType` *extends* `DynamicProof`\ ? `ProofBase`\<`PI`, `PO`\> : `undefined` - -Defined in: [packages/common/src/types.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L51) - -## Type Parameters - -• **ProofType** *extends* `Proof`\<`any`, `any`\> \| `DynamicProof`\<`any`, `any`\> diff --git a/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md b/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md deleted file mode 100644 index 29a0634..0000000 --- a/src/pages/docs/reference/common/type-aliases/MapDependencyRecordToTypes.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: MapDependencyRecordToTypes ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MapDependencyRecordToTypes - -# Type Alias: MapDependencyRecordToTypes\ - -> **MapDependencyRecordToTypes**\<`Record`\>: `{ [Key in keyof Record as CapitalizeAny]: TypedClass> }` - -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L48) - -## Type Parameters - -• **Record** *extends* [`DependencyRecord`](DependencyRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/MergeObjects.md b/src/pages/docs/reference/common/type-aliases/MergeObjects.md deleted file mode 100644 index b3161b6..0000000 --- a/src/pages/docs/reference/common/type-aliases/MergeObjects.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: MergeObjects ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MergeObjects - -# Type Alias: MergeObjects\ - -> **MergeObjects**\<`Input`\>: [`UnionToIntersection`](UnionToIntersection.md)\<`Input`\[keyof `Input`\]\> - -Defined in: [packages/common/src/types.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L30) - -## Type Parameters - -• **Input** *extends* `Record`\<`string`, `unknown`\> diff --git a/src/pages/docs/reference/common/type-aliases/ModuleEvents.md b/src/pages/docs/reference/common/type-aliases/ModuleEvents.md deleted file mode 100644 index 098cb72..0000000 --- a/src/pages/docs/reference/common/type-aliases/ModuleEvents.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: ModuleEvents ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModuleEvents - -# Type Alias: ModuleEvents\ - -> **ModuleEvents**\<`ModuleType`\>: `InstanceType`\<`ModuleType`\> *extends* [`EventEmittingComponent`](../interfaces/EventEmittingComponent.md)\ ? `Events` : `InstanceType`\<`ModuleType`\> *extends* [`ModuleContainer`](../classes/ModuleContainer.md)\ ? [`CastToEventsRecord`](CastToEventsRecord.md)\<[`ContainerEvents`](ContainerEvents.md)\<`NestedModules`\>\> : [`EventsRecord`](EventsRecord.md) - -Defined in: [packages/common/src/events/EventEmitterProxy.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/events/EventEmitterProxy.ts#L19) - -## Type Parameters - -• **ModuleType** *extends* [`BaseModuleType`](BaseModuleType.md) diff --git a/src/pages/docs/reference/common/type-aliases/ModulesConfig.md b/src/pages/docs/reference/common/type-aliases/ModulesConfig.md deleted file mode 100644 index 60268b3..0000000 --- a/src/pages/docs/reference/common/type-aliases/ModulesConfig.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: ModulesConfig ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModulesConfig - -# Type Alias: ModulesConfig\ - -> **ModulesConfig**\<`Modules`\>: \{ \[ConfigKey in StringKeyOf\\]: InstanceType\ extends Configurable\ ? Config extends NoConfig ? Config \| undefined : Config : never \} - -Defined in: [packages/common/src/config/ModuleContainer.ts:89](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L89) - -## Type Parameters - -• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/NoConfig.md b/src/pages/docs/reference/common/type-aliases/NoConfig.md deleted file mode 100644 index 8fe0393..0000000 --- a/src/pages/docs/reference/common/type-aliases/NoConfig.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: NoConfig ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / NoConfig - -# Type Alias: NoConfig - -> **NoConfig**: `Record`\<`never`, `never`\> - -Defined in: [packages/common/src/config/ConfigurableModule.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L22) diff --git a/src/pages/docs/reference/common/type-aliases/NonMethods.md b/src/pages/docs/reference/common/type-aliases/NonMethods.md deleted file mode 100644 index ddd6ae9..0000000 --- a/src/pages/docs/reference/common/type-aliases/NonMethods.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: NonMethods ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / NonMethods - -# Type Alias: NonMethods\ - -> **NonMethods**\<`Type`\>: `Pick`\<`Type`, `NonMethodKeys`\<`Type`\>\> - -Defined in: [packages/common/src/utils.ts:172](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L172) - -## Type Parameters - -• **Type** diff --git a/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md b/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md deleted file mode 100644 index a592eee..0000000 --- a/src/pages/docs/reference/common/type-aliases/O1JSPrimitive.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: O1JSPrimitive ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / O1JSPrimitive - -# Type Alias: O1JSPrimitive - -> **O1JSPrimitive**: `object` \| `string` \| `boolean` \| `number` - -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L8) diff --git a/src/pages/docs/reference/common/type-aliases/OmitKeys.md b/src/pages/docs/reference/common/type-aliases/OmitKeys.md deleted file mode 100644 index fa11db3..0000000 --- a/src/pages/docs/reference/common/type-aliases/OmitKeys.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: OmitKeys ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / OmitKeys - -# Type Alias: OmitKeys\ - -> **OmitKeys**\<`Record`, `Keys`\>: `{ [Key in keyof Record as Key extends Keys ? never : Key]: Record[Key] }` - -Defined in: [packages/common/src/types.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L33) - -## Type Parameters - -• **Record** - -• **Keys** diff --git a/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md b/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md deleted file mode 100644 index 812115c..0000000 --- a/src/pages/docs/reference/common/type-aliases/OverwriteObjectType.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: OverwriteObjectType ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / OverwriteObjectType - -# Type Alias: OverwriteObjectType\ - -> **OverwriteObjectType**\<`Base`, `New`\>: `{ [Key in keyof Base]: Key extends keyof New ? New[Key] : Base[Key] }` & `New` - -Defined in: [packages/common/src/types.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L47) - -## Type Parameters - -• **Base** - -• **New** diff --git a/src/pages/docs/reference/common/type-aliases/Preset.md b/src/pages/docs/reference/common/type-aliases/Preset.md deleted file mode 100644 index 3f7f83e..0000000 --- a/src/pages/docs/reference/common/type-aliases/Preset.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Preset ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / Preset - -# Type Alias: Preset\ - -> **Preset**\<`Config`\>: `Config` \| (...`args`) => `Config` - -Defined in: [packages/common/src/config/ConfigurableModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L14) - -## Type Parameters - -• **Config** diff --git a/src/pages/docs/reference/common/type-aliases/Presets.md b/src/pages/docs/reference/common/type-aliases/Presets.md deleted file mode 100644 index ac68130..0000000 --- a/src/pages/docs/reference/common/type-aliases/Presets.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Presets ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / Presets - -# Type Alias: Presets\ - -> **Presets**\<`Config`\>: `Record`\<`string`, [`Preset`](Preset.md)\<`Config`\>\> - -Defined in: [packages/common/src/config/ConfigurableModule.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ConfigurableModule.ts#L15) - -## Type Parameters - -• **Config** diff --git a/src/pages/docs/reference/common/type-aliases/ProofTypes.md b/src/pages/docs/reference/common/type-aliases/ProofTypes.md deleted file mode 100644 index f4d6bd0..0000000 --- a/src/pages/docs/reference/common/type-aliases/ProofTypes.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: ProofTypes ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ProofTypes - -# Type Alias: ProofTypes - -> **ProofTypes**: *typeof* `Proof` \| *typeof* `DynamicProof` - -Defined in: [packages/common/src/utils.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L122) diff --git a/src/pages/docs/reference/common/type-aliases/RecursivePartial.md b/src/pages/docs/reference/common/type-aliases/RecursivePartial.md deleted file mode 100644 index bf100e9..0000000 --- a/src/pages/docs/reference/common/type-aliases/RecursivePartial.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: RecursivePartial ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / RecursivePartial - -# Type Alias: RecursivePartial\ - -> **RecursivePartial**\<`T`\>: `{ [Key in keyof T]?: Partial }` - -Defined in: [packages/common/src/config/ModuleContainer.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L108) - -This type make any config partial (i.e. optional) up to the first level -So { Module: { a: { b: string } } } -will become -{ Module?: { a?: { b: string } } } -Note that b does not become optional, as we don't want nested objects to -become unreasonably partialized (for example Field). - -## Type Parameters - -• **T** diff --git a/src/pages/docs/reference/common/type-aliases/ResolvableModules.md b/src/pages/docs/reference/common/type-aliases/ResolvableModules.md deleted file mode 100644 index 78f44a6..0000000 --- a/src/pages/docs/reference/common/type-aliases/ResolvableModules.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: ResolvableModules ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ResolvableModules - -# Type Alias: ResolvableModules\ - -> **ResolvableModules**\<`Modules`\>: [`MergeObjects`](MergeObjects.md)\<[`DependenciesFromModules`](DependenciesFromModules.md)\<`Modules`\>\> & `Modules` - -Defined in: [packages/common/src/config/ModuleContainer.ts:136](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L136) - -## Type Parameters - -• **Modules** *extends* [`ModulesRecord`](../interfaces/ModulesRecord.md) diff --git a/src/pages/docs/reference/common/type-aliases/StringKeyOf.md b/src/pages/docs/reference/common/type-aliases/StringKeyOf.md deleted file mode 100644 index 2c8c72f..0000000 --- a/src/pages/docs/reference/common/type-aliases/StringKeyOf.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: StringKeyOf ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / StringKeyOf - -# Type Alias: StringKeyOf\ - -> **StringKeyOf**\<`Target`\>: `Extract`\ & `string` - -Defined in: [packages/common/src/types.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L12) - -Using simple `keyof Target` would result into the key -being `string | number | symbol`, but we want just a `string` - -## Type Parameters - -• **Target** *extends* `object` diff --git a/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md b/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md deleted file mode 100644 index 137d2eb..0000000 --- a/src/pages/docs/reference/common/type-aliases/TypeFromDependencyDeclaration.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: TypeFromDependencyDeclaration ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / TypeFromDependencyDeclaration - -# Type Alias: TypeFromDependencyDeclaration\ - -> **TypeFromDependencyDeclaration**\<`Declaration`\>: `Declaration` *extends* [`DependencyDeclaration`](DependencyDeclaration.md)\ ? `Dependency` : `never` - -Defined in: [packages/common/src/dependencyFactory/DependencyFactory.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/dependencyFactory/DependencyFactory.ts#L38) - -## Type Parameters - -• **Declaration** *extends* [`DependencyDeclaration`](DependencyDeclaration.md)\<`unknown`\> diff --git a/src/pages/docs/reference/common/type-aliases/TypedClass.md b/src/pages/docs/reference/common/type-aliases/TypedClass.md deleted file mode 100644 index d3b6cf3..0000000 --- a/src/pages/docs/reference/common/type-aliases/TypedClass.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: TypedClass ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / TypedClass - -# Type Alias: TypedClass()\ - -> **TypedClass**\<`Class`\>: (...`args`) => `Class` - -Defined in: [packages/common/src/types.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L4) - -## Type Parameters - -• **Class** - -## Parameters - -### args - -...`any`[] - -## Returns - -`Class` diff --git a/src/pages/docs/reference/common/type-aliases/UnTypedClass.md b/src/pages/docs/reference/common/type-aliases/UnTypedClass.md deleted file mode 100644 index c249369..0000000 --- a/src/pages/docs/reference/common/type-aliases/UnTypedClass.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: UnTypedClass ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / UnTypedClass - -# Type Alias: UnTypedClass() - -> **UnTypedClass**: (...`args`) => `unknown` - -Defined in: [packages/common/src/types.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L6) - -## Parameters - -### args - -...`any`[] - -## Returns - -`unknown` diff --git a/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md b/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md deleted file mode 100644 index ffa13c4..0000000 --- a/src/pages/docs/reference/common/type-aliases/UnionToIntersection.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: UnionToIntersection ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / UnionToIntersection - -# Type Alias: UnionToIntersection\ - -> **UnionToIntersection**\<`Union`\>: `Union` *extends* `any` ? (`x`) => `void` : `never` *extends* (`x`) => `void` ? `Intersection` : `never` - -Defined in: [packages/common/src/types.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L24) - -Transforms X | Y => X & Y - -## Type Parameters - -• **Union** diff --git a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md deleted file mode 100644 index f5bb8c2..0000000 --- a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: EMPTY_PUBLICKEY ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EMPTY\_PUBLICKEY - -# Variable: EMPTY\_PUBLICKEY - -> `const` **EMPTY\_PUBLICKEY**: `PublicKey` - -Defined in: [packages/common/src/types.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L42) diff --git a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md b/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md deleted file mode 100644 index 5e4116d..0000000 --- a/src/pages/docs/reference/common/variables/EMPTY_PUBLICKEY_X.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: EMPTY_PUBLICKEY_X ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / EMPTY\_PUBLICKEY\_X - -# Variable: EMPTY\_PUBLICKEY\_X - -> `const` **EMPTY\_PUBLICKEY\_X**: `Field` - -Defined in: [packages/common/src/types.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/types.ts#L41) diff --git a/src/pages/docs/reference/common/variables/MAX_FIELD.md b/src/pages/docs/reference/common/variables/MAX_FIELD.md deleted file mode 100644 index f9bd76b..0000000 --- a/src/pages/docs/reference/common/variables/MAX_FIELD.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: MAX_FIELD ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MAX\_FIELD - -# Variable: MAX\_FIELD - -> `const` **MAX\_FIELD**: `Field` - -Defined in: [packages/common/src/utils.ts:174](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/utils.ts#L174) diff --git a/src/pages/docs/reference/common/variables/MOCK_PROOF.md b/src/pages/docs/reference/common/variables/MOCK_PROOF.md deleted file mode 100644 index 8031810..0000000 --- a/src/pages/docs/reference/common/variables/MOCK_PROOF.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: MOCK_PROOF ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MOCK\_PROOF - -# Variable: MOCK\_PROOF - -> `const` **MOCK\_PROOF**: `"mock-proof"` = `"mock-proof"` - -Defined in: [packages/common/src/zkProgrammable/provableMethod.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/provableMethod.ts#L17) diff --git a/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md b/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md deleted file mode 100644 index c760760..0000000 --- a/src/pages/docs/reference/common/variables/MOCK_VERIFICATION_KEY.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: MOCK_VERIFICATION_KEY ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / MOCK\_VERIFICATION\_KEY - -# Variable: MOCK\_VERIFICATION\_KEY - -> `const` **MOCK\_VERIFICATION\_KEY**: `VerificationKey` - -Defined in: [packages/common/src/zkProgrammable/ZkProgrammable.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/zkProgrammable/ZkProgrammable.ts#L82) diff --git a/src/pages/docs/reference/common/variables/ModuleContainerErrors.md b/src/pages/docs/reference/common/variables/ModuleContainerErrors.md deleted file mode 100644 index 1195835..0000000 --- a/src/pages/docs/reference/common/variables/ModuleContainerErrors.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: ModuleContainerErrors ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / ModuleContainerErrors - -# Variable: ModuleContainerErrors - -> `const` **ModuleContainerErrors**: `object` = `errors` - -Defined in: [packages/common/src/config/ModuleContainer.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/ModuleContainer.ts#L71) - -## Type declaration - -### configNotSetInContainer() - -> **configNotSetInContainer**: (`moduleName`) => `Error` - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`Error` - -### dependencyContainerNotSet() - -> **dependencyContainerNotSet**: (`className`) => `Error` - -#### Parameters - -##### className - -`string` - -#### Returns - -`Error` - -### nonModuleDependency() - -> **nonModuleDependency**: (`runtimeModuleName`) => `Error` - -#### Parameters - -##### runtimeModuleName - -`string` - -#### Returns - -`Error` - -### onlyValidModuleNames() - -> **onlyValidModuleNames**: (`moduleName`) => `Error` - -#### Parameters - -##### moduleName - -#### Returns - -`Error` - -### unableToDecorateModule() - -> **unableToDecorateModule**: (`moduleName`) => `Error` - -#### Parameters - -##### moduleName - -`InjectionToken`\<`unknown`\> - -#### Returns - -`Error` - -### unknownDependency() - -> **unknownDependency**: (`runtimeModuleName`, `name`) => `Error` - -#### Parameters - -##### runtimeModuleName - -`string` - -##### name - -`string` - -#### Returns - -`Error` - -### validModuleInstance() - -> **validModuleInstance**: (`moduleName`, `moduleTypeName`) => `Error` - -#### Parameters - -##### moduleName - -`string` - -##### moduleTypeName - -`string` - -#### Returns - -`Error` diff --git a/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md b/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md deleted file mode 100644 index 6ae233f..0000000 --- a/src/pages/docs/reference/common/variables/injectAliasMetadataKey.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: injectAliasMetadataKey ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / injectAliasMetadataKey - -# Variable: injectAliasMetadataKey - -> `const` **injectAliasMetadataKey**: `"protokit-inject-alias"` = `"protokit-inject-alias"` - -Defined in: [packages/common/src/config/injectAlias.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/config/injectAlias.ts#L3) diff --git a/src/pages/docs/reference/common/variables/log.md b/src/pages/docs/reference/common/variables/log.md deleted file mode 100644 index 724b6db..0000000 --- a/src/pages/docs/reference/common/variables/log.md +++ /dev/null @@ -1,355 +0,0 @@ ---- -title: log ---- - -[**@proto-kit/common**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/common](../README.md) / log - -# Variable: log - -> `const` **log**: `object` - -Defined in: [packages/common/src/log.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/common/src/log.ts#L53) - -## Type declaration - -### debug() - -> **debug**: (...`args`) => `void` - -#### Parameters - -##### args - -...`unknown`[] - -#### Returns - -`void` - -### error() - -> **error**: (...`args`) => `void` - -#### Parameters - -##### args - -...`unknown`[] - -#### Returns - -`void` - -### getLevel() - -> **getLevel**: () => `0` \| `1` \| `2` \| `3` \| `4` \| `5` - -#### Returns - -`0` \| `1` \| `2` \| `3` \| `4` \| `5` - -### info() - -> **info**: (...`args`) => `void` - -#### Parameters - -##### args - -...`unknown`[] - -#### Returns - -`void` - -### provable - -> **provable**: `object` - -#### provable.debug() - -> **provable.debug**: (...`args`) => `void` - -##### Parameters - -###### args - -...`unknown`[] - -##### Returns - -`void` - -#### provable.error() - -> **provable.error**: (...`args`) => `void` - -##### Parameters - -###### args - -...`unknown`[] - -##### Returns - -`void` - -#### provable.info() - -> **provable.info**: (...`args`) => `void` - -##### Parameters - -###### args - -...`unknown`[] - -##### Returns - -`void` - -#### provable.trace() - -> **provable.trace**: (...`args`) => `void` - -##### Parameters - -###### args - -...`unknown`[] - -##### Returns - -`void` - -#### provable.warn() - -> **provable.warn**: (...`args`) => `void` - -##### Parameters - -###### args - -...`unknown`[] - -##### Returns - -`void` - -### setLevel() - -> **setLevel**: (`level`) => `void` - -#### Parameters - -##### level - -`LogLevelDesc` - -#### Returns - -`void` - -### time() - -> **time**: (`label`) => `void` - -#### Parameters - -##### label - -`string` = `"time"` - -#### Returns - -`void` - -### timeEnd - -> **timeEnd**: `object` - -#### timeEnd.debug() - -> **timeEnd.debug**: (`label`?) => `void` - -##### Parameters - -###### label? - -`string` - -##### Returns - -`void` - -#### timeEnd.error() - -> **timeEnd.error**: (`label`?) => `void` - -##### Parameters - -###### label? - -`string` - -##### Returns - -`void` - -#### timeEnd.info() - -> **timeEnd.info**: (`label`?) => `void` - -##### Parameters - -###### label? - -`string` - -##### Returns - -`void` - -#### timeEnd.trace() - -> **timeEnd.trace**: (`label`?) => `void` - -##### Parameters - -###### label? - -`string` - -##### Returns - -`void` - -#### timeEnd.warn() - -> **timeEnd.warn**: (`label`?) => `void` - -##### Parameters - -###### label? - -`string` - -##### Returns - -`void` - -### timeLog - -> **timeLog**: `object` - -#### timeLog.debug() - -> **timeLog.debug**: (`label`?) => `void` - -##### Parameters - -###### label? - -`string` - -##### Returns - -`void` - -#### timeLog.error() - -> **timeLog.error**: (`label`?) => `void` - -##### Parameters - -###### label? - -`string` - -##### Returns - -`void` - -#### timeLog.info() - -> **timeLog.info**: (`label`?) => `void` - -##### Parameters - -###### label? - -`string` - -##### Returns - -`void` - -#### timeLog.trace() - -> **timeLog.trace**: (`label`?) => `void` - -##### Parameters - -###### label? - -`string` - -##### Returns - -`void` - -#### timeLog.warn() - -> **timeLog.warn**: (`label`?) => `void` - -##### Parameters - -###### label? - -`string` - -##### Returns - -`void` - -### trace() - -> **trace**: (...`args`) => `void` - -#### Parameters - -##### args - -...`unknown`[] - -#### Returns - -`void` - -### warn() - -> **warn**: (...`args`) => `void` - -#### Parameters - -##### args - -...`unknown`[] - -#### Returns - -`void` - -### levels - -#### Get Signature - -> **get** **levels**(): `LogLevel` - -##### Returns - -`LogLevel` diff --git a/src/pages/docs/reference/deployment/README.md b/src/pages/docs/reference/deployment/README.md deleted file mode 100644 index 1802e83..0000000 --- a/src/pages/docs/reference/deployment/README.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "@proto-kit/deployment" ---- - -**@proto-kit/deployment** - -*** - -[Documentation](../../README.md) / @proto-kit/deployment - -### General - -This package provides a suite of Dockerfiles and compose files to start protokit -in a variety of settings and modes. - -Everything is controlled via `Environments`. -These are basically bundles of Appchains that are configured for different roles. -Every environment has a name and consists of multiple `Configurations`. - -The base image built from `base/Dockerfile` executes any js file and passes in the environment and configuration name as arguments. - -Configuration happens via a `.env` file that specifies a few things: -Among those are the profiles that should executed, the DB connection string, and the entrypoints for the different images - -##### Currently available services: - -- Persistance with - - Postgres (profile: `db`) - - Redis (profiles: `db, worker`) -- Sequencer: `SEQUENCER_CONFIG` (profile: `simple-sequencer`) -- Worker: `WORKER_CONFIG` (profile: `worker`) - -- Development-base: Usage for locally built starter-kit, see starter-kit documentation - -### Usage - -A example of how to use it with a local framework repo can be found under the package `stack` -The configuration of that setup can be found under .env - -Executing it works via `docker-compose up --build` run in the `stack` package. - -### Extentending deployment compose files - -Option 1: Using include and specifying a exported `Environments` configuration - -Option 2: Using extend and override the `cmd` - -Be aware that including docker-compose files preserves their relationship in terms of relational paths, while extend does not (it behaves like copying the text into the parent file) diff --git a/src/pages/docs/reference/deployment/_meta.tsx b/src/pages/docs/reference/deployment/_meta.tsx deleted file mode 100644 index 9304eb2..0000000 --- a/src/pages/docs/reference/deployment/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/deployment/classes/BullQueue.md b/src/pages/docs/reference/deployment/classes/BullQueue.md deleted file mode 100644 index 611935a..0000000 --- a/src/pages/docs/reference/deployment/classes/BullQueue.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -title: BullQueue ---- - -[**@proto-kit/deployment**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/deployment](../README.md) / BullQueue - -# Class: BullQueue - -Defined in: [deployment/src/queue/BullQueue.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L29) - -TaskQueue implementation for BullMQ - -## Extends - -- [`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md)\<[`BullQueueConfig`](../interfaces/BullQueueConfig.md)\> - -## Implements - -- [`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) -- [`Closeable`](../../sequencer/interfaces/Closeable.md) - -## Constructors - -### new BullQueue() - -> **new BullQueue**(): [`BullQueue`](BullQueue.md) - -#### Returns - -[`BullQueue`](BullQueue.md) - -#### Inherited from - -[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`constructor`](../../sequencer/classes/AbstractTaskQueue.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`BullQueueConfig`](../interfaces/BullQueueConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`currentConfig`](../../sequencer/classes/AbstractTaskQueue.md#currentconfig) - -*** - -### queues - -> `protected` **queues**: `Record`\<`string`, [`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md)\> - -Defined in: sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:4 - -#### Inherited from - -[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`queues`](../../sequencer/classes/AbstractTaskQueue.md#queues) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> - -Defined in: sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 - -#### Inherited from - -[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`presets`](../../sequencer/classes/AbstractTaskQueue.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`config`](../../sequencer/classes/AbstractTaskQueue.md#config) - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [deployment/src/queue/BullQueue.ts:107](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L107) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Closeable`](../../sequencer/interfaces/Closeable.md).[`close`](../../sequencer/interfaces/Closeable.md#close) - -*** - -### closeQueues() - -> `protected` **closeQueues**(): `Promise`\<`void`\> - -Defined in: sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:6 - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`closeQueues`](../../sequencer/classes/AbstractTaskQueue.md#closequeues) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`create`](../../sequencer/classes/AbstractTaskQueue.md#create) - -*** - -### createOrGetQueue() - -> `protected` **createOrGetQueue**(`name`, `creator`): [`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md) - -Defined in: sequencer/dist/worker/queue/AbstractTaskQueue.d.ts:5 - -#### Parameters - -##### name - -`string` - -##### creator - -(`name`) => [`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md) - -#### Returns - -[`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md) - -#### Inherited from - -[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`createOrGetQueue`](../../sequencer/classes/AbstractTaskQueue.md#createorgetqueue) - -*** - -### createWorker() - -> **createWorker**(`name`, `executor`, `options`?): [`Closeable`](../../sequencer/interfaces/Closeable.md) - -Defined in: [deployment/src/queue/BullQueue.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L35) - -#### Parameters - -##### name - -`string` - -##### executor - -(`data`) => `Promise`\<[`TaskPayload`](../../sequencer/interfaces/TaskPayload.md)\> - -##### options? - -###### concurrency - -`number` - -#### Returns - -[`Closeable`](../../sequencer/interfaces/Closeable.md) - -#### Implementation of - -[`TaskQueue`](../../sequencer/interfaces/TaskQueue.md).[`createWorker`](../../sequencer/interfaces/TaskQueue.md#createworker) - -*** - -### getQueue() - -> **getQueue**(`queueName`): `Promise`\<[`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md)\> - -Defined in: [deployment/src/queue/BullQueue.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L88) - -#### Parameters - -##### queueName - -`string` - -#### Returns - -`Promise`\<[`InstantiatedQueue`](../../sequencer/interfaces/InstantiatedQueue.md)\> - -#### Implementation of - -[`TaskQueue`](../../sequencer/interfaces/TaskQueue.md).[`getQueue`](../../sequencer/interfaces/TaskQueue.md#getqueue) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [deployment/src/queue/BullQueue.ts:103](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L103) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`AbstractTaskQueue`](../../sequencer/classes/AbstractTaskQueue.md).[`start`](../../sequencer/classes/AbstractTaskQueue.md#start) diff --git a/src/pages/docs/reference/deployment/classes/Environment.md b/src/pages/docs/reference/deployment/classes/Environment.md deleted file mode 100644 index 5a5748f..0000000 --- a/src/pages/docs/reference/deployment/classes/Environment.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: Environment ---- - -[**@proto-kit/deployment**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/deployment](../README.md) / Environment - -# Class: Environment\ - -Defined in: [deployment/src/environment/Environment.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L12) - -## Type Parameters - -• **T** *extends* [`Startable`](../interfaces/Startable.md) - -## Constructors - -### new Environment() - -> **new Environment**\<`T`\>(`configurations`): [`Environment`](Environment.md)\<`T`\> - -Defined in: [deployment/src/environment/Environment.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L13) - -#### Parameters - -##### configurations - -[`StartableEnvironment`](../type-aliases/StartableEnvironment.md)\<`T`\> - -#### Returns - -[`Environment`](Environment.md)\<`T`\> - -## Methods - -### getConfiguration() - -> **getConfiguration**(`configurationName`): `T` - -Defined in: [deployment/src/environment/Environment.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L31) - -#### Parameters - -##### configurationName - -`string` - -#### Returns - -`T` - -*** - -### hasConfiguration() - -> **hasConfiguration**(`configurationName`): `configurationName is string` - -Defined in: [deployment/src/environment/Environment.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L17) - -#### Parameters - -##### configurationName - -`string` - -#### Returns - -`configurationName is string` - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [deployment/src/environment/Environment.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L42) - -#### Returns - -`Promise`\<`void`\> - -*** - -### from() - -> `static` **from**\<`T`\>(`configurations`): [`Environment`](Environment.md)\<`T`\> - -Defined in: [deployment/src/environment/Environment.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L36) - -#### Type Parameters - -• **T** *extends* [`Startable`](../interfaces/Startable.md) - -#### Parameters - -##### configurations - -[`StartableEnvironment`](../type-aliases/StartableEnvironment.md)\<`T`\> - -#### Returns - -[`Environment`](Environment.md)\<`T`\> diff --git a/src/pages/docs/reference/deployment/globals.md b/src/pages/docs/reference/deployment/globals.md deleted file mode 100644 index 6420a85..0000000 --- a/src/pages/docs/reference/deployment/globals.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "@proto-kit/deployment" ---- - -[**@proto-kit/deployment**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/deployment - -# @proto-kit/deployment - -## Classes - -- [BullQueue](classes/BullQueue.md) -- [Environment](classes/Environment.md) - -## Interfaces - -- [BullQueueConfig](interfaces/BullQueueConfig.md) -- [Startable](interfaces/Startable.md) - -## Type Aliases - -- [StartableEnvironment](type-aliases/StartableEnvironment.md) diff --git a/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md b/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md deleted file mode 100644 index 5c5d63e..0000000 --- a/src/pages/docs/reference/deployment/interfaces/BullQueueConfig.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: BullQueueConfig ---- - -[**@proto-kit/deployment**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/deployment](../README.md) / BullQueueConfig - -# Interface: BullQueueConfig - -Defined in: [deployment/src/queue/BullQueue.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L14) - -## Properties - -### redis - -> **redis**: `object` - -Defined in: [deployment/src/queue/BullQueue.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L15) - -#### db? - -> `optional` **db**: `number` - -#### host - -> **host**: `string` - -#### password? - -> `optional` **password**: `string` - -#### port - -> **port**: `number` - -#### username? - -> `optional` **username**: `string` - -*** - -### retryAttempts? - -> `optional` **retryAttempts**: `number` - -Defined in: [deployment/src/queue/BullQueue.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/queue/BullQueue.ts#L22) diff --git a/src/pages/docs/reference/deployment/interfaces/Startable.md b/src/pages/docs/reference/deployment/interfaces/Startable.md deleted file mode 100644 index cbbb590..0000000 --- a/src/pages/docs/reference/deployment/interfaces/Startable.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Startable ---- - -[**@proto-kit/deployment**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/deployment](../README.md) / Startable - -# Interface: Startable - -Defined in: [deployment/src/environment/Environment.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L6) - -## Methods - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [deployment/src/environment/Environment.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L7) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md b/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md deleted file mode 100644 index a232406..0000000 --- a/src/pages/docs/reference/deployment/type-aliases/StartableEnvironment.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: StartableEnvironment ---- - -[**@proto-kit/deployment**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/deployment](../README.md) / StartableEnvironment - -# Type Alias: StartableEnvironment\ - -> **StartableEnvironment**\<`T`\>: `Record`\<`string`, `T`\> - -Defined in: [deployment/src/environment/Environment.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/deployment/src/environment/Environment.ts#L10) - -## Type Parameters - -• **T** diff --git a/src/pages/docs/reference/indexer/README.md b/src/pages/docs/reference/indexer/README.md deleted file mode 100644 index a78f91d..0000000 --- a/src/pages/docs/reference/indexer/README.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "@proto-kit/indexer" ---- - -**@proto-kit/indexer** - -*** - -[Documentation](../../README.md) / @proto-kit/indexer - -# @proto-kit/indexer - -## Classes - -- [GeneratedResolverFactoryGraphqlModule](classes/GeneratedResolverFactoryGraphqlModule.md) -- [IndexBlockTask](classes/IndexBlockTask.md) -- [IndexBlockTaskParametersSerializer](classes/IndexBlockTaskParametersSerializer.md) -- [Indexer](classes/Indexer.md) -- [IndexerModule](classes/IndexerModule.md) -- [IndexerNotifier](classes/IndexerNotifier.md) - -## Interfaces - -- [IndexBlockTaskParameters](interfaces/IndexBlockTaskParameters.md) - -## Type Aliases - -- [IndexerModulesRecord](type-aliases/IndexerModulesRecord.md) -- [NotifierMandatorySequencerModules](type-aliases/NotifierMandatorySequencerModules.md) - -## Functions - -- [cleanResolvers](functions/cleanResolvers.md) -- [ValidateTakeArg](functions/ValidateTakeArg.md) diff --git a/src/pages/docs/reference/indexer/_meta.tsx b/src/pages/docs/reference/indexer/_meta.tsx deleted file mode 100644 index a31554d..0000000 --- a/src/pages/docs/reference/indexer/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md b/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md deleted file mode 100644 index cc065da..0000000 --- a/src/pages/docs/reference/indexer/classes/GeneratedResolverFactoryGraphqlModule.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: GeneratedResolverFactoryGraphqlModule ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / GeneratedResolverFactoryGraphqlModule - -# Class: GeneratedResolverFactoryGraphqlModule - -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L83) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md) - -## Constructors - -### new GeneratedResolverFactoryGraphqlModule() - -> **new GeneratedResolverFactoryGraphqlModule**(`graphqlServer`): [`GeneratedResolverFactoryGraphqlModule`](GeneratedResolverFactoryGraphqlModule.md) - -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L84) - -#### Parameters - -##### graphqlServer - -[`GraphqlServer`](../../api/classes/GraphqlServer.md) - -#### Returns - -[`GeneratedResolverFactoryGraphqlModule`](GeneratedResolverFactoryGraphqlModule.md) - -#### Overrides - -[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`constructor`](../../api/classes/ResolverFactoryGraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`currentConfig`](../../api/classes/ResolverFactoryGraphqlModule.md#currentconfig) - -*** - -### graphqlServer - -> **graphqlServer**: [`GraphqlServer`](../../api/classes/GraphqlServer.md) - -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L85) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`config`](../../api/classes/ResolverFactoryGraphqlModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`create`](../../api/classes/ResolverFactoryGraphqlModule.md#create) - -*** - -### initializePrismaClient() - -> **initializePrismaClient**(): `Promise`\<`PrismaClient`\<`never`\>\> - -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:90](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L90) - -#### Returns - -`Promise`\<`PrismaClient`\<`never`\>\> - -*** - -### resolvers() - -> **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> - -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:101](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L101) - -#### Returns - -`Promise`\<`NonEmptyArray`\<`Function`\>\> - -#### Overrides - -[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`resolvers`](../../api/classes/ResolverFactoryGraphqlModule.md#resolvers) diff --git a/src/pages/docs/reference/indexer/classes/IndexBlockTask.md b/src/pages/docs/reference/indexer/classes/IndexBlockTask.md deleted file mode 100644 index c525006..0000000 --- a/src/pages/docs/reference/indexer/classes/IndexBlockTask.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -title: IndexBlockTask ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexBlockTask - -# Class: IndexBlockTask - -Defined in: [indexer/src/tasks/IndexBlockTask.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L16) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md) - -## Implements - -- [`Task`](../../sequencer/interfaces/Task.md)\<[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md), `void`\> - -## Constructors - -### new IndexBlockTask() - -> **new IndexBlockTask**(`taskSerializer`, `blockStorage`): [`IndexBlockTask`](IndexBlockTask.md) - -Defined in: [indexer/src/tasks/IndexBlockTask.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L22) - -#### Parameters - -##### taskSerializer - -[`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) - -##### blockStorage - -[`BlockQueue`](../../sequencer/interfaces/BlockQueue.md) - -#### Returns - -[`IndexBlockTask`](IndexBlockTask.md) - -#### Overrides - -[`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md).[`constructor`](../../sequencer/classes/TaskWorkerModule.md#constructors) - -## Properties - -### blockStorage - -> **blockStorage**: [`BlockQueue`](../../sequencer/interfaces/BlockQueue.md) - -Defined in: [indexer/src/tasks/IndexBlockTask.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L25) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md).[`currentConfig`](../../sequencer/classes/TaskWorkerModule.md#currentconfig) - -*** - -### name - -> **name**: `string` = `"index-block"` - -Defined in: [indexer/src/tasks/IndexBlockTask.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L20) - -#### Implementation of - -[`Task`](../../sequencer/interfaces/Task.md).[`name`](../../sequencer/interfaces/Task.md#name) - -*** - -### taskSerializer - -> **taskSerializer**: [`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) - -Defined in: [indexer/src/tasks/IndexBlockTask.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L23) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md).[`config`](../../sequencer/classes/TaskWorkerModule.md#config) - -## Methods - -### compute() - -> **compute**(`input`): `Promise`\<`void`\> - -Defined in: [indexer/src/tasks/IndexBlockTask.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L33) - -#### Parameters - -##### input - -[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Task`](../../sequencer/interfaces/Task.md).[`compute`](../../sequencer/interfaces/Task.md#compute) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](../../sequencer/classes/TaskWorkerModule.md).[`create`](../../sequencer/classes/TaskWorkerModule.md#create) - -*** - -### inputSerializer() - -> **inputSerializer**(): [`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md)\> - -Defined in: [indexer/src/tasks/IndexBlockTask.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L45) - -#### Returns - -[`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md)\> - -#### Implementation of - -[`Task`](../../sequencer/interfaces/Task.md).[`inputSerializer`](../../sequencer/interfaces/Task.md#inputserializer) - -*** - -### prepare() - -> **prepare**(): `Promise`\<`void`\> - -Defined in: [indexer/src/tasks/IndexBlockTask.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L31) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Task`](../../sequencer/interfaces/Task.md).[`prepare`](../../sequencer/interfaces/Task.md#prepare) - -*** - -### resultSerializer() - -> **resultSerializer**(): [`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<`void`\> - -Defined in: [indexer/src/tasks/IndexBlockTask.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTask.ts#L49) - -#### Returns - -[`TaskSerializer`](../../sequencer/interfaces/TaskSerializer.md)\<`void`\> - -#### Implementation of - -[`Task`](../../sequencer/interfaces/Task.md).[`resultSerializer`](../../sequencer/interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md b/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md deleted file mode 100644 index 63d9b29..0000000 --- a/src/pages/docs/reference/indexer/classes/IndexBlockTaskParametersSerializer.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: IndexBlockTaskParametersSerializer ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexBlockTaskParametersSerializer - -# Class: IndexBlockTaskParametersSerializer - -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L12) - -## Constructors - -### new IndexBlockTaskParametersSerializer() - -> **new IndexBlockTaskParametersSerializer**(`blockMapper`, `blockResultMapper`, `transactionResultMapper`): [`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) - -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L13) - -#### Parameters - -##### blockMapper - -[`BlockMapper`](../../persistance/classes/BlockMapper.md) - -##### blockResultMapper - -[`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) - -##### transactionResultMapper - -[`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) - -#### Returns - -[`IndexBlockTaskParametersSerializer`](IndexBlockTaskParametersSerializer.md) - -## Properties - -### blockMapper - -> **blockMapper**: [`BlockMapper`](../../persistance/classes/BlockMapper.md) - -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L14) - -*** - -### blockResultMapper - -> **blockResultMapper**: [`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) - -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L15) - -*** - -### transactionResultMapper - -> **transactionResultMapper**: [`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) - -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L16) - -## Methods - -### fromJSON() - -> **fromJSON**(`json`): [`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md) - -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L29) - -#### Parameters - -##### json - -`string` - -#### Returns - -[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md) - -*** - -### toJSON() - -> **toJSON**(`parameters`): `string` - -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L19) - -#### Parameters - -##### parameters - -[`IndexBlockTaskParameters`](../interfaces/IndexBlockTaskParameters.md) - -#### Returns - -`string` diff --git a/src/pages/docs/reference/indexer/classes/Indexer.md b/src/pages/docs/reference/indexer/classes/Indexer.md deleted file mode 100644 index 3d8f814..0000000 --- a/src/pages/docs/reference/indexer/classes/Indexer.md +++ /dev/null @@ -1,632 +0,0 @@ ---- -title: Indexer ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / Indexer - -# Class: Indexer\ - -Defined in: [indexer/src/Indexer.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/Indexer.ts#L15) - -Reusable module container facilitating registration, resolution -configuration, decoration and validation of modules - -## Extends - -- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Modules`\> - -## Type Parameters - -• **Modules** *extends* [`IndexerModulesRecord`](../type-aliases/IndexerModulesRecord.md) - -## Constructors - -### new Indexer() - -> **new Indexer**\<`Modules`\>(`definition`): [`Indexer`](Indexer.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:68 - -#### Parameters - -##### definition - -[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -#### Returns - -[`Indexer`](Indexer.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) - -*** - -### definition - -> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:60 - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) - -*** - -### taskQueue - -#### Get Signature - -> **get** **taskQueue**(): `InstanceType`\<`Modules`\[`"TaskQueue"`\]\> - -Defined in: [indexer/src/Indexer.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/Indexer.ts#L24) - -##### Returns - -`InstanceType`\<`Modules`\[`"TaskQueue"`\]\> - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` - -Defined in: common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:160 - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) - -*** - -### decorateModule() - -> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:134 - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -`InstanceType`\<`Modules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>\]\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>[] - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` - -Defined in: common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -`Modules` - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -`Modules` - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -Defined in: common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [indexer/src/Indexer.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/Indexer.ts#L28) - -#### Returns - -`Promise`\<`void`\> - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`Modules`\>(`definition`): [`Indexer`](Indexer.md)\<`Modules`\> - -Defined in: [indexer/src/Indexer.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/Indexer.ts#L18) - -#### Type Parameters - -• **Modules** *extends* [`IndexerModulesRecord`](../type-aliases/IndexerModulesRecord.md) - -#### Parameters - -##### definition - -[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -#### Returns - -[`Indexer`](Indexer.md)\<`Modules`\> diff --git a/src/pages/docs/reference/indexer/classes/IndexerModule.md b/src/pages/docs/reference/indexer/classes/IndexerModule.md deleted file mode 100644 index 8f97922..0000000 --- a/src/pages/docs/reference/indexer/classes/IndexerModule.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: IndexerModule ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexerModule - -# Class: `abstract` IndexerModule\ - -Defined in: [indexer/src/IndexerModule.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerModule.ts#L3) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> - -## Type Parameters - -• **Config** - -## Constructors - -### new IndexerModule() - -> **new IndexerModule**\<`Config`\>(): [`IndexerModule`](IndexerModule.md)\<`Config`\> - -#### Returns - -[`IndexerModule`](IndexerModule.md)\<`Config`\> - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) - -*** - -### start() - -> `abstract` **start**(): `Promise`\<`void`\> - -Defined in: [indexer/src/IndexerModule.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerModule.ts#L4) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/indexer/classes/IndexerNotifier.md b/src/pages/docs/reference/indexer/classes/IndexerNotifier.md deleted file mode 100644 index 32ac78e..0000000 --- a/src/pages/docs/reference/indexer/classes/IndexerNotifier.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -title: IndexerNotifier ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexerNotifier - -# Class: IndexerNotifier - -Defined in: [indexer/src/IndexerNotifier.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L19) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`Record`\<`never`, `never`\>\> - -## Constructors - -### new IndexerNotifier() - -> **new IndexerNotifier**(`sequencer`, `taskQueue`, `indexBlockTask`): [`IndexerNotifier`](IndexerNotifier.md) - -Defined in: [indexer/src/IndexerNotifier.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L20) - -#### Parameters - -##### sequencer - -[`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`NotifierMandatorySequencerModules`](../type-aliases/NotifierMandatorySequencerModules.md)\> - -##### taskQueue - -[`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) - -##### indexBlockTask - -[`IndexBlockTask`](IndexBlockTask.md) - -#### Returns - -[`IndexerNotifier`](IndexerNotifier.md) - -#### Overrides - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`constructor`](../../sequencer/classes/SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Record`\<`never`, `never`\> - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) - -*** - -### indexBlockTask - -> **indexBlockTask**: [`IndexBlockTask`](IndexBlockTask.md) - -Defined in: [indexer/src/IndexerNotifier.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L25) - -*** - -### sequencer - -> **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`NotifierMandatorySequencerModules`](../type-aliases/NotifierMandatorySequencerModules.md)\> - -Defined in: [indexer/src/IndexerNotifier.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L22) - -*** - -### taskQueue - -> **taskQueue**: [`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) - -Defined in: [indexer/src/IndexerNotifier.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L24) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> - -Defined in: sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`presets`](../../sequencer/classes/SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) - -*** - -### propagateEventsAsTasks() - -> **propagateEventsAsTasks**(): `Promise`\<`void`\> - -Defined in: [indexer/src/IndexerNotifier.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L30) - -#### Returns - -`Promise`\<`void`\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [indexer/src/IndexerNotifier.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L51) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) diff --git a/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md b/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md deleted file mode 100644 index 6124369..0000000 --- a/src/pages/docs/reference/indexer/functions/ValidateTakeArg.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: ValidateTakeArg ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / ValidateTakeArg - -# Function: ValidateTakeArg() - -> **ValidateTakeArg**(): `MethodDecorator` - -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L68) - -## Returns - -`MethodDecorator` diff --git a/src/pages/docs/reference/indexer/functions/cleanResolvers.md b/src/pages/docs/reference/indexer/functions/cleanResolvers.md deleted file mode 100644 index 1b293e6..0000000 --- a/src/pages/docs/reference/indexer/functions/cleanResolvers.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: cleanResolvers ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / cleanResolvers - -# Function: cleanResolvers() - -> **cleanResolvers**(`resolvers`): `Function`[] - -Defined in: [indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/api/GeneratedResolverFactoryGraphqlModule.ts#L47) - -## Parameters - -### resolvers - -`NonEmptyArray`\<`Function`\> - -## Returns - -`Function`[] diff --git a/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md b/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md deleted file mode 100644 index 6094a12..0000000 --- a/src/pages/docs/reference/indexer/interfaces/IndexBlockTaskParameters.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: IndexBlockTaskParameters ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexBlockTaskParameters - -# Interface: IndexBlockTaskParameters - -Defined in: [indexer/src/tasks/IndexBlockTaskParameters.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/tasks/IndexBlockTaskParameters.ts#L9) - -## Extends - -- [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md) - -## Properties - -### block - -> **block**: [`Block`](../../sequencer/interfaces/Block.md) - -Defined in: sequencer/dist/storage/model/Block.d.ts:45 - -#### Inherited from - -[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md).[`block`](../../sequencer/interfaces/BlockWithResult.md#block) - -*** - -### result - -> **result**: [`BlockResult`](../../sequencer/interfaces/BlockResult.md) - -Defined in: sequencer/dist/storage/model/Block.d.ts:46 - -#### Inherited from - -[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md).[`result`](../../sequencer/interfaces/BlockWithResult.md#result) diff --git a/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md b/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md deleted file mode 100644 index ca00996..0000000 --- a/src/pages/docs/reference/indexer/type-aliases/IndexerModulesRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: IndexerModulesRecord ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / IndexerModulesRecord - -# Type Alias: IndexerModulesRecord - -> **IndexerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`IndexerModule`](../classes/IndexerModule.md)\<`unknown`\>\>\> - -Defined in: [indexer/src/Indexer.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/Indexer.ts#L11) diff --git a/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md b/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md deleted file mode 100644 index 3d2a693..0000000 --- a/src/pages/docs/reference/indexer/type-aliases/NotifierMandatorySequencerModules.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: NotifierMandatorySequencerModules ---- - -[**@proto-kit/indexer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/indexer](../README.md) / NotifierMandatorySequencerModules - -# Type Alias: NotifierMandatorySequencerModules - -> **NotifierMandatorySequencerModules**: `object` - -Defined in: [indexer/src/IndexerNotifier.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/indexer/src/IndexerNotifier.ts#L14) - -## Type declaration - -### BlockTrigger - -> **BlockTrigger**: *typeof* [`BlockTriggerBase`](../../sequencer/classes/BlockTriggerBase.md) diff --git a/src/pages/docs/reference/library/README.md b/src/pages/docs/reference/library/README.md deleted file mode 100644 index 71f49ce..0000000 --- a/src/pages/docs/reference/library/README.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "@proto-kit/library" ---- - -**@proto-kit/library** - -*** - -[Documentation](../../README.md) / @proto-kit/library - -# @proto-kit/library - -## Classes - -- [Balance](classes/Balance.md) -- [Balances](classes/Balances.md) -- [BalancesKey](classes/BalancesKey.md) -- [FeeTree](classes/FeeTree.md) -- [InMemorySequencerModules](classes/InMemorySequencerModules.md) -- [MethodFeeConfigData](classes/MethodFeeConfigData.md) -- [RuntimeFeeAnalyzerService](classes/RuntimeFeeAnalyzerService.md) -- [SimpleSequencerModules](classes/SimpleSequencerModules.md) -- [TokenId](classes/TokenId.md) -- [TransactionFeeHook](classes/TransactionFeeHook.md) -- [UInt](classes/UInt.md) -- [UInt112](classes/UInt112.md) -- [UInt224](classes/UInt224.md) -- [UInt32](classes/UInt32.md) -- [UInt64](classes/UInt64.md) -- [VanillaProtocolModules](classes/VanillaProtocolModules.md) -- [VanillaRuntimeModules](classes/VanillaRuntimeModules.md) -- [WithdrawalEvent](classes/WithdrawalEvent.md) -- [WithdrawalKey](classes/WithdrawalKey.md) -- [Withdrawals](classes/Withdrawals.md) - -## Interfaces - -- [BalancesEvents](interfaces/BalancesEvents.md) -- [FeeIndexes](interfaces/FeeIndexes.md) -- [FeeTreeValues](interfaces/FeeTreeValues.md) -- [MethodFeeConfig](interfaces/MethodFeeConfig.md) -- [RuntimeFeeAnalyzerServiceConfig](interfaces/RuntimeFeeAnalyzerServiceConfig.md) -- [TransactionFeeHookConfig](interfaces/TransactionFeeHookConfig.md) - -## Type Aliases - -- [AdditionalSequencerModules](type-aliases/AdditionalSequencerModules.md) -- [InMemorySequencerModulesRecord](type-aliases/InMemorySequencerModulesRecord.md) -- [MinimalBalances](type-aliases/MinimalBalances.md) -- [MinimumAdditionalSequencerModules](type-aliases/MinimumAdditionalSequencerModules.md) -- [SimpleSequencerModulesRecord](type-aliases/SimpleSequencerModulesRecord.md) -- [SimpleSequencerWorkerModulesRecord](type-aliases/SimpleSequencerWorkerModulesRecord.md) -- [UIntConstructor](type-aliases/UIntConstructor.md) -- [VanillaProtocolModulesRecord](type-aliases/VanillaProtocolModulesRecord.md) -- [VanillaRuntimeModulesRecord](type-aliases/VanillaRuntimeModulesRecord.md) - -## Variables - -- [errors](variables/errors.md) -- [treeFeeHeight](variables/treeFeeHeight.md) diff --git a/src/pages/docs/reference/library/_meta.tsx b/src/pages/docs/reference/library/_meta.tsx deleted file mode 100644 index 48a0c5e..0000000 --- a/src/pages/docs/reference/library/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/library/classes/Balance.md b/src/pages/docs/reference/library/classes/Balance.md deleted file mode 100644 index b02f2d0..0000000 --- a/src/pages/docs/reference/library/classes/Balance.md +++ /dev/null @@ -1,1125 +0,0 @@ ---- -title: Balance ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / Balance - -# Class: Balance - -Defined in: [packages/library/src/runtime/Balances.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L28) - -UInt is a base class for all soft-failing UInt* implementations. -It has to be overridden for every bitlength that should be available. - -For this, the developer has to create a subclass of UInt implementing the -static methods from interface UIntConstructor - -## Extends - -- [`UInt64`](UInt64.md) - -## Constructors - -### new Balance() - -> **new Balance**(`value`): [`Balance`](Balance.md) - -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) - -#### Parameters - -##### value - -###### value - -`Field` - -#### Returns - -[`Balance`](Balance.md) - -#### Inherited from - -[`UInt64`](UInt64.md).[`constructor`](UInt64.md#constructors) - -## Properties - -### value - -> **value**: `Field` = `Field` - -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) - -#### Inherited from - -[`UInt64`](UInt64.md).[`value`](UInt64.md#value-2) - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -[`UInt64`](UInt64.md).[`_isStruct`](UInt64.md#_isstruct) - -*** - -### assertionFunction() - -> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` - -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) - -#### Parameters - -##### bool - -`Bool` - -##### msg? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt64`](UInt64.md).[`assertionFunction`](UInt64.md#assertionfunction) - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt64`](UInt64.md).[`empty`](UInt64.md#empty) - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt64`](UInt64.md).[`fromFields`](UInt64.md#fromfields) - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### value - -`string` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt64`](UInt64.md).[`fromJSON`](UInt64.md#fromjson) - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -[`UInt64`](UInt64.md).[`fromValue`](UInt64.md#fromvalue) - -*** - -### Safe - -> `static` **Safe**: `object` - -Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L12) - -#### fromField() - -##### Parameters - -###### value - -`Field` - -##### Returns - -[`UInt64`](UInt64.md) - -#### Inherited from - -[`UInt64`](UInt64.md).[`Safe`](UInt64.md#safe) - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### value - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -[`UInt64`](UInt64.md).[`toAuxiliary`](UInt64.md#toauxiliary) - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### value - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -[`UInt64`](UInt64.md).[`toFields`](UInt64.md#tofields) - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -[`UInt64`](UInt64.md).[`toInput`](UInt64.md#toinput) - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `string` = `Field` - -#### Inherited from - -[`UInt64`](UInt64.md).[`toJSON`](UInt64.md#tojson) - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `bigint` = `Field` - -#### Inherited from - -[`UInt64`](UInt64.md).[`toValue`](UInt64.md#tovalue) - -*** - -### Unsafe - -> `static` **Unsafe**: `object` - -Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L6) - -#### fromField() - -##### Parameters - -###### value - -`Field` - -##### Returns - -[`UInt64`](UInt64.md) - -#### Inherited from - -[`UInt64`](UInt64.md).[`Unsafe`](UInt64.md#unsafe) - -## Accessors - -### max - -#### Get Signature - -> **get** `static` **max**(): [`UInt64`](UInt64.md) - -Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L35) - -##### Returns - -[`UInt64`](UInt64.md) - -#### Inherited from - -[`UInt64`](UInt64.md).[`max`](UInt64.md#max) - -*** - -### zero - -#### Get Signature - -> **get** `static` **zero**(): [`UInt64`](UInt64.md) - -Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L31) - -##### Returns - -[`UInt64`](UInt64.md) - -#### Inherited from - -[`UInt64`](UInt64.md).[`zero`](UInt64.md#zero) - -## Methods - -### add() - -> **add**(`y`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) - -Addition with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt64`](UInt64.md).[`add`](UInt64.md#add) - -*** - -### assertEquals() - -> **assertEquals**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) - -Asserts that a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt64`](UInt64.md).[`assertEquals`](UInt64.md#assertequals) - -*** - -### assertGreaterThan() - -> **assertGreaterThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) - -Asserts that a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt64`](UInt64.md).[`assertGreaterThan`](UInt64.md#assertgreaterthan) - -*** - -### assertGreaterThanOrEqual() - -> **assertGreaterThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) - -Asserts that a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt64`](UInt64.md).[`assertGreaterThanOrEqual`](UInt64.md#assertgreaterthanorequal) - -*** - -### assertLessThan() - -> **assertLessThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) - -Asserts that a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt64`](UInt64.md).[`assertLessThan`](UInt64.md#assertlessthan) - -*** - -### assertLessThanOrEqual() - -> **assertLessThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) - -Asserts that a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt64`](UInt64.md).[`assertLessThanOrEqual`](UInt64.md#assertlessthanorequal) - -*** - -### constructorReference() - -> **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L39) - -#### Returns - -[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> - -#### Inherited from - -[`UInt64`](UInt64.md).[`constructorReference`](UInt64.md#constructorreference) - -*** - -### div() - -> **div**(`y`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) - -Integer division. - -`x.div(y)` returns the floor of `x / y`, that is, the greatest -`z` such that `z * y <= x`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt64`](UInt64.md).[`div`](UInt64.md#div) - -*** - -### divMod() - -> **divMod**(`divisor`): `object` - -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) - -Integer division with remainder. - -`x.divMod(y)` returns the quotient and the remainder. - -#### Parameters - -##### divisor - -`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -`object` - -##### quotient - -> **quotient**: [`UInt`](UInt.md)\<`64`\> - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt64`](UInt64.md).[`divMod`](UInt64.md#divmod) - -*** - -### equals() - -> **equals**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) - -Checks if a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt64`](UInt64.md).[`equals`](UInt64.md#equals) - -*** - -### greaterThan() - -> **greaterThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) - -Checks if a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt64`](UInt64.md).[`greaterThan`](UInt64.md#greaterthan) - -*** - -### greaterThanOrEqual() - -> **greaterThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) - -Checks if a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt64`](UInt64.md).[`greaterThanOrEqual`](UInt64.md#greaterthanorequal) - -*** - -### lessThan() - -> **lessThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) - -Checks if a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt64`](UInt64.md).[`lessThan`](UInt64.md#lessthan) - -*** - -### lessThanOrEqual() - -> **lessThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) - -Checks if a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt64`](UInt64.md).[`lessThanOrEqual`](UInt64.md#lessthanorequal) - -*** - -### mod() - -> **mod**(`y`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) - -Integer remainder. - -`x.mod(y)` returns the value `z` such that `0 <= z < y` and -`x - z` is divisble by `y`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt64`](UInt64.md).[`mod`](UInt64.md#mod) - -*** - -### mul() - -> **mul**(`y`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) - -Multiplication with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt64`](UInt64.md).[`mul`](UInt64.md#mul) - -*** - -### numBits() - -> **numBits**(): `64` - -Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L43) - -#### Returns - -`64` - -#### Inherited from - -[`UInt64`](UInt64.md).[`numBits`](UInt64.md#numbits) - -*** - -### sqrtFloor() - -> **sqrtFloor**(): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) - -Wraps sqrtMod() by only returning the sqrt and omitting the rest field. - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt64`](UInt64.md).[`sqrtFloor`](UInt64.md#sqrtfloor) - -*** - -### sqrtMod() - -> **sqrtMod**(): `object` - -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) - -Implements a non-overflowing square-root with rest. -Normal Field.sqrt() provides the sqrt as it is defined by the finite -field operations. This implementation however mimics the natural-numbers -style of sqrt to be used inside applications with the tradeoff that it -also returns a "rest" that indicates the amount the actual result is off -(since we floor the result to stay inside the ff). - -Some assertions are hard-failing, because they represent malicious -witness values - -#### Returns - -`object` - -sqrt: The non-overflowing sqrt - -rest: The remainder indicating how far off the result -is from the "real" sqrt - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`64`\> - -##### sqrt - -> **sqrt**: [`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt64`](UInt64.md).[`sqrtMod`](UInt64.md#sqrtmod) - -*** - -### sub() - -> **sub**(`y`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) - -Subtraction with underflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt64`](UInt64.md).[`sub`](UInt64.md#sub) - -*** - -### toBigInt() - -> **toBigInt**(): `bigint` - -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) - -Turns the [UInt](UInt.md) into a BigInt. - -#### Returns - -`bigint` - -#### Inherited from - -[`UInt64`](UInt64.md).[`toBigInt`](UInt64.md#tobigint) - -*** - -### toO1UInt64() - -> **toO1UInt64**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. - -#### Returns - -`UInt64` - -#### Inherited from - -[`UInt64`](UInt64.md).[`toO1UInt64`](UInt64.md#too1uint64) - -*** - -### toO1UInt64Clamped() - -> **toO1UInt64Clamped**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), -clamping to the 64 bits range if it's too large. - -#### Returns - -`UInt64` - -#### Inherited from - -[`UInt64`](UInt64.md).[`toO1UInt64Clamped`](UInt64.md#too1uint64clamped) - -*** - -### toString() - -> **toString**(): `string` - -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) - -Turns the [UInt](UInt.md) into a string. - -#### Returns - -`string` - -#### Inherited from - -[`UInt64`](UInt64.md).[`toString`](UInt64.md#tostring) - -*** - -### check() - -> `static` **check**(`x`): `void` - -Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L20) - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### x - -###### value - -`Field` - -#### Returns - -`void` - -#### Inherited from - -[`UInt64`](UInt64.md).[`check`](UInt64.md#check) - -*** - -### checkConstant() - -> `static` **checkConstant**(`x`, `numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) - -#### Parameters - -##### x - -`Field` - -##### numBits - -`number` - -#### Returns - -`Field` - -#### Inherited from - -[`UInt64`](UInt64.md).[`checkConstant`](UInt64.md#checkconstant) - -*** - -### from() - -> `static` **from**(`x`): [`UInt64`](UInt64.md) - -Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L24) - -#### Parameters - -##### x - -`string` | `number` | `bigint` | [`UInt64`](UInt64.md) - -#### Returns - -[`UInt64`](UInt64.md) - -#### Inherited from - -[`UInt64`](UInt64.md).[`from`](UInt64.md#from) - -*** - -### maxIntField() - -> `static` **maxIntField**(`numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) - -Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. - -#### Parameters - -##### numBits - -`number` - -#### Returns - -`Field` - -#### Inherited from - -[`UInt64`](UInt64.md).[`maxIntField`](UInt64.md#maxintfield) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -[`UInt64`](UInt64.md).[`sizeInFields`](UInt64.md#sizeinfields) diff --git a/src/pages/docs/reference/library/classes/Balances.md b/src/pages/docs/reference/library/classes/Balances.md deleted file mode 100644 index dcc7b7a..0000000 --- a/src/pages/docs/reference/library/classes/Balances.md +++ /dev/null @@ -1,424 +0,0 @@ ---- -title: Balances ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / Balances - -# Class: Balances\ - -Defined in: [packages/library/src/runtime/Balances.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L45) - -Base class for runtime modules providing the necessary utilities. - -## Extends - -- [`RuntimeModule`](../../module/classes/RuntimeModule.md)\<`Config`\> - -## Extended by - -- [`TestBalances`](../../stack/classes/TestBalances.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -## Implements - -- [`MinimalBalances`](../type-aliases/MinimalBalances.md) - -## Constructors - -### new Balances() - -> **new Balances**\<`Config`\>(): [`Balances`](Balances.md)\<`Config`\> - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:31 - -#### Returns - -[`Balances`](Balances.md)\<`Config`\> - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`constructor`](../../module/classes/RuntimeModule.md#constructors) - -## Properties - -### balances - -> **balances**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`BalancesKey`](BalancesKey.md), [`Balance`](Balance.md)\> - -Defined in: [packages/library/src/runtime/Balances.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L49) - -#### Implementation of - -`MinimalBalances.balances` - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`currentConfig`](../../module/classes/RuntimeModule.md#currentconfig) - -*** - -### events? - -> `optional` **events**: [`RuntimeEvents`](../../module/classes/RuntimeEvents.md)\<`any`\> - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:30 - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`events`](../../module/classes/RuntimeModule.md#events) - -*** - -### isRuntimeModule - -> **isRuntimeModule**: `boolean` - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:27 - -This property exists only to typecheck that the RuntimeModule -was extended correctly in e.g. a decorator. We need at least -one non-optional property in this class to make the typechecking work. - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`isRuntimeModule`](../../module/classes/RuntimeModule.md#isruntimemodule) - -*** - -### name? - -> `optional` **name**: `string` - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:28 - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`name`](../../module/classes/RuntimeModule.md#name) - -*** - -### runtime? - -> `optional` **runtime**: [`RuntimeEnvironment`](../../module/interfaces/RuntimeEnvironment.md) - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:29 - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`runtime`](../../module/classes/RuntimeModule.md#runtime) - -*** - -### runtimeMethodNames - -> `readonly` **runtimeMethodNames**: `string`[] - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:21 - -Holds all method names that are callable throw transactions - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`runtimeMethodNames`](../../module/classes/RuntimeModule.md#runtimemethodnames) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:17 - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`presets`](../../module/classes/RuntimeModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`config`](../../module/classes/RuntimeModule.md#config) - -*** - -### network - -#### Get Signature - -> **get** **network**(): [`NetworkState`](../../protocol/classes/NetworkState.md) - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:34 - -##### Returns - -[`NetworkState`](../../protocol/classes/NetworkState.md) - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`network`](../../module/classes/RuntimeModule.md#network) - -*** - -### transaction - -#### Get Signature - -> **get** **transaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:33 - -##### Returns - -[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`transaction`](../../module/classes/RuntimeModule.md#transaction) - -## Methods - -### burn() - -> **burn**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> - -Defined in: [packages/library/src/runtime/Balances.ts:99](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L99) - -#### Parameters - -##### tokenId - -[`TokenId`](TokenId.md) - -##### address - -`PublicKey` - -##### amount - -[`Balance`](Balance.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`create`](../../module/classes/RuntimeModule.md#create) - -*** - -### getBalance() - -> **getBalance**(`tokenId`, `address`): `Promise`\<[`Balance`](Balance.md)\> - -Defined in: [packages/library/src/runtime/Balances.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L54) - -#### Parameters - -##### tokenId - -[`TokenId`](TokenId.md) - -##### address - -`PublicKey` - -#### Returns - -`Promise`\<[`Balance`](Balance.md)\> - -*** - -### getInputs() - -> **getInputs**(): [`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:32 - -#### Returns - -[`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`getInputs`](../../module/classes/RuntimeModule.md#getinputs) - -*** - -### mint() - -> **mint**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> - -Defined in: [packages/library/src/runtime/Balances.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L93) - -#### Parameters - -##### tokenId - -[`TokenId`](TokenId.md) - -##### address - -`PublicKey` - -##### amount - -[`Balance`](Balance.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### setBalance() - -> **setBalance**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> - -Defined in: [packages/library/src/runtime/Balances.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L63) - -#### Parameters - -##### tokenId - -[`TokenId`](TokenId.md) - -##### address - -`PublicKey` - -##### amount - -[`Balance`](Balance.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### transfer() - -> **transfer**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> - -Defined in: [packages/library/src/runtime/Balances.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L72) - -#### Parameters - -##### tokenId - -[`TokenId`](TokenId.md) - -##### from - -`PublicKey` - -##### to - -`PublicKey` - -##### amount - -[`Balance`](Balance.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -`MinimalBalances.transfer` - -*** - -### transferSigned() - -> **transferSigned**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> - -Defined in: [packages/library/src/runtime/Balances.ts:107](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L107) - -#### Parameters - -##### tokenId - -[`TokenId`](TokenId.md) - -##### from - -`PublicKey` - -##### to - -`PublicKey` - -##### amount - -[`Balance`](Balance.md) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/library/classes/BalancesKey.md b/src/pages/docs/reference/library/classes/BalancesKey.md deleted file mode 100644 index e7245d6..0000000 --- a/src/pages/docs/reference/library/classes/BalancesKey.md +++ /dev/null @@ -1,451 +0,0 @@ ---- -title: BalancesKey ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / BalancesKey - -# Class: BalancesKey - -Defined in: [packages/library/src/runtime/Balances.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L19) - -## Extends - -- `object` - -## Constructors - -### new BalancesKey() - -> **new BalancesKey**(`value`): [`BalancesKey`](BalancesKey.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -[`TokenId`](TokenId.md) = `TokenId` - -#### Returns - -[`BalancesKey`](BalancesKey.md) - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).constructor` - -## Properties - -### address - -> **address**: `PublicKey` = `PublicKey` - -Defined in: [packages/library/src/runtime/Balances.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L21) - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).address` - -*** - -### tokenId - -> **tokenId**: [`TokenId`](TokenId.md) = `TokenId` - -Defined in: [packages/library/src/runtime/Balances.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L20) - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).tokenId` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -[`TokenId`](TokenId.md) = `TokenId` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: [`TokenId`](TokenId.md) = `TokenId` - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: [`TokenId`](TokenId.md) = `TokenId` - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### address - -`string` = `PublicKey` - -###### tokenId - -`string` = `TokenId` - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: [`TokenId`](TokenId.md) = `TokenId` - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -[`TokenId`](TokenId.md) = `TokenId` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -[`TokenId`](TokenId.md) = `TokenId` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -[`TokenId`](TokenId.md) = `TokenId` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -[`TokenId`](TokenId.md) = `TokenId` - -#### Returns - -`object` - -##### address - -> **address**: `string` = `PublicKey` - -##### tokenId - -> **tokenId**: `string` = `TokenId` - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -[`TokenId`](TokenId.md) = `TokenId` - -#### Returns - -`object` - -##### address - -> **address**: `object` = `PublicKey` - -###### address.isOdd - -> **address.isOdd**: `boolean` - -###### address.x - -> **address.x**: `bigint` - -##### tokenId - -> **tokenId**: `bigint` = `TokenId` - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).toValue` - -## Methods - -### from() - -> `static` **from**(`tokenId`, `address`): [`BalancesKey`](BalancesKey.md) - -Defined in: [packages/library/src/runtime/Balances.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L23) - -#### Parameters - -##### tokenId - -[`TokenId`](TokenId.md) - -##### address - -`PublicKey` - -#### Returns - -[`BalancesKey`](BalancesKey.md) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ tokenId: TokenId, address: PublicKey, }).sizeInFields` diff --git a/src/pages/docs/reference/library/classes/FeeTree.md b/src/pages/docs/reference/library/classes/FeeTree.md deleted file mode 100644 index 4216dca..0000000 --- a/src/pages/docs/reference/library/classes/FeeTree.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -title: FeeTree ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / FeeTree - -# Class: FeeTree - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L44) - -## Extends - -- [`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md) - -## Constructors - -### new FeeTree() - -> **new FeeTree**(`store`): [`FeeTree`](FeeTree.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:113 - -#### Parameters - -##### store - -[`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) - -#### Returns - -[`FeeTree`](FeeTree.md) - -#### Inherited from - -`createMerkleTree(treeFeeHeight).constructor` - -## Properties - -### leafCount - -> `readonly` **leafCount**: `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:78 - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`leafCount`](../../common/interfaces/AbstractMerkleTree.md#leafcount) - -*** - -### store - -> **store**: [`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:77 - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`store`](../../common/interfaces/AbstractMerkleTree.md#store) - -*** - -### EMPTY\_ROOT - -> `static` **EMPTY\_ROOT**: `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:118 - -#### Inherited from - -`createMerkleTree(treeFeeHeight).EMPTY_ROOT` - -*** - -### HEIGHT - -> `static` **HEIGHT**: `number` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:117 - -#### Inherited from - -`createMerkleTree(treeFeeHeight).HEIGHT` - -*** - -### WITNESS - -> `static` **WITNESS**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:114 - -#### Type declaration - -##### dummy() - -> **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -###### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -#### Inherited from - -`createMerkleTree(treeFeeHeight).WITNESS` - -## Accessors - -### leafCount - -#### Get Signature - -> **get** `static` **leafCount**(): `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:119 - -##### Returns - -`bigint` - -#### Inherited from - -`createMerkleTree(treeFeeHeight).leafCount` - -## Methods - -### assertIndexRange() - -> **assertIndexRange**(`index`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:79 - -#### Parameters - -##### index - -`bigint` - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`assertIndexRange`](../../common/interfaces/AbstractMerkleTree.md#assertindexrange) - -*** - -### fill() - -> **fill**(`leaves`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:110 - -Fills all leaves of the tree. - -#### Parameters - -##### leaves - -`Field`[] - -Values to fill the leaves with. - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`fill`](../../common/interfaces/AbstractMerkleTree.md#fill) - -*** - -### getNode() - -> **getNode**(`level`, `index`): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:86 - -Returns a node which lives at a given index and level. - -#### Parameters - -##### level - -`number` - -Level of the node. - -##### index - -`bigint` - -Index of the node. - -#### Returns - -`Field` - -The data of the node. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getNode`](../../common/interfaces/AbstractMerkleTree.md#getnode) - -*** - -### getRoot() - -> **getRoot**(): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:91 - -Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). - -#### Returns - -`Field` - -The root of the Merkle Tree. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getRoot`](../../common/interfaces/AbstractMerkleTree.md#getroot) - -*** - -### getWitness() - -> **getWitness**(`index`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:105 - -Returns the witness (also known as -[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) -for the leaf at the given index. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -#### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -The witness that belongs to the leaf. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getWitness`](../../common/interfaces/AbstractMerkleTree.md#getwitness) - -*** - -### setLeaf() - -> **setLeaf**(`index`, `leaf`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:97 - -Sets the value of a leaf node at a given index to a given value. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -##### leaf - -`Field` - -New value. - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`setLeaf`](../../common/interfaces/AbstractMerkleTree.md#setleaf) diff --git a/src/pages/docs/reference/library/classes/InMemorySequencerModules.md b/src/pages/docs/reference/library/classes/InMemorySequencerModules.md deleted file mode 100644 index 35e9eff..0000000 --- a/src/pages/docs/reference/library/classes/InMemorySequencerModules.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: InMemorySequencerModules ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / InMemorySequencerModules - -# Class: InMemorySequencerModules - -Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/InMemorySequencerModules.ts#L33) - -## Constructors - -### new InMemorySequencerModules() - -> **new InMemorySequencerModules**(): [`InMemorySequencerModules`](InMemorySequencerModules.md) - -#### Returns - -[`InMemorySequencerModules`](InMemorySequencerModules.md) - -## Methods - -### with() - -> `static` **with**\<`SequencerModules`\>(`additionalModules`): `object` & `SequencerModules` - -Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/InMemorySequencerModules.ts#L34) - -#### Type Parameters - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -#### Parameters - -##### additionalModules - -`SequencerModules` - -#### Returns - -`object` & `SequencerModules` diff --git a/src/pages/docs/reference/library/classes/MethodFeeConfigData.md b/src/pages/docs/reference/library/classes/MethodFeeConfigData.md deleted file mode 100644 index 70abdc2..0000000 --- a/src/pages/docs/reference/library/classes/MethodFeeConfigData.md +++ /dev/null @@ -1,597 +0,0 @@ ---- -title: MethodFeeConfigData ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / MethodFeeConfigData - -# Class: MethodFeeConfigData - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L32) - -## Extends - -- `object` - -## Constructors - -### new MethodFeeConfigData() - -> **new MethodFeeConfigData**(`value`): [`MethodFeeConfigData`](MethodFeeConfigData.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### baseFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### methodId - -`Field` = `Field` - -###### perWeightUnitFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### weight - -[`UInt64`](UInt64.md) = `UInt64` - -#### Returns - -[`MethodFeeConfigData`](MethodFeeConfigData.md) - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).constructor` - -## Properties - -### baseFee - -> **baseFee**: [`UInt64`](UInt64.md) = `UInt64` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L34) - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).baseFee` - -*** - -### methodId - -> **methodId**: `Field` = `Field` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L33) - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).methodId` - -*** - -### perWeightUnitFee - -> **perWeightUnitFee**: [`UInt64`](UInt64.md) = `UInt64` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L35) - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).perWeightUnitFee` - -*** - -### weight - -> **weight**: [`UInt64`](UInt64.md) = `UInt64` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L36) - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).weight` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### baseFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### methodId - -`Field` = `Field` - -###### perWeightUnitFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### weight - -[`UInt64`](UInt64.md) = `UInt64` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### baseFee - -> **baseFee**: [`UInt64`](UInt64.md) = `UInt64` - -##### methodId - -> **methodId**: `Field` = `Field` - -##### perWeightUnitFee - -> **perWeightUnitFee**: [`UInt64`](UInt64.md) = `UInt64` - -##### weight - -> **weight**: [`UInt64`](UInt64.md) = `UInt64` - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### baseFee - -> **baseFee**: [`UInt64`](UInt64.md) = `UInt64` - -##### methodId - -> **methodId**: `Field` = `Field` - -##### perWeightUnitFee - -> **perWeightUnitFee**: [`UInt64`](UInt64.md) = `UInt64` - -##### weight - -> **weight**: [`UInt64`](UInt64.md) = `UInt64` - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### baseFee - -\{ `value`: `string`; \} = `UInt64` - -###### baseFee.value - -`string` = `Field` - -###### methodId - -`string` = `Field` - -###### perWeightUnitFee - -\{ `value`: `string`; \} = `UInt64` - -###### perWeightUnitFee.value - -`string` = `Field` - -###### weight - -\{ `value`: `string`; \} = `UInt64` - -###### weight.value - -`string` = `Field` - -#### Returns - -`object` - -##### baseFee - -> **baseFee**: [`UInt64`](UInt64.md) = `UInt64` - -##### methodId - -> **methodId**: `Field` = `Field` - -##### perWeightUnitFee - -> **perWeightUnitFee**: [`UInt64`](UInt64.md) = `UInt64` - -##### weight - -> **weight**: [`UInt64`](UInt64.md) = `UInt64` - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### baseFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### methodId - -`Field` = `Field` - -###### perWeightUnitFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### weight - -[`UInt64`](UInt64.md) = `UInt64` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### baseFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### methodId - -`Field` = `Field` - -###### perWeightUnitFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### weight - -[`UInt64`](UInt64.md) = `UInt64` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### baseFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### methodId - -`Field` = `Field` - -###### perWeightUnitFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### weight - -[`UInt64`](UInt64.md) = `UInt64` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### baseFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### methodId - -`Field` = `Field` - -###### perWeightUnitFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### weight - -[`UInt64`](UInt64.md) = `UInt64` - -#### Returns - -`object` - -##### baseFee - -> **baseFee**: `object` = `UInt64` - -###### baseFee.value - -> **baseFee.value**: `string` = `Field` - -##### methodId - -> **methodId**: `string` = `Field` - -##### perWeightUnitFee - -> **perWeightUnitFee**: `object` = `UInt64` - -###### perWeightUnitFee.value - -> **perWeightUnitFee.value**: `string` = `Field` - -##### weight - -> **weight**: `object` = `UInt64` - -###### weight.value - -> **weight.value**: `string` = `Field` - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### baseFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### methodId - -`Field` = `Field` - -###### perWeightUnitFee - -[`UInt64`](UInt64.md) = `UInt64` - -###### weight - -[`UInt64`](UInt64.md) = `UInt64` - -#### Returns - -`object` - -##### baseFee - -> **baseFee**: `object` = `UInt64` - -###### baseFee.value - -> **baseFee.value**: `bigint` = `Field` - -##### methodId - -> **methodId**: `bigint` = `Field` - -##### perWeightUnitFee - -> **perWeightUnitFee**: `object` = `UInt64` - -###### perWeightUnitFee.value - -> **perWeightUnitFee.value**: `bigint` = `Field` - -##### weight - -> **weight**: `object` = `UInt64` - -###### weight.value - -> **weight.value**: `bigint` = `Field` - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).toValue` - -## Methods - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L38) - -#### Returns - -`Field` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ methodId: Field, baseFee: UInt64, perWeightUnitFee: UInt64, weight: UInt64, }).sizeInFields` diff --git a/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md b/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md deleted file mode 100644 index d790f3d..0000000 --- a/src/pages/docs/reference/library/classes/RuntimeFeeAnalyzerService.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -title: RuntimeFeeAnalyzerService ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / RuntimeFeeAnalyzerService - -# Class: RuntimeFeeAnalyzerService - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L56) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<[`RuntimeFeeAnalyzerServiceConfig`](../interfaces/RuntimeFeeAnalyzerServiceConfig.md)\> - -## Constructors - -### new RuntimeFeeAnalyzerService() - -> **new RuntimeFeeAnalyzerService**(`runtime`): [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L67) - -#### Parameters - -##### runtime - -[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> - -#### Returns - -[`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) - -#### Overrides - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`RuntimeFeeAnalyzerServiceConfig`](../interfaces/RuntimeFeeAnalyzerServiceConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) - -*** - -### runtime - -> **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L68) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) - -*** - -### getFeeConfig() - -> **getFeeConfig**(`methodId`): [`MethodFeeConfigData`](MethodFeeConfigData.md) - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:169](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L169) - -#### Parameters - -##### methodId - -`bigint` - -#### Returns - -[`MethodFeeConfigData`](MethodFeeConfigData.md) - -*** - -### getFeeTree() - -> **getFeeTree**(): `object` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:161](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L161) - -#### Returns - -`object` - -##### indexes - -> **indexes**: [`FeeIndexes`](../interfaces/FeeIndexes.md) - -##### tree - -> **tree**: [`FeeTree`](FeeTree.md) - -##### values - -> **values**: [`FeeTreeValues`](../interfaces/FeeTreeValues.md) - -*** - -### getRoot() - -> **getRoot**(): `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:185](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L185) - -#### Returns - -`bigint` - -*** - -### getWitness() - -> **getWitness**(`methodId`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:180](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L180) - -#### Parameters - -##### methodId - -`bigint` - -#### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -*** - -### initializeFeeTree() - -> **initializeFeeTree**(): `Promise`\<`void`\> - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L73) - -#### Returns - -`Promise`\<`void`\> - -*** - -### getWitnessType() - -> `static` **getWitnessType**(): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L57) - -#### Returns - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` diff --git a/src/pages/docs/reference/library/classes/SimpleSequencerModules.md b/src/pages/docs/reference/library/classes/SimpleSequencerModules.md deleted file mode 100644 index 90b3cb7..0000000 --- a/src/pages/docs/reference/library/classes/SimpleSequencerModules.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: SimpleSequencerModules ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / SimpleSequencerModules - -# Class: SimpleSequencerModules - -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L46) - -## Constructors - -### new SimpleSequencerModules() - -> **new SimpleSequencerModules**(): [`SimpleSequencerModules`](SimpleSequencerModules.md) - -#### Returns - -[`SimpleSequencerModules`](SimpleSequencerModules.md) - -## Methods - -### defaultConfig() - -> `static` **defaultConfig**(): `object` - -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:97](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L97) - -#### Returns - -`object` - -##### BatchProducerModule - -> **BatchProducerModule**: `object` = `{}` - -##### BlockProducerModule - -> **BlockProducerModule**: `object` - -###### BlockProducerModule.allowEmptyBlock - -> **BlockProducerModule.allowEmptyBlock**: `true` = `true` - -##### Mempool - -> **Mempool**: `object` = `{}` - -##### SequencerStartupModule - -> **SequencerStartupModule**: `object` = `{}` - -*** - -### defaultWorkerConfig() - -> `static` **defaultWorkerConfig**(): `object` - -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L109) - -#### Returns - -`object` - -##### LocalTaskWorkerModule - -> **LocalTaskWorkerModule**: `object` - -###### LocalTaskWorkerModule.BlockBuildingTask - -> **LocalTaskWorkerModule.BlockBuildingTask**: `object` - -###### LocalTaskWorkerModule.BlockReductionTask - -> **LocalTaskWorkerModule.BlockReductionTask**: `object` - -###### LocalTaskWorkerModule.CircuitCompilerTask - -> **LocalTaskWorkerModule.CircuitCompilerTask**: `object` - -###### LocalTaskWorkerModule.RuntimeProvingTask - -> **LocalTaskWorkerModule.RuntimeProvingTask**: `object` - -###### LocalTaskWorkerModule.SettlementProvingTask - -> **LocalTaskWorkerModule.SettlementProvingTask**: `object` - -###### LocalTaskWorkerModule.StateTransitionReductionTask - -> **LocalTaskWorkerModule.StateTransitionReductionTask**: `object` - -###### LocalTaskWorkerModule.StateTransitionTask - -> **LocalTaskWorkerModule.StateTransitionTask**: `object` - -###### LocalTaskWorkerModule.TransactionProvingTask - -> **LocalTaskWorkerModule.TransactionProvingTask**: `object` - -###### LocalTaskWorkerModule.WorkerRegistrationTask - -> **LocalTaskWorkerModule.WorkerRegistrationTask**: `object` - -*** - -### with() - -> `static` **with**\<`SequencerModules`\>(`additionalModules`): `object` & `Omit`\<`SequencerModules`, `"Database"` \| `"BlockTrigger"` \| `"TaskQueue"` \| `"BaseLayer"` \| `"DatabasePruneModule"`\> & `object` - -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L60) - -#### Type Parameters - -• **SequencerModules** *extends* [`AdditionalSequencerModules`](../type-aliases/AdditionalSequencerModules.md) - -#### Parameters - -##### additionalModules - -`SequencerModules` - -#### Returns - -`object` & `Omit`\<`SequencerModules`, `"Database"` \| `"BlockTrigger"` \| `"TaskQueue"` \| `"BaseLayer"` \| `"DatabasePruneModule"`\> & `object` - -*** - -### worker() - -> `static` **worker**\<`QueueModule`, `SequencerModules`\>(`queue`, `additionalModules`): `object` & `SequencerModules` - -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L47) - -#### Type Parameters - -• **QueueModule** *extends* [`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -#### Parameters - -##### queue - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`QueueModule`\> - -##### additionalModules - -`SequencerModules` - -#### Returns - -`object` & `SequencerModules` diff --git a/src/pages/docs/reference/library/classes/TokenId.md b/src/pages/docs/reference/library/classes/TokenId.md deleted file mode 100644 index 0194d26..0000000 --- a/src/pages/docs/reference/library/classes/TokenId.md +++ /dev/null @@ -1,1605 +0,0 @@ ---- -title: TokenId ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / TokenId - -# Class: TokenId - -Defined in: [packages/library/src/runtime/Balances.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L18) - -## Extends - -- `Field` - -## Constructors - -### new TokenId() - -> **new TokenId**(`x`): [`TokenId`](TokenId.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:55 - -Coerce anything "field-like" (bigint, number, string, and Field) to a Field. - -#### Parameters - -##### x - -`string` | `number` | `bigint` | `Field` | `FieldVar` | `FieldConst` - -#### Returns - -[`TokenId`](TokenId.md) - -#### Inherited from - -`Field.constructor` - -## Properties - -### value - -> **value**: `FieldVar` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:46 - -#### Inherited from - -`Field.value` - -*** - -### ORDER - -> `static` **ORDER**: `bigint` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:51 - -The order of the pasta curve that Field type build on as a `bigint`. -Order of the Field is 28948022309329048855892746252171976963363056481941560715954676764349967630337. - -#### Inherited from - -`Field.ORDER` - -*** - -### sizeInBits - -> `static` **sizeInBits**: `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:710 - -The size of a Field element in bits - 255. - -#### Inherited from - -`Field.sizeInBits` - -*** - -### sizeInBytes - -> `static` **sizeInBytes**: `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:706 - -The size of a Field element in bytes - 32. - -#### Inherited from - -`Field.sizeInBytes` - -## Methods - -### add() - -> **add**(`y`): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:159 - -Add a field-like value to this Field element. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Field` - -A Field element equivalent to the modular addition of the two value. - -#### Examples - -```ts -const x = Field(3); -const sum = x.add(5); - -sum.assertEquals(Field(8)); -``` - -**Warning**: This is a modular addition in the pasta field. - -```ts -const x = Field(1); -const sum = x.add(Field(-7)); - -// If you try to print sum - `console.log(sum.toBigInt())` - you will realize that it prints a very big integer because this is modular arithmetic, and 1 + (-7) circles around the field to become p - 6. -// You can use the reverse operation of addition (subtraction) to prove the sum is calculated correctly. - -sum.sub(x).assertEquals(Field(-7)); -sum.sub(Field(-7)).assertEquals(x); -``` - -#### Inherited from - -`Field.add` - -*** - -### assertBool() - -> **assertBool**(`message`?): `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:493 - -Prove that this Field is equal to 0 or 1. -Returns the Field wrapped in a Bool. - -If the assertion fails, the code throws an error. - -#### Parameters - -##### message? - -`string` - -#### Returns - -`Bool` - -#### Inherited from - -`Field.assertBool` - -*** - -### assertEquals() - -> **assertEquals**(`y`, `message`?): `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:130 - -Assert that this Field is equal another "field-like" value. -Calling this function is equivalent to `Field(...).equals(...).assertEquals(Bool(true))`. -See [Field.equals](TokenId.md#equals) for more details. - -**Important**: If an assertion fails, the code throws an error. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -`Field.assertEquals` - -*** - -### assertGreaterThan() - -> **assertGreaterThan**(`y`, `message`?): `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:461 - -Assert that this Field is greater than another "field-like" value. - -Note: This uses fewer constraints than `x.greaterThan(y).assertTrue()`. -See [Field.greaterThan](TokenId.md#greaterthan) for more details. - -**Important**: If an assertion fails, the code throws an error. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -`Field.assertGreaterThan` - -*** - -### assertGreaterThanOrEqual() - -> **assertGreaterThanOrEqual**(`y`, `message`?): `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:473 - -Assert that this Field is greater than or equal to another "field-like" value. - -Note: This uses fewer constraints than `x.greaterThanOrEqual(y).assertTrue()`. -See [Field.greaterThanOrEqual](TokenId.md#greaterthanorequal) for more details. - -**Important**: If an assertion fails, the code throws an error. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -`Field.assertGreaterThanOrEqual` - -*** - -### assertLessThan() - -> **assertLessThan**(`y`, `message`?): `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:437 - -Assert that this Field is less than another "field-like" value. - -Note: This uses fewer constraints than `x.lessThan(y).assertTrue()`. -See [lessThan](TokenId.md#lessthan) for more details. - -**Important**: If an assertion fails, the code throws an error. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -`Field.assertLessThan` - -*** - -### assertLessThanOrEqual() - -> **assertLessThanOrEqual**(`y`, `message`?): `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:449 - -Assert that this Field is less than or equal to another "field-like" value. - -Note: This uses fewer constraints than `x.lessThanOrEqual(y).assertTrue()`. -See [Field.lessThanOrEqual](TokenId.md#lessthanorequal) for more details. - -**Important**: If an assertion fails, the code throws an error. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -`Field.assertLessThanOrEqual` - -*** - -### assertNotEquals() - -> **assertNotEquals**(`y`, `message`?): `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:484 - -Assert that this Field does not equal another field-like value. - -Note: This uses fewer constraints than `x.equals(y).assertFalse()`. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -##### message? - -`string` - -#### Returns - -`void` - -#### Example - -```ts -x.assertNotEquals(0, "expect x to be non-zero"); -``` - -#### Inherited from - -`Field.assertNotEquals` - -*** - -### div() - -> **div**(`y`): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:293 - -Divide another "field-like" value through this Field. - -Proves that the denominator is non-zero, or throws a "Division by zero" error. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Field` - -A Field element equivalent to the modular division of the two value. - -#### Examples - -```ts -const x = Field(6); -const quotient = x.div(Field(3)); - -quotient.assertEquals(Field(2)); -``` - -**Warning**: This is a modular division in the pasta field. You can think this as the reverse operation of modular multiplication. - -```ts -const x = Field(2); -const y = Field(5); - -const quotient = x.div(y); - -// If you try to print quotient - `console.log(quotient.toBigInt())` - you will realize that it prints a very big integer because this is a modular inverse. -// You can use the reverse operation of division (multiplication) to prove the quotient is calculated correctly. - -quotient.mul(y).assertEquals(x); -``` - -#### Inherited from - -`Field.div` - -*** - -### equals() - -> **equals**(`y`): `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:341 - -Check if this Field is equal another "field-like" value. -Returns a Bool, which is a provable type and can be used to prove the validity of this statement. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Bool` - -A Bool representing if this Field is equal another "field-like" value. - -#### Example - -```ts -Field(5).equals(5).assertEquals(Bool(true)); -``` - -#### Inherited from - -`Field.equals` - -*** - -### greaterThan() - -> **greaterThan**(`y`): `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:404 - -Check if this Field is greater than another "field-like" value. -Returns a Bool, which is a provable type and can be used to prove the validity of this statement. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Bool` - -A Bool representing if this Field is greater than another "field-like" value. - -#### Examples - -```ts -let isTrue = Field(5).greaterThan(3); -``` - -**Warning**: As this method compares the bigint value of a Field, it can result in unexpected behaviour when used with negative inputs or modular division. - -```ts -let isFalse = Field(1).div(2).greaterThan(Field(1).div(3); // in fact, 1/3 > 1/2 -``` - -#### Inherited from - -`Field.greaterThan` - -*** - -### greaterThanOrEqual() - -> **greaterThanOrEqual**(`y`): `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:425 - -Check if this Field is greater than or equal another "field-like" value. -Returns a Bool, which is a provable type and can be used to prove the validity of this statement. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Bool` - -A Bool representing if this Field is greater than or equal another "field-like" value. - -#### Examples - -```ts -let isTrue = Field(3).greaterThanOrEqual(3); -``` - -**Warning**: As this method compares the bigint value of a Field, it can result in unexpected behaviour when used with negative inputs or modular division. - -```ts -let isFalse = Field(1).div(2).greaterThanOrEqual(Field(1).div(3); // in fact, 1/3 > 1/2 -``` - -#### Inherited from - -`Field.greaterThanOrEqual` - -*** - -### inv() - -> **inv**(): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:260 - -[Modular inverse](https://en.wikipedia.org/wiki/Modular_multiplicative_inverse) of this Field element. -Equivalent to 1 divided by this Field, in the sense of modular arithmetic. - -Proves that this Field is non-zero, or throws a "Division by zero" error. - -#### Returns - -`Field` - -A Field element that is equivalent to one divided by this element. - -#### Example - -```ts -const someField = Field(42); -const inverse = someField.inv(); -inverse.assertEquals(Field(1).div(someField)); // This statement is always true regardless of the value of `someField` -``` - -**Warning**: This is a modular inverse. See [div](TokenId.md#div) method for more details. - -#### Inherited from - -`Field.inv` - -*** - -### isConstant() - -> **isConstant**(): `this is { value: ConstantFieldVar }` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:75 - -Check whether this Field element is a hard-coded constant in the constraint system. -If a Field is constructed outside a zkApp method, it is a constant. - -#### Returns - -`this is { value: ConstantFieldVar }` - -A `boolean` showing if this Field is a constant or not. - -#### Examples - -```ts -console.log(Field(42).isConstant()); // true -``` - -```ts -\@method myMethod(x: Field) { - console.log(x.isConstant()); // false -} -``` - -#### Inherited from - -`Field.isConstant` - -*** - -### isEven() - -> **isEven**(): `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:226 - -Checks if this Field is even. Returns `true` for even elements and `false` for odd elements. - -#### Returns - -`Bool` - -#### Example - -```ts -let a = Field(5); -a.isEven(); // false - -let b = Field(4); -b.isEven(); // true -``` - -#### Inherited from - -`Field.isEven` - -*** - -### isOdd() - -> **isOdd**(): `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:213 - -Checks if this Field is odd. Returns `true` for odd elements and `false` for even elements. - -See [Field.isEven](TokenId.md#iseven) for examples. - -#### Returns - -`Bool` - -#### Inherited from - -`Field.isOdd` - -*** - -### lessThan() - -> **lessThan**(`y`): `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:362 - -Check if this Field is less than another "field-like" value. -Returns a Bool, which is a provable type and can be used prove to the validity of this statement. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Bool` - -A Bool representing if this Field is less than another "field-like" value. - -#### Examples - -```ts -let isTrue = Field(2).lessThan(3); -``` - -**Warning**: As this method compares the bigint value of a Field, it can result in unexpected behavior when used with negative inputs or modular division. - -```ts -let isFalse = Field(1).div(3).lessThan(Field(1).div(2)); // in fact, 1/3 > 1/2 -``` - -#### Inherited from - -`Field.lessThan` - -*** - -### lessThanOrEqual() - -> **lessThanOrEqual**(`y`): `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:383 - -Check if this Field is less than or equal to another "field-like" value. -Returns a Bool, which is a provable type and can be used to prove the validity of this statement. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Bool` - -A Bool representing if this Field is less than or equal another "field-like" value. - -#### Examples - -```ts -let isTrue = Field(3).lessThanOrEqual(3); -``` - -**Warning**: As this method compares the bigint value of a Field, it can result in unexpected behaviour when used with negative inputs or modular division. - -```ts -let isFalse = Field(1).div(3).lessThanOrEqual(Field(1).div(2)); // in fact, 1/3 > 1/2 -``` - -#### Inherited from - -`Field.lessThanOrEqual` - -*** - -### mul() - -> **mul**(`y`): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:242 - -Multiply another "field-like" value with this Field element. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Field` - -A Field element equivalent to the modular difference of the two value. - -#### Example - -```ts -const x = Field(3); -const product = x.mul(Field(5)); - -product.assertEquals(Field(15)); -``` - -#### Inherited from - -`Field.mul` - -*** - -### neg() - -> **neg**(): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:179 - -Negate a Field. This is equivalent to multiplying the Field by -1. - -#### Returns - -`Field` - -A Field element that is equivalent to the element multiplied by -1. - -#### Examples - -```ts -const negOne = Field(1).neg(); -negOne.assertEquals(-1); -``` - -```ts -const someField = Field(42); -someField.neg().assertEquals(someField.mul(Field(-1))); // This statement is always true regardless of the value of `someField` -``` - -**Warning**: This is a modular negation. For details, see the [sub](TokenId.md#sub) method. - -#### Inherited from - -`Field.neg` - -*** - -### seal() - -> **seal**(): `VarField` \| `ConstantField` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:531 - -**Warning**: This function is mainly for internal use. Normally it is not intended to be used by a zkApp developer. - -In o1js, addition and scaling (multiplication of variables by a constant) of variables is represented as an AST - [abstract syntax tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree). For example, the expression `x.add(y).mul(2)` is represented as `Scale(2, Add(x, y))`. - - A new internal variable is created only when the variable is needed in a multiplicative or any higher level constraint (for example multiplication of two Field elements) to represent the operation. - -The `seal()` function tells o1js to stop building an AST and create a new variable right away. - -#### Returns - -`VarField` \| `ConstantField` - -A Field element that is equal to the result of AST that was previously on this Field element. - -#### Inherited from - -`Field.seal` - -*** - -### sqrt() - -> **sqrt**(): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:327 - -Take the square root of this Field element. - -Proves that the Field element has a square root in the finite field, or throws if it doesn't. - -#### Returns - -`Field` - -A Field element equivalent to the square root of the Field element. - -#### Example - -```ts -let z = x.sqrt(); -z.mul(z).assertEquals(x); // true for every `x` -``` - -**Warning**: This is a modular square root, which is any number z that satisfies z*z = x (mod p). -Note that, if a square root z exists, there also exists a second one, -z (which is different if z != 0). -Therefore, this method leaves an adversarial prover the choice between two different values to return. - -#### Inherited from - -`Field.sqrt` - -*** - -### square() - -> **square**(): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:309 - -Square this Field element. - -#### Returns - -`Field` - -A Field element equivalent to the multiplication of the Field element with itself. - -#### Example - -```ts -const someField = Field(7); -const square = someField.square(); - -square.assertEquals(someField.mul(someField)); // This statement is always true regardless of the value of `someField` -``` - -** Warning: This is a modular multiplication. See `mul()` method for more details. - -#### Inherited from - -`Field.square` - -*** - -### sub() - -> **sub**(`y`): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:207 - -Subtract another "field-like" value from this Field element. - -#### Parameters - -##### y - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Field` - -A Field element equivalent to the modular difference of the two value. - -#### Examples - -```ts -const x = Field(3); -const difference = x.sub(5); - -difference.assertEquals(Field(-2)); -``` - -**Warning**: This is a modular subtraction in the pasta field. - -```ts -const x = Field(1); -const difference = x.sub(Field(2)); - -// If you try to print difference - `console.log(difference.toBigInt())` - you will realize that it prints a very big integer because this is modular arithmetic, and 1 - 2 circles around the field to become p - 1. -// You can use the reverse operation of subtraction (addition) to prove the difference is calculated correctly. -difference.add(Field(2)).assertEquals(x); -``` - -#### Inherited from - -`Field.sub` - -*** - -### toAuxiliary() - -> **toAuxiliary**(): \[\] - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:621 - -This function is the implementation of Provable.toAuxiliary for the Field type. - -As the primitive Field type has no auxiliary data associated with it, this function will always return an empty array. - -#### Returns - -\[\] - -#### Inherited from - -`Field.toAuxiliary` - -*** - -### toBigInt() - -> **toBigInt**(): `bigint` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:105 - -Serialize the Field to a bigint, e.g. for printing. Trying to print a Field without this function will directly stringify the Field object, resulting in unreadable output. - -**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the bigint representation of the Field. Use the operation only during debugging. - -#### Returns - -`bigint` - -A bigint equivalent to the bigint representation of the Field. - -#### Example - -```ts -const someField = Field(42); -console.log(someField.toBigInt()); -``` - -#### Inherited from - -`Field.toBigInt` - -*** - -### toBits() - -> **toBits**(`length`?): `Bool`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:507 - -Returns an array of Bool elements representing [little endian binary representation](https://en.wikipedia.org/wiki/Endianness) of this Field element. - -If you use the optional `length` argument, proves that the field element fits in `length` bits. -The `length` has to be between 0 and 254 and the method throws if it isn't. - -**Warning**: The cost of this operation in a zk proof depends on the `length` you specify, -which by default is 254 bits. Prefer to pass a smaller `length` if possible. - -#### Parameters - -##### length? - -`number` - -the number of bits to fit the element. If the element does not fit in `length` bits, the functions throws an error. - -#### Returns - -`Bool`[] - -An array of Bool element representing little endian binary representation of this Field. - -#### Inherited from - -`Field.toBits` - -*** - -### toConstant() - -> **toConstant**(): `ConstantField` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:91 - -Create a Field element equivalent to this Field element's value, -but is a constant. -See [Field.isConstant](TokenId.md#isconstant) for more information about what is a constant Field. - -#### Returns - -`ConstantField` - -A constant Field element equivalent to this Field element. - -#### Example - -```ts -const someField = Field(42); -someField.toConstant().assertEquals(someField); // Always true -``` - -#### Inherited from - -`Field.toConstant` - -*** - -### toFields() - -> **toFields**(): `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:615 - -This function is the implementation of Provable.toFields for the Field type. - -The result will be always an array of length 1, where the first and only element equals the Field itself. - -#### Returns - -`Field`[] - -A Field array of length 1 created from this Field. - -#### Inherited from - -`Field.toFields` - -*** - -### toJSON() - -> **toJSON**(): `string` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:636 - -Serialize the Field to a JSON string, e.g. for printing. Trying to print a Field without this function will directly stringify the Field object, resulting in unreadable output. - -**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the JSON string representation of the Field. Use the operation only during debugging. - -#### Returns - -`string` - -A string equivalent to the JSON representation of the Field. - -#### Example - -```ts -const someField = Field(42); -console.log(someField.toJSON()); -``` - -#### Inherited from - -`Field.toJSON` - -*** - -### toString() - -> **toString**(): `string` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:119 - -Serialize the Field to a string, e.g. for printing. Trying to print a Field without this function will directly stringify the Field object, resulting in unreadable output. - -**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the string representation of the Field. Use the operation only during debugging. - -#### Returns - -`string` - -A string equivalent to the string representation of the Field. - -#### Example - -```ts -const someField = Field(42); -console.log(someField.toString()); -``` - -#### Inherited from - -`Field.toString` - -*** - -### check() - -> `static` **check**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:595 - -This function is the implementation of Provable.check in Field type. - -As any field element can be a Field, this function does not create any assertions, so it does nothing. - -#### Returns - -`void` - -#### Inherited from - -`Field.check` - -*** - -### empty() - -> `static` **empty**(): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:622 - -#### Returns - -`Field` - -#### Inherited from - -`Field.empty` - -*** - -### from() - -> `static` **from**(`x`): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:56 - -#### Parameters - -##### x - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Field` - -#### Inherited from - -`Field.from` - -*** - -### fromBits() - -> `static` **fromBits**(`bits`): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:519 - -Convert a bit array into a Field element using [little endian binary representation](https://en.wikipedia.org/wiki/Endianness) - -The method throws if the given bits do not fit in a single Field element. In this case, no more than 254 bits are allowed because some 255 bit integers do not fit into a single Field element. - -**Important**: If the given `bytes` array is an array of `booleans` or Bool elements that all are `constant`, the resulting Field element will be a constant as well. Or else, if the given array is a mixture of constants and variables of Bool type, the resulting Field will be a variable as well. - -#### Parameters - -##### bits - -(`boolean` \| `Bool`)[] - -#### Returns - -`Field` - -A Field element matching the [little endian binary representation](https://en.wikipedia.org/wiki/Endianness) of the given `bytes` array. - -#### Inherited from - -`Field.fromBits` - -*** - -### fromBytes() - -> `static` **fromBytes**(`bytes`): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:702 - -Coerce a new Field element using the [little-endian](https://en.wikipedia.org/wiki/Endianness) representation of the given `bytes` array. -Note that the given `bytes` array may have at most 32 elements as the Field is a `finite-field` in the order of [Field.ORDER](TokenId.md#order). - -**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the byte representation of the Field. - -#### Parameters - -##### bytes - -`number`[] - -The bytes array to coerce the Field from. - -#### Returns - -`Field` - -A new Field element created using the [little-endian](https://en.wikipedia.org/wiki/Endianness) representation of the given `bytes` array. - -#### Inherited from - -`Field.fromBytes` - -*** - -### fromFields() - -> `static` **fromFields**(`fields`): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:587 - -Implementation of Provable.fromFields for the Field type. - -**Warning**: This function is designed for internal use. It is not intended to be used by a zkApp developer. - -Creates a Field from an array of Fields of length 1. - -#### Parameters - -##### fields - -`Field`[] - -an array of length 1 serialized from Field elements. - -#### Returns - -`Field` - -The first Field element of the given array. - -#### Inherited from - -`Field.fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**(`json`): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:662 - -Deserialize a JSON string containing a "field-like" value into a Field element. - -**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the string representation of the Field. - -#### Parameters - -##### json - -`string` - -#### Returns - -`Field` - -A Field coerced from the given JSON string. - -#### Inherited from - -`Field.fromJSON` - -*** - -### fromValue() - -> `static` **fromValue**(`x`): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:607 - -`Provable.fromValue()` - -#### Parameters - -##### x - -`string` | `number` | `bigint` | `Field` - -#### Returns - -`Field` - -#### Inherited from - -`Field.fromValue` - -*** - -### random() - -> `static` **random**(): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:542 - -A random Field element. - -#### Returns - -`Field` - -A random Field element. - -#### Example - -```ts -console.log(Field.random().toBigInt()); // Run this code twice! -``` - -#### Inherited from - -`Field.random` - -*** - -### readBytes() - -> `static` **readBytes**\<`N`\>(`bytes`, `offset`): \[`Field`, `number`\] - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:691 - -Part of the `Binable` interface. - -**Warning**: This function is for internal use. It is not intended to be used by a zkApp developer. - -#### Type Parameters - -• **N** *extends* `number` - -#### Parameters - -##### bytes - -`number`[] - -##### offset - -`NonNegativeInteger`\<`N`\> - -#### Returns - -\[`Field`, `number`\] - -#### Inherited from - -`Field.readBytes` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:575 - -This function is the implementation of Provable.sizeInFields for the Field type. - -Size of the Field type is 1, as it is the primitive type. -This function returns a regular number, so you cannot use it to prove something on chain. You can use it during debugging or to understand the memory complexity of some type. - -#### Returns - -`number` - -A number representing the size of the Field type in terms of Field type itself. - -#### Example - -```ts -console.log(Field.sizeInFields()); // Prints 1 -``` - -#### Inherited from - -`Field.sizeInFields` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**(): \[\] - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:561 - -This function is the implementation of Provable.toAuxiliary for the Field type. - -As the primitive Field type has no auxiliary data associated with it, this function will always return an empty array. - -#### Returns - -\[\] - -#### Inherited from - -`Field.toAuxiliary` - -*** - -### toBigint() - -> `static` **toBigint**(`x`): `bigint` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:603 - -Convert a Field element to a bigint. - -#### Parameters - -##### x - -`Field` - -#### Returns - -`bigint` - -#### Inherited from - -`Field.toBigint` - -*** - -### toBytes() - -> `static` **toBytes**(`x`): `number`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:685 - -Create an array of digits equal to the [little-endian](https://en.wikipedia.org/wiki/Endianness) byte order of the given Field element. -Note that the array has always 32 elements as the Field is a `finite-field` in the order of [Field.ORDER](TokenId.md#order). - -#### Parameters - -##### x - -`Field` - -#### Returns - -`number`[] - -An array of digits equal to the [little-endian](https://en.wikipedia.org/wiki/Endianness) byte order of the given Field element. - -#### Inherited from - -`Field.toBytes` - -*** - -### toFields() - -> `static` **toFields**(`x`): `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:553 - -This function is the implementation of Provable.toFields for the Field type. - -Static function to serializes a Field into an array of Field elements. -This will be always an array of length 1, where the first and only element equals the given parameter itself. - -#### Parameters - -##### x - -`Field` - -#### Returns - -`Field`[] - -A Field array of length 1 created from this Field. - -#### Inherited from - -`Field.toFields` - -*** - -### toInput() - -> `static` **toInput**(`x`): `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:673 - -**Warning**: This function is mainly for internal use. Normally it is not intended to be used by a zkApp developer. - -This function is the implementation of `ProvableExtended.toInput()` for the Field type. - -#### Parameters - -##### x - -`Field` - -#### Returns - -`object` - -An object where the `fields` key is a Field array of length 1 created from this Field. - -##### fields - -> **fields**: `Field`[] - -#### Inherited from - -`Field.toInput` - -*** - -### toJSON() - -> `static` **toJSON**(`x`): `string` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:652 - -Serialize the given Field element to a JSON string, e.g. for printing. Trying to print a Field without this function will directly stringify the Field object, resulting in unreadable output. - -**Warning**: This operation does _not_ affect the circuit and can't be used to prove anything about the JSON string representation of the Field. Use the operation only during debugging. - -#### Parameters - -##### x - -`Field` - -#### Returns - -`string` - -A string equivalent to the JSON representation of the given Field. - -#### Example - -```ts -const someField = Field(42); -console.log(Field.toJSON(someField)); -``` - -#### Inherited from - -`Field.toJSON` - -*** - -### toValue() - -> `static` **toValue**(`x`): `bigint` - -Defined in: node\_modules/o1js/dist/node/lib/provable/field.d.ts:599 - -`Provable.toValue()` - -#### Parameters - -##### x - -`Field` - -#### Returns - -`bigint` - -#### Inherited from - -`Field.toValue` diff --git a/src/pages/docs/reference/library/classes/TransactionFeeHook.md b/src/pages/docs/reference/library/classes/TransactionFeeHook.md deleted file mode 100644 index 20df290..0000000 --- a/src/pages/docs/reference/library/classes/TransactionFeeHook.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -title: TransactionFeeHook ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / TransactionFeeHook - -# Class: TransactionFeeHook - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L51) - -Transaction hook for deducting transaction fees from the sender's balance. - -## Extends - -- [`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md)\<[`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md)\> - -## Constructors - -### new TransactionFeeHook() - -> **new TransactionFeeHook**(`runtime`, `balances`): [`TransactionFeeHook`](TransactionFeeHook.md) - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L52) - -#### Parameters - -##### runtime - -[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> - -##### balances - -`Balances` - -#### Returns - -[`TransactionFeeHook`](TransactionFeeHook.md) - -#### Overrides - -[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`constructor`](../../protocol/classes/ProvableTransactionHook.md#constructors) - -## Properties - -### balances - -> **balances**: `Balances` - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L55) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`currentConfig`](../../protocol/classes/ProvableTransactionHook.md#currentconfig) - -*** - -### name? - -> `optional` **name**: `string` - -Defined in: packages/protocol/dist/protocol/TransitioningProtocolModule.d.ts:8 - -#### Inherited from - -[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`name`](../../protocol/classes/ProvableTransactionHook.md#name) - -*** - -### persistedFeeAnalyzer - -> `protected` **persistedFeeAnalyzer**: `undefined` \| [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) = `undefined` - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L60) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../../protocol/interfaces/ProtocolEnvironment.md) - -Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:4 - -#### Inherited from - -[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`protocol`](../../protocol/classes/ProvableTransactionHook.md#protocol) - -*** - -### runtime - -> **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L54) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:5 - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`areProofsEnabled`](../../protocol/classes/ProvableTransactionHook.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): [`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L86) - -##### Returns - -[`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) - -#### Set Signature - -> **set** **config**(`value`): `void` - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:91](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L91) - -##### Parameters - -###### value - -[`TransactionFeeHookConfig`](../interfaces/TransactionFeeHookConfig.md) - -##### Returns - -`void` - -#### Overrides - -[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`config`](../../protocol/classes/ProvableTransactionHook.md#config) - -*** - -### feeAnalyzer - -#### Get Signature - -> **get** **feeAnalyzer**(): [`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:95](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L95) - -##### Returns - -[`RuntimeFeeAnalyzerService`](RuntimeFeeAnalyzerService.md) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/protocol/dist/protocol/ProtocolModule.d.ts:6 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`create`](../../protocol/classes/ProvableTransactionHook.md#create) - -*** - -### getFee() - -> **getFee**(`feeConfig`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:111](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L111) - -#### Parameters - -##### feeConfig - -[`MethodFeeConfigData`](MethodFeeConfigData.md) - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -*** - -### onTransaction() - -> **onTransaction**(`executionData`): `Promise`\<`void`\> - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:125](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L125) - -Determine the transaction fee for the given transaction, and transfer it -from the transaction sender to the fee recipient. - -#### Parameters - -##### executionData - -[`BlockProverExecutionData`](../../protocol/classes/BlockProverExecutionData.md) - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`onTransaction`](../../protocol/classes/ProvableTransactionHook.md#ontransaction) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L80) - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`ProvableTransactionHook`](../../protocol/classes/ProvableTransactionHook.md).[`start`](../../protocol/classes/ProvableTransactionHook.md#start) - -*** - -### transferFee() - -> **transferFee**(`from`, `fee`): `Promise`\<`void`\> - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L102) - -#### Parameters - -##### from - -[`PublicKeyOption`](../../protocol/classes/PublicKeyOption.md) - -##### fee - -[`UInt64`](UInt64.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### verifyConfig() - -> **verifyConfig**(): `void` - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L65) - -#### Returns - -`void` diff --git a/src/pages/docs/reference/library/classes/UInt.md b/src/pages/docs/reference/library/classes/UInt.md deleted file mode 100644 index 2a54c0b..0000000 --- a/src/pages/docs/reference/library/classes/UInt.md +++ /dev/null @@ -1,924 +0,0 @@ ---- -title: UInt ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UInt - -# Class: `abstract` UInt\ - -Defined in: [packages/library/src/math/UInt.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L45) - -UInt is a base class for all soft-failing UInt* implementations. -It has to be overridden for every bitlength that should be available. - -For this, the developer has to create a subclass of UInt implementing the -static methods from interface UIntConstructor - -## Extends - -- `object` - -## Extended by - -- [`UInt32`](UInt32.md) -- [`UInt64`](UInt64.md) -- [`UInt112`](UInt112.md) -- [`UInt224`](UInt224.md) - -## Type Parameters - -• **BITS** *extends* `number` - -## Constructors - -### new UInt() - -> **new UInt**\<`BITS`\>(`value`): [`UInt`](UInt.md)\<`BITS`\> - -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) - -#### Parameters - -##### value - -###### value - -`Field` - -#### Returns - -[`UInt`](UInt.md)\<`BITS`\> - -#### Overrides - -`Struct({ value: Field, }).constructor` - -## Properties - -### value - -> **value**: `Field` = `Field` - -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) - -#### Inherited from - -`Struct({ value: Field, }).value` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ value: Field, })._isStruct` - -*** - -### assertionFunction() - -> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` - -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) - -#### Parameters - -##### bool - -`Bool` - -##### msg? - -`string` - -#### Returns - -`void` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### value - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ value: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -`Struct({ value: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -`Struct({ value: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### value - -`string` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -`Struct({ value: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ value: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### value - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ value: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### value - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ value: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ value: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `string` = `Field` - -#### Inherited from - -`Struct({ value: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `bigint` = `Field` - -#### Inherited from - -`Struct({ value: Field, }).toValue` - -## Methods - -### add() - -> **add**(`y`): [`UInt`](UInt.md)\<`BITS`\> - -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) - -Addition with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -[`UInt`](UInt.md)\<`BITS`\> - -*** - -### assertEquals() - -> **assertEquals**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) - -Asserts that a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> - -##### message? - -`string` - -#### Returns - -`void` - -*** - -### assertGreaterThan() - -> **assertGreaterThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) - -Asserts that a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`BITS`\> - -##### message? - -`string` - -#### Returns - -`void` - -*** - -### assertGreaterThanOrEqual() - -> **assertGreaterThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) - -Asserts that a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`BITS`\> - -##### message? - -`string` - -#### Returns - -`void` - -*** - -### assertLessThan() - -> **assertLessThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) - -Asserts that a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`BITS`\> - -##### message? - -`string` - -#### Returns - -`void` - -*** - -### assertLessThanOrEqual() - -> **assertLessThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) - -Asserts that a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`BITS`\> - -##### message? - -`string` - -#### Returns - -`void` - -*** - -### constructorReference() - -> `abstract` **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`BITS`\> - -Defined in: [packages/library/src/math/UInt.ts:91](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L91) - -#### Returns - -[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`BITS`\> - -*** - -### div() - -> **div**(`y`): [`UInt`](UInt.md)\<`BITS`\> - -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) - -Integer division. - -`x.div(y)` returns the floor of `x / y`, that is, the greatest -`z` such that `z * y <= x`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -[`UInt`](UInt.md)\<`BITS`\> - -*** - -### divMod() - -> **divMod**(`divisor`): `object` - -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) - -Integer division with remainder. - -`x.divMod(y)` returns the quotient and the remainder. - -#### Parameters - -##### divisor - -`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -`object` - -##### quotient - -> **quotient**: [`UInt`](UInt.md)\<`BITS`\> - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`BITS`\> - -*** - -### equals() - -> **equals**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) - -Checks if a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -`Bool` - -*** - -### greaterThan() - -> **greaterThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) - -Checks if a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -`Bool` - -*** - -### greaterThanOrEqual() - -> **greaterThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) - -Checks if a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -`Bool` - -*** - -### lessThan() - -> **lessThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) - -Checks if a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -`Bool` - -*** - -### lessThanOrEqual() - -> **lessThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) - -Checks if a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -`Bool` - -*** - -### mod() - -> **mod**(`y`): [`UInt`](UInt.md)\<`BITS`\> - -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) - -Integer remainder. - -`x.mod(y)` returns the value `z` such that `0 <= z < y` and -`x - z` is divisble by `y`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -[`UInt`](UInt.md)\<`BITS`\> - -*** - -### mul() - -> **mul**(`y`): [`UInt`](UInt.md)\<`BITS`\> - -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) - -Multiplication with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -[`UInt`](UInt.md)\<`BITS`\> - -*** - -### numBits() - -> `abstract` **numBits**(): `BITS` - -Defined in: [packages/library/src/math/UInt.ts:89](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L89) - -#### Returns - -`BITS` - -*** - -### sqrtFloor() - -> **sqrtFloor**(): [`UInt`](UInt.md)\<`BITS`\> - -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) - -Wraps sqrtMod() by only returning the sqrt and omitting the rest field. - -#### Returns - -[`UInt`](UInt.md)\<`BITS`\> - -*** - -### sqrtMod() - -> **sqrtMod**(): `object` - -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) - -Implements a non-overflowing square-root with rest. -Normal Field.sqrt() provides the sqrt as it is defined by the finite -field operations. This implementation however mimics the natural-numbers -style of sqrt to be used inside applications with the tradeoff that it -also returns a "rest" that indicates the amount the actual result is off -(since we floor the result to stay inside the ff). - -Some assertions are hard-failing, because they represent malicious -witness values - -#### Returns - -`object` - -sqrt: The non-overflowing sqrt - -rest: The remainder indicating how far off the result -is from the "real" sqrt - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`BITS`\> - -##### sqrt - -> **sqrt**: [`UInt`](UInt.md)\<`BITS`\> - -*** - -### sub() - -> **sub**(`y`): [`UInt`](UInt.md)\<`BITS`\> - -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) - -Subtraction with underflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`BITS`\> - -#### Returns - -[`UInt`](UInt.md)\<`BITS`\> - -*** - -### toBigInt() - -> **toBigInt**(): `bigint` - -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) - -Turns the [UInt](UInt.md) into a BigInt. - -#### Returns - -`bigint` - -*** - -### toO1UInt64() - -> **toO1UInt64**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. - -#### Returns - -`UInt64` - -*** - -### toO1UInt64Clamped() - -> **toO1UInt64Clamped**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), -clamping to the 64 bits range if it's too large. - -#### Returns - -`UInt64` - -*** - -### toString() - -> **toString**(): `string` - -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) - -Turns the [UInt](UInt.md) into a string. - -#### Returns - -`string` - -*** - -### checkConstant() - -> `static` **checkConstant**(`x`, `numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) - -#### Parameters - -##### x - -`Field` - -##### numBits - -`number` - -#### Returns - -`Field` - -*** - -### maxIntField() - -> `static` **maxIntField**(`numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) - -Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. - -#### Parameters - -##### numBits - -`number` - -#### Returns - -`Field` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ value: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/library/classes/UInt112.md b/src/pages/docs/reference/library/classes/UInt112.md deleted file mode 100644 index 778b5b2..0000000 --- a/src/pages/docs/reference/library/classes/UInt112.md +++ /dev/null @@ -1,1117 +0,0 @@ ---- -title: UInt112 ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UInt112 - -# Class: UInt112 - -Defined in: [packages/library/src/math/UInt112.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L6) - -UInt is a base class for all soft-failing UInt* implementations. -It has to be overridden for every bitlength that should be available. - -For this, the developer has to create a subclass of UInt implementing the -static methods from interface UIntConstructor - -## Extends - -- [`UInt`](UInt.md)\<`112`\> - -## Constructors - -### new UInt112() - -> **new UInt112**(`value`): [`UInt112`](UInt112.md) - -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) - -#### Parameters - -##### value - -###### value - -`Field` - -#### Returns - -[`UInt112`](UInt112.md) - -#### Inherited from - -[`UInt`](UInt.md).[`constructor`](UInt.md#constructors) - -## Properties - -### value - -> **value**: `Field` = `Field` - -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) - -#### Inherited from - -[`UInt`](UInt.md).[`value`](UInt.md#value-2) - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -[`UInt`](UInt.md).[`_isStruct`](UInt.md#_isstruct) - -*** - -### assertionFunction() - -> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` - -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) - -#### Parameters - -##### bool - -`Bool` - -##### msg? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertionFunction`](UInt.md#assertionfunction) - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`empty`](UInt.md#empty) - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`fromFields`](UInt.md#fromfields) - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### value - -`string` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`fromJSON`](UInt.md#fromjson) - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -[`UInt`](UInt.md).[`fromValue`](UInt.md#fromvalue) - -*** - -### Safe - -> `static` **Safe**: `object` - -Defined in: [packages/library/src/math/UInt112.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L13) - -#### fromField() - -##### Parameters - -###### value - -`Field` - -##### Returns - -[`UInt112`](UInt112.md) - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### value - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -[`UInt`](UInt.md).[`toAuxiliary`](UInt.md#toauxiliary) - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### value - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -[`UInt`](UInt.md).[`toFields`](UInt.md#tofields) - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -[`UInt`](UInt.md).[`toInput`](UInt.md#toinput) - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `string` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`toJSON`](UInt.md#tojson) - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `bigint` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`toValue`](UInt.md#tovalue) - -*** - -### Unsafe - -> `static` **Unsafe**: `object` - -Defined in: [packages/library/src/math/UInt112.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L7) - -#### fromField() - -##### Parameters - -###### value - -`Field` - -##### Returns - -[`UInt112`](UInt112.md) - -## Accessors - -### max - -#### Get Signature - -> **get** `static` **max**(): [`UInt112`](UInt112.md) - -Defined in: [packages/library/src/math/UInt112.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L36) - -##### Returns - -[`UInt112`](UInt112.md) - -*** - -### zero - -#### Get Signature - -> **get** `static` **zero**(): [`UInt112`](UInt112.md) - -Defined in: [packages/library/src/math/UInt112.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L32) - -##### Returns - -[`UInt112`](UInt112.md) - -## Methods - -### add() - -> **add**(`y`): [`UInt`](UInt.md)\<`112`\> - -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) - -Addition with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> - -#### Returns - -[`UInt`](UInt.md)\<`112`\> - -#### Inherited from - -[`UInt`](UInt.md).[`add`](UInt.md#add) - -*** - -### assertEquals() - -> **assertEquals**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) - -Asserts that a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertEquals`](UInt.md#assertequals) - -*** - -### assertGreaterThan() - -> **assertGreaterThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) - -Asserts that a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`112`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertGreaterThan`](UInt.md#assertgreaterthan) - -*** - -### assertGreaterThanOrEqual() - -> **assertGreaterThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) - -Asserts that a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`112`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertGreaterThanOrEqual`](UInt.md#assertgreaterthanorequal) - -*** - -### assertLessThan() - -> **assertLessThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) - -Asserts that a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`112`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertLessThan`](UInt.md#assertlessthan) - -*** - -### assertLessThanOrEqual() - -> **assertLessThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) - -Asserts that a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`112`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertLessThanOrEqual`](UInt.md#assertlessthanorequal) - -*** - -### constructorReference() - -> **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`112`\> - -Defined in: [packages/library/src/math/UInt112.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L40) - -#### Returns - -[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`112`\> - -#### Overrides - -[`UInt`](UInt.md).[`constructorReference`](UInt.md#constructorreference) - -*** - -### div() - -> **div**(`y`): [`UInt`](UInt.md)\<`112`\> - -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) - -Integer division. - -`x.div(y)` returns the floor of `x / y`, that is, the greatest -`z` such that `z * y <= x`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> - -#### Returns - -[`UInt`](UInt.md)\<`112`\> - -#### Inherited from - -[`UInt`](UInt.md).[`div`](UInt.md#div) - -*** - -### divMod() - -> **divMod**(`divisor`): `object` - -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) - -Integer division with remainder. - -`x.divMod(y)` returns the quotient and the remainder. - -#### Parameters - -##### divisor - -`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`112`\> - -#### Returns - -`object` - -##### quotient - -> **quotient**: [`UInt`](UInt.md)\<`112`\> - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`112`\> - -#### Inherited from - -[`UInt`](UInt.md).[`divMod`](UInt.md#divmod) - -*** - -### equals() - -> **equals**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) - -Checks if a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`equals`](UInt.md#equals) - -*** - -### greaterThan() - -> **greaterThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) - -Checks if a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`112`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`greaterThan`](UInt.md#greaterthan) - -*** - -### greaterThanOrEqual() - -> **greaterThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) - -Checks if a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`112`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`greaterThanOrEqual`](UInt.md#greaterthanorequal) - -*** - -### lessThan() - -> **lessThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) - -Checks if a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`112`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`lessThan`](UInt.md#lessthan) - -*** - -### lessThanOrEqual() - -> **lessThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) - -Checks if a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`112`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`lessThanOrEqual`](UInt.md#lessthanorequal) - -*** - -### mod() - -> **mod**(`y`): [`UInt`](UInt.md)\<`112`\> - -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) - -Integer remainder. - -`x.mod(y)` returns the value `z` such that `0 <= z < y` and -`x - z` is divisble by `y`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> - -#### Returns - -[`UInt`](UInt.md)\<`112`\> - -#### Inherited from - -[`UInt`](UInt.md).[`mod`](UInt.md#mod) - -*** - -### mul() - -> **mul**(`y`): [`UInt`](UInt.md)\<`112`\> - -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) - -Multiplication with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> - -#### Returns - -[`UInt`](UInt.md)\<`112`\> - -#### Inherited from - -[`UInt`](UInt.md).[`mul`](UInt.md#mul) - -*** - -### numBits() - -> **numBits**(): `112` - -Defined in: [packages/library/src/math/UInt112.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L44) - -#### Returns - -`112` - -#### Overrides - -[`UInt`](UInt.md).[`numBits`](UInt.md#numbits) - -*** - -### sqrtFloor() - -> **sqrtFloor**(): [`UInt`](UInt.md)\<`112`\> - -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) - -Wraps sqrtMod() by only returning the sqrt and omitting the rest field. - -#### Returns - -[`UInt`](UInt.md)\<`112`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sqrtFloor`](UInt.md#sqrtfloor) - -*** - -### sqrtMod() - -> **sqrtMod**(): `object` - -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) - -Implements a non-overflowing square-root with rest. -Normal Field.sqrt() provides the sqrt as it is defined by the finite -field operations. This implementation however mimics the natural-numbers -style of sqrt to be used inside applications with the tradeoff that it -also returns a "rest" that indicates the amount the actual result is off -(since we floor the result to stay inside the ff). - -Some assertions are hard-failing, because they represent malicious -witness values - -#### Returns - -`object` - -sqrt: The non-overflowing sqrt - -rest: The remainder indicating how far off the result -is from the "real" sqrt - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`112`\> - -##### sqrt - -> **sqrt**: [`UInt`](UInt.md)\<`112`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sqrtMod`](UInt.md#sqrtmod) - -*** - -### sub() - -> **sub**(`y`): [`UInt`](UInt.md)\<`112`\> - -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) - -Subtraction with underflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`112`\> - -#### Returns - -[`UInt`](UInt.md)\<`112`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sub`](UInt.md#sub) - -*** - -### toBigInt() - -> **toBigInt**(): `bigint` - -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) - -Turns the [UInt](UInt.md) into a BigInt. - -#### Returns - -`bigint` - -#### Inherited from - -[`UInt`](UInt.md).[`toBigInt`](UInt.md#tobigint) - -*** - -### toO1UInt64() - -> **toO1UInt64**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. - -#### Returns - -`UInt64` - -#### Inherited from - -[`UInt`](UInt.md).[`toO1UInt64`](UInt.md#too1uint64) - -*** - -### toO1UInt64Clamped() - -> **toO1UInt64Clamped**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), -clamping to the 64 bits range if it's too large. - -#### Returns - -`UInt64` - -#### Inherited from - -[`UInt`](UInt.md).[`toO1UInt64Clamped`](UInt.md#too1uint64clamped) - -*** - -### toString() - -> **toString**(): `string` - -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) - -Turns the [UInt](UInt.md) into a string. - -#### Returns - -`string` - -#### Inherited from - -[`UInt`](UInt.md).[`toString`](UInt.md#tostring) - -*** - -### toUInt224() - -> **toUInt224**(): [`UInt224`](UInt224.md) - -Defined in: [packages/library/src/math/UInt112.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L48) - -#### Returns - -[`UInt224`](UInt224.md) - -*** - -### check() - -> `static` **check**(`x`): `void` - -Defined in: [packages/library/src/math/UInt112.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L21) - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### x - -###### value - -`Field` - -#### Returns - -`void` - -#### Overrides - -`UInt.check` - -*** - -### checkConstant() - -> `static` **checkConstant**(`x`, `numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) - -#### Parameters - -##### x - -`Field` - -##### numBits - -`number` - -#### Returns - -`Field` - -#### Inherited from - -[`UInt`](UInt.md).[`checkConstant`](UInt.md#checkconstant) - -*** - -### from() - -> `static` **from**(`x`): [`UInt112`](UInt112.md) - -Defined in: [packages/library/src/math/UInt112.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt112.ts#L25) - -#### Parameters - -##### x - -`string` | `number` | `bigint` | [`UInt112`](UInt112.md) - -#### Returns - -[`UInt112`](UInt112.md) - -*** - -### maxIntField() - -> `static` **maxIntField**(`numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) - -Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. - -#### Parameters - -##### numBits - -`number` - -#### Returns - -`Field` - -#### Inherited from - -[`UInt`](UInt.md).[`maxIntField`](UInt.md#maxintfield) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -[`UInt`](UInt.md).[`sizeInFields`](UInt.md#sizeinfields) diff --git a/src/pages/docs/reference/library/classes/UInt224.md b/src/pages/docs/reference/library/classes/UInt224.md deleted file mode 100644 index 27fe2b4..0000000 --- a/src/pages/docs/reference/library/classes/UInt224.md +++ /dev/null @@ -1,1105 +0,0 @@ ---- -title: UInt224 ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UInt224 - -# Class: UInt224 - -Defined in: [packages/library/src/math/UInt224.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L5) - -UInt is a base class for all soft-failing UInt* implementations. -It has to be overridden for every bitlength that should be available. - -For this, the developer has to create a subclass of UInt implementing the -static methods from interface UIntConstructor - -## Extends - -- [`UInt`](UInt.md)\<`224`\> - -## Constructors - -### new UInt224() - -> **new UInt224**(`value`): [`UInt224`](UInt224.md) - -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) - -#### Parameters - -##### value - -###### value - -`Field` - -#### Returns - -[`UInt224`](UInt224.md) - -#### Inherited from - -[`UInt`](UInt.md).[`constructor`](UInt.md#constructors) - -## Properties - -### value - -> **value**: `Field` = `Field` - -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) - -#### Inherited from - -[`UInt`](UInt.md).[`value`](UInt.md#value-2) - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -[`UInt`](UInt.md).[`_isStruct`](UInt.md#_isstruct) - -*** - -### assertionFunction() - -> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` - -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) - -#### Parameters - -##### bool - -`Bool` - -##### msg? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertionFunction`](UInt.md#assertionfunction) - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`empty`](UInt.md#empty) - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`fromFields`](UInt.md#fromfields) - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### value - -`string` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`fromJSON`](UInt.md#fromjson) - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -[`UInt`](UInt.md).[`fromValue`](UInt.md#fromvalue) - -*** - -### Safe - -> `static` **Safe**: `object` - -Defined in: [packages/library/src/math/UInt224.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L12) - -#### fromField() - -##### Parameters - -###### value - -`Field` - -##### Returns - -[`UInt224`](UInt224.md) - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### value - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -[`UInt`](UInt.md).[`toAuxiliary`](UInt.md#toauxiliary) - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### value - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -[`UInt`](UInt.md).[`toFields`](UInt.md#tofields) - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -[`UInt`](UInt.md).[`toInput`](UInt.md#toinput) - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `string` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`toJSON`](UInt.md#tojson) - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `bigint` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`toValue`](UInt.md#tovalue) - -*** - -### Unsafe - -> `static` **Unsafe**: `object` - -Defined in: [packages/library/src/math/UInt224.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L6) - -#### fromField() - -##### Parameters - -###### value - -`Field` - -##### Returns - -[`UInt224`](UInt224.md) - -## Accessors - -### max - -#### Get Signature - -> **get** `static` **max**(): [`UInt224`](UInt224.md) - -Defined in: [packages/library/src/math/UInt224.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L35) - -##### Returns - -[`UInt224`](UInt224.md) - -*** - -### zero - -#### Get Signature - -> **get** `static` **zero**(): [`UInt224`](UInt224.md) - -Defined in: [packages/library/src/math/UInt224.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L31) - -##### Returns - -[`UInt224`](UInt224.md) - -## Methods - -### add() - -> **add**(`y`): [`UInt`](UInt.md)\<`224`\> - -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) - -Addition with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> - -#### Returns - -[`UInt`](UInt.md)\<`224`\> - -#### Inherited from - -[`UInt`](UInt.md).[`add`](UInt.md#add) - -*** - -### assertEquals() - -> **assertEquals**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) - -Asserts that a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertEquals`](UInt.md#assertequals) - -*** - -### assertGreaterThan() - -> **assertGreaterThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) - -Asserts that a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`224`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertGreaterThan`](UInt.md#assertgreaterthan) - -*** - -### assertGreaterThanOrEqual() - -> **assertGreaterThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) - -Asserts that a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`224`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertGreaterThanOrEqual`](UInt.md#assertgreaterthanorequal) - -*** - -### assertLessThan() - -> **assertLessThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) - -Asserts that a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`224`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertLessThan`](UInt.md#assertlessthan) - -*** - -### assertLessThanOrEqual() - -> **assertLessThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) - -Asserts that a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`224`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertLessThanOrEqual`](UInt.md#assertlessthanorequal) - -*** - -### constructorReference() - -> **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`224`\> - -Defined in: [packages/library/src/math/UInt224.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L39) - -#### Returns - -[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`224`\> - -#### Overrides - -[`UInt`](UInt.md).[`constructorReference`](UInt.md#constructorreference) - -*** - -### div() - -> **div**(`y`): [`UInt`](UInt.md)\<`224`\> - -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) - -Integer division. - -`x.div(y)` returns the floor of `x / y`, that is, the greatest -`z` such that `z * y <= x`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> - -#### Returns - -[`UInt`](UInt.md)\<`224`\> - -#### Inherited from - -[`UInt`](UInt.md).[`div`](UInt.md#div) - -*** - -### divMod() - -> **divMod**(`divisor`): `object` - -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) - -Integer division with remainder. - -`x.divMod(y)` returns the quotient and the remainder. - -#### Parameters - -##### divisor - -`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`224`\> - -#### Returns - -`object` - -##### quotient - -> **quotient**: [`UInt`](UInt.md)\<`224`\> - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`224`\> - -#### Inherited from - -[`UInt`](UInt.md).[`divMod`](UInt.md#divmod) - -*** - -### equals() - -> **equals**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) - -Checks if a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`equals`](UInt.md#equals) - -*** - -### greaterThan() - -> **greaterThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) - -Checks if a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`224`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`greaterThan`](UInt.md#greaterthan) - -*** - -### greaterThanOrEqual() - -> **greaterThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) - -Checks if a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`224`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`greaterThanOrEqual`](UInt.md#greaterthanorequal) - -*** - -### lessThan() - -> **lessThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) - -Checks if a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`224`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`lessThan`](UInt.md#lessthan) - -*** - -### lessThanOrEqual() - -> **lessThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) - -Checks if a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`224`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`lessThanOrEqual`](UInt.md#lessthanorequal) - -*** - -### mod() - -> **mod**(`y`): [`UInt`](UInt.md)\<`224`\> - -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) - -Integer remainder. - -`x.mod(y)` returns the value `z` such that `0 <= z < y` and -`x - z` is divisble by `y`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> - -#### Returns - -[`UInt`](UInt.md)\<`224`\> - -#### Inherited from - -[`UInt`](UInt.md).[`mod`](UInt.md#mod) - -*** - -### mul() - -> **mul**(`y`): [`UInt`](UInt.md)\<`224`\> - -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) - -Multiplication with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> - -#### Returns - -[`UInt`](UInt.md)\<`224`\> - -#### Inherited from - -[`UInt`](UInt.md).[`mul`](UInt.md#mul) - -*** - -### numBits() - -> **numBits**(): `224` - -Defined in: [packages/library/src/math/UInt224.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L43) - -#### Returns - -`224` - -#### Overrides - -[`UInt`](UInt.md).[`numBits`](UInt.md#numbits) - -*** - -### sqrtFloor() - -> **sqrtFloor**(): [`UInt`](UInt.md)\<`224`\> - -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) - -Wraps sqrtMod() by only returning the sqrt and omitting the rest field. - -#### Returns - -[`UInt`](UInt.md)\<`224`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sqrtFloor`](UInt.md#sqrtfloor) - -*** - -### sqrtMod() - -> **sqrtMod**(): `object` - -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) - -Implements a non-overflowing square-root with rest. -Normal Field.sqrt() provides the sqrt as it is defined by the finite -field operations. This implementation however mimics the natural-numbers -style of sqrt to be used inside applications with the tradeoff that it -also returns a "rest" that indicates the amount the actual result is off -(since we floor the result to stay inside the ff). - -Some assertions are hard-failing, because they represent malicious -witness values - -#### Returns - -`object` - -sqrt: The non-overflowing sqrt - -rest: The remainder indicating how far off the result -is from the "real" sqrt - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`224`\> - -##### sqrt - -> **sqrt**: [`UInt`](UInt.md)\<`224`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sqrtMod`](UInt.md#sqrtmod) - -*** - -### sub() - -> **sub**(`y`): [`UInt`](UInt.md)\<`224`\> - -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) - -Subtraction with underflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`224`\> - -#### Returns - -[`UInt`](UInt.md)\<`224`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sub`](UInt.md#sub) - -*** - -### toBigInt() - -> **toBigInt**(): `bigint` - -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) - -Turns the [UInt](UInt.md) into a BigInt. - -#### Returns - -`bigint` - -#### Inherited from - -[`UInt`](UInt.md).[`toBigInt`](UInt.md#tobigint) - -*** - -### toO1UInt64() - -> **toO1UInt64**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. - -#### Returns - -`UInt64` - -#### Inherited from - -[`UInt`](UInt.md).[`toO1UInt64`](UInt.md#too1uint64) - -*** - -### toO1UInt64Clamped() - -> **toO1UInt64Clamped**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), -clamping to the 64 bits range if it's too large. - -#### Returns - -`UInt64` - -#### Inherited from - -[`UInt`](UInt.md).[`toO1UInt64Clamped`](UInt.md#too1uint64clamped) - -*** - -### toString() - -> **toString**(): `string` - -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) - -Turns the [UInt](UInt.md) into a string. - -#### Returns - -`string` - -#### Inherited from - -[`UInt`](UInt.md).[`toString`](UInt.md#tostring) - -*** - -### check() - -> `static` **check**(`x`): `void` - -Defined in: [packages/library/src/math/UInt224.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L20) - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### x - -###### value - -`Field` - -#### Returns - -`void` - -#### Overrides - -`UInt.check` - -*** - -### checkConstant() - -> `static` **checkConstant**(`x`, `numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) - -#### Parameters - -##### x - -`Field` - -##### numBits - -`number` - -#### Returns - -`Field` - -#### Inherited from - -[`UInt`](UInt.md).[`checkConstant`](UInt.md#checkconstant) - -*** - -### from() - -> `static` **from**(`x`): [`UInt224`](UInt224.md) - -Defined in: [packages/library/src/math/UInt224.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt224.ts#L24) - -#### Parameters - -##### x - -`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`224`\> - -#### Returns - -[`UInt224`](UInt224.md) - -*** - -### maxIntField() - -> `static` **maxIntField**(`numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) - -Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. - -#### Parameters - -##### numBits - -`number` - -#### Returns - -`Field` - -#### Inherited from - -[`UInt`](UInt.md).[`maxIntField`](UInt.md#maxintfield) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -[`UInt`](UInt.md).[`sizeInFields`](UInt.md#sizeinfields) diff --git a/src/pages/docs/reference/library/classes/UInt32.md b/src/pages/docs/reference/library/classes/UInt32.md deleted file mode 100644 index ee43ae5..0000000 --- a/src/pages/docs/reference/library/classes/UInt32.md +++ /dev/null @@ -1,1117 +0,0 @@ ---- -title: UInt32 ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UInt32 - -# Class: UInt32 - -Defined in: [packages/library/src/math/UInt32.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L6) - -UInt is a base class for all soft-failing UInt* implementations. -It has to be overridden for every bitlength that should be available. - -For this, the developer has to create a subclass of UInt implementing the -static methods from interface UIntConstructor - -## Extends - -- [`UInt`](UInt.md)\<`32`\> - -## Constructors - -### new UInt32() - -> **new UInt32**(`value`): [`UInt32`](UInt32.md) - -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) - -#### Parameters - -##### value - -###### value - -`Field` - -#### Returns - -[`UInt32`](UInt32.md) - -#### Inherited from - -[`UInt`](UInt.md).[`constructor`](UInt.md#constructors) - -## Properties - -### value - -> **value**: `Field` = `Field` - -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) - -#### Inherited from - -[`UInt`](UInt.md).[`value`](UInt.md#value-2) - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -[`UInt`](UInt.md).[`_isStruct`](UInt.md#_isstruct) - -*** - -### assertionFunction() - -> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` - -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) - -#### Parameters - -##### bool - -`Bool` - -##### msg? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertionFunction`](UInt.md#assertionfunction) - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`empty`](UInt.md#empty) - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`fromFields`](UInt.md#fromfields) - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### value - -`string` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`fromJSON`](UInt.md#fromjson) - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -[`UInt`](UInt.md).[`fromValue`](UInt.md#fromvalue) - -*** - -### Safe - -> `static` **Safe**: `object` - -Defined in: [packages/library/src/math/UInt32.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L13) - -#### fromField() - -##### Parameters - -###### value - -`Field` - -##### Returns - -[`UInt32`](UInt32.md) - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### value - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -[`UInt`](UInt.md).[`toAuxiliary`](UInt.md#toauxiliary) - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### value - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -[`UInt`](UInt.md).[`toFields`](UInt.md#tofields) - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -[`UInt`](UInt.md).[`toInput`](UInt.md#toinput) - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `string` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`toJSON`](UInt.md#tojson) - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `bigint` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`toValue`](UInt.md#tovalue) - -*** - -### Unsafe - -> `static` **Unsafe**: `object` - -Defined in: [packages/library/src/math/UInt32.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L7) - -#### fromField() - -##### Parameters - -###### value - -`Field` - -##### Returns - -[`UInt32`](UInt32.md) - -## Accessors - -### max - -#### Get Signature - -> **get** `static` **max**(): [`UInt32`](UInt32.md) - -Defined in: [packages/library/src/math/UInt32.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L36) - -##### Returns - -[`UInt32`](UInt32.md) - -*** - -### zero - -#### Get Signature - -> **get** `static` **zero**(): [`UInt32`](UInt32.md) - -Defined in: [packages/library/src/math/UInt32.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L32) - -##### Returns - -[`UInt32`](UInt32.md) - -## Methods - -### add() - -> **add**(`y`): [`UInt`](UInt.md)\<`32`\> - -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) - -Addition with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> - -#### Returns - -[`UInt`](UInt.md)\<`32`\> - -#### Inherited from - -[`UInt`](UInt.md).[`add`](UInt.md#add) - -*** - -### assertEquals() - -> **assertEquals**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) - -Asserts that a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertEquals`](UInt.md#assertequals) - -*** - -### assertGreaterThan() - -> **assertGreaterThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) - -Asserts that a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`32`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertGreaterThan`](UInt.md#assertgreaterthan) - -*** - -### assertGreaterThanOrEqual() - -> **assertGreaterThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) - -Asserts that a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`32`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertGreaterThanOrEqual`](UInt.md#assertgreaterthanorequal) - -*** - -### assertLessThan() - -> **assertLessThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) - -Asserts that a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`32`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertLessThan`](UInt.md#assertlessthan) - -*** - -### assertLessThanOrEqual() - -> **assertLessThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) - -Asserts that a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`32`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertLessThanOrEqual`](UInt.md#assertlessthanorequal) - -*** - -### constructorReference() - -> **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`32`\> - -Defined in: [packages/library/src/math/UInt32.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L40) - -#### Returns - -[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`32`\> - -#### Overrides - -[`UInt`](UInt.md).[`constructorReference`](UInt.md#constructorreference) - -*** - -### div() - -> **div**(`y`): [`UInt`](UInt.md)\<`32`\> - -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) - -Integer division. - -`x.div(y)` returns the floor of `x / y`, that is, the greatest -`z` such that `z * y <= x`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> - -#### Returns - -[`UInt`](UInt.md)\<`32`\> - -#### Inherited from - -[`UInt`](UInt.md).[`div`](UInt.md#div) - -*** - -### divMod() - -> **divMod**(`divisor`): `object` - -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) - -Integer division with remainder. - -`x.divMod(y)` returns the quotient and the remainder. - -#### Parameters - -##### divisor - -`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`32`\> - -#### Returns - -`object` - -##### quotient - -> **quotient**: [`UInt`](UInt.md)\<`32`\> - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`32`\> - -#### Inherited from - -[`UInt`](UInt.md).[`divMod`](UInt.md#divmod) - -*** - -### equals() - -> **equals**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) - -Checks if a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`equals`](UInt.md#equals) - -*** - -### greaterThan() - -> **greaterThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) - -Checks if a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`32`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`greaterThan`](UInt.md#greaterthan) - -*** - -### greaterThanOrEqual() - -> **greaterThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) - -Checks if a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`32`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`greaterThanOrEqual`](UInt.md#greaterthanorequal) - -*** - -### lessThan() - -> **lessThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) - -Checks if a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`32`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`lessThan`](UInt.md#lessthan) - -*** - -### lessThanOrEqual() - -> **lessThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) - -Checks if a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`32`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`lessThanOrEqual`](UInt.md#lessthanorequal) - -*** - -### mod() - -> **mod**(`y`): [`UInt`](UInt.md)\<`32`\> - -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) - -Integer remainder. - -`x.mod(y)` returns the value `z` such that `0 <= z < y` and -`x - z` is divisble by `y`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> - -#### Returns - -[`UInt`](UInt.md)\<`32`\> - -#### Inherited from - -[`UInt`](UInt.md).[`mod`](UInt.md#mod) - -*** - -### mul() - -> **mul**(`y`): [`UInt`](UInt.md)\<`32`\> - -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) - -Multiplication with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> - -#### Returns - -[`UInt`](UInt.md)\<`32`\> - -#### Inherited from - -[`UInt`](UInt.md).[`mul`](UInt.md#mul) - -*** - -### numBits() - -> **numBits**(): `32` - -Defined in: [packages/library/src/math/UInt32.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L44) - -#### Returns - -`32` - -#### Overrides - -[`UInt`](UInt.md).[`numBits`](UInt.md#numbits) - -*** - -### sqrtFloor() - -> **sqrtFloor**(): [`UInt`](UInt.md)\<`32`\> - -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) - -Wraps sqrtMod() by only returning the sqrt and omitting the rest field. - -#### Returns - -[`UInt`](UInt.md)\<`32`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sqrtFloor`](UInt.md#sqrtfloor) - -*** - -### sqrtMod() - -> **sqrtMod**(): `object` - -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) - -Implements a non-overflowing square-root with rest. -Normal Field.sqrt() provides the sqrt as it is defined by the finite -field operations. This implementation however mimics the natural-numbers -style of sqrt to be used inside applications with the tradeoff that it -also returns a "rest" that indicates the amount the actual result is off -(since we floor the result to stay inside the ff). - -Some assertions are hard-failing, because they represent malicious -witness values - -#### Returns - -`object` - -sqrt: The non-overflowing sqrt - -rest: The remainder indicating how far off the result -is from the "real" sqrt - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`32`\> - -##### sqrt - -> **sqrt**: [`UInt`](UInt.md)\<`32`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sqrtMod`](UInt.md#sqrtmod) - -*** - -### sub() - -> **sub**(`y`): [`UInt`](UInt.md)\<`32`\> - -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) - -Subtraction with underflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`32`\> - -#### Returns - -[`UInt`](UInt.md)\<`32`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sub`](UInt.md#sub) - -*** - -### toBigInt() - -> **toBigInt**(): `bigint` - -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) - -Turns the [UInt](UInt.md) into a BigInt. - -#### Returns - -`bigint` - -#### Inherited from - -[`UInt`](UInt.md).[`toBigInt`](UInt.md#tobigint) - -*** - -### toO1UInt64() - -> **toO1UInt64**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. - -#### Returns - -`UInt64` - -#### Inherited from - -[`UInt`](UInt.md).[`toO1UInt64`](UInt.md#too1uint64) - -*** - -### toO1UInt64Clamped() - -> **toO1UInt64Clamped**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), -clamping to the 64 bits range if it's too large. - -#### Returns - -`UInt64` - -#### Inherited from - -[`UInt`](UInt.md).[`toO1UInt64Clamped`](UInt.md#too1uint64clamped) - -*** - -### toString() - -> **toString**(): `string` - -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) - -Turns the [UInt](UInt.md) into a string. - -#### Returns - -`string` - -#### Inherited from - -[`UInt`](UInt.md).[`toString`](UInt.md#tostring) - -*** - -### toUInt64() - -> **toUInt64**(): [`UInt64`](UInt64.md) - -Defined in: [packages/library/src/math/UInt32.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L48) - -#### Returns - -[`UInt64`](UInt64.md) - -*** - -### check() - -> `static` **check**(`x`): `void` - -Defined in: [packages/library/src/math/UInt32.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L21) - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### x - -###### value - -`Field` - -#### Returns - -`void` - -#### Overrides - -`UInt.check` - -*** - -### checkConstant() - -> `static` **checkConstant**(`x`, `numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) - -#### Parameters - -##### x - -`Field` - -##### numBits - -`number` - -#### Returns - -`Field` - -#### Inherited from - -[`UInt`](UInt.md).[`checkConstant`](UInt.md#checkconstant) - -*** - -### from() - -> `static` **from**(`x`): [`UInt32`](UInt32.md) - -Defined in: [packages/library/src/math/UInt32.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt32.ts#L25) - -#### Parameters - -##### x - -`string` | `number` | `bigint` | [`UInt32`](UInt32.md) - -#### Returns - -[`UInt32`](UInt32.md) - -*** - -### maxIntField() - -> `static` **maxIntField**(`numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) - -Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. - -#### Parameters - -##### numBits - -`number` - -#### Returns - -`Field` - -#### Inherited from - -[`UInt`](UInt.md).[`maxIntField`](UInt.md#maxintfield) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -[`UInt`](UInt.md).[`sizeInFields`](UInt.md#sizeinfields) diff --git a/src/pages/docs/reference/library/classes/UInt64.md b/src/pages/docs/reference/library/classes/UInt64.md deleted file mode 100644 index cf04e88..0000000 --- a/src/pages/docs/reference/library/classes/UInt64.md +++ /dev/null @@ -1,1109 +0,0 @@ ---- -title: UInt64 ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UInt64 - -# Class: UInt64 - -Defined in: [packages/library/src/math/UInt64.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L5) - -UInt is a base class for all soft-failing UInt* implementations. -It has to be overridden for every bitlength that should be available. - -For this, the developer has to create a subclass of UInt implementing the -static methods from interface UIntConstructor - -## Extends - -- [`UInt`](UInt.md)\<`64`\> - -## Extended by - -- [`Balance`](Balance.md) - -## Constructors - -### new UInt64() - -> **new UInt64**(`value`): [`UInt64`](UInt64.md) - -Defined in: [packages/library/src/math/UInt.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L74) - -#### Parameters - -##### value - -###### value - -`Field` - -#### Returns - -[`UInt64`](UInt64.md) - -#### Inherited from - -[`UInt`](UInt.md).[`constructor`](UInt.md#constructors) - -## Properties - -### value - -> **value**: `Field` = `Field` - -Defined in: [packages/library/src/math/UInt.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L46) - -#### Inherited from - -[`UInt`](UInt.md).[`value`](UInt.md#value-2) - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -[`UInt`](UInt.md).[`_isStruct`](UInt.md#_isstruct) - -*** - -### assertionFunction() - -> `readonly` `static` **assertionFunction**: (`bool`, `msg`?) => `void` - -Defined in: [packages/library/src/math/UInt.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L48) - -#### Parameters - -##### bool - -`Bool` - -##### msg? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertionFunction`](UInt.md#assertionfunction) - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`empty`](UInt.md#empty) - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`fromFields`](UInt.md#fromfields) - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### value - -`string` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`fromJSON`](UInt.md#fromjson) - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -[`UInt`](UInt.md).[`fromValue`](UInt.md#fromvalue) - -*** - -### Safe - -> `static` **Safe**: `object` - -Defined in: [packages/library/src/math/UInt64.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L12) - -#### fromField() - -##### Parameters - -###### value - -`Field` - -##### Returns - -[`UInt64`](UInt64.md) - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### value - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -[`UInt`](UInt.md).[`toAuxiliary`](UInt.md#toauxiliary) - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### value - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -[`UInt`](UInt.md).[`toFields`](UInt.md#tofields) - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -[`UInt`](UInt.md).[`toInput`](UInt.md#toinput) - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `string` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`toJSON`](UInt.md#tojson) - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### value - -> **value**: `bigint` = `Field` - -#### Inherited from - -[`UInt`](UInt.md).[`toValue`](UInt.md#tovalue) - -*** - -### Unsafe - -> `static` **Unsafe**: `object` - -Defined in: [packages/library/src/math/UInt64.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L6) - -#### fromField() - -##### Parameters - -###### value - -`Field` - -##### Returns - -[`UInt64`](UInt64.md) - -## Accessors - -### max - -#### Get Signature - -> **get** `static` **max**(): [`UInt64`](UInt64.md) - -Defined in: [packages/library/src/math/UInt64.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L35) - -##### Returns - -[`UInt64`](UInt64.md) - -*** - -### zero - -#### Get Signature - -> **get** `static` **zero**(): [`UInt64`](UInt64.md) - -Defined in: [packages/library/src/math/UInt64.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L31) - -##### Returns - -[`UInt64`](UInt64.md) - -## Methods - -### add() - -> **add**(`y`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:301](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L301) - -Addition with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt`](UInt.md).[`add`](UInt.md#add) - -*** - -### assertEquals() - -> **assertEquals**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:413](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L413) - -Asserts that a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertEquals`](UInt.md#assertequals) - -*** - -### assertGreaterThan() - -> **assertGreaterThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:385](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L385) - -Asserts that a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertGreaterThan`](UInt.md#assertgreaterthan) - -*** - -### assertGreaterThanOrEqual() - -> **assertGreaterThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:399](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L399) - -Asserts that a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertGreaterThanOrEqual`](UInt.md#assertgreaterthanorequal) - -*** - -### assertLessThan() - -> **assertLessThan**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:371](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L371) - -Asserts that a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertLessThan`](UInt.md#assertlessthan) - -*** - -### assertLessThanOrEqual() - -> **assertLessThanOrEqual**(`y`, `message`?): `void` - -Defined in: [packages/library/src/math/UInt.ts:341](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L341) - -Asserts that a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -##### message? - -`string` - -#### Returns - -`void` - -#### Inherited from - -[`UInt`](UInt.md).[`assertLessThanOrEqual`](UInt.md#assertlessthanorequal) - -*** - -### constructorReference() - -> **constructorReference**(): [`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt64.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L39) - -#### Returns - -[`UIntConstructor`](../type-aliases/UIntConstructor.md)\<`64`\> - -#### Overrides - -[`UInt`](UInt.md).[`constructorReference`](UInt.md#constructorreference) - -*** - -### div() - -> **div**(`y`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L183) - -Integer division. - -`x.div(y)` returns the floor of `x / y`, that is, the greatest -`z` such that `z * y <= x`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt`](UInt.md).[`div`](UInt.md#div) - -*** - -### divMod() - -> **divMod**(`divisor`): `object` - -Defined in: [packages/library/src/math/UInt.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L122) - -Integer division with remainder. - -`x.divMod(y)` returns the quotient and the remainder. - -#### Parameters - -##### divisor - -`string` | `number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -`object` - -##### quotient - -> **quotient**: [`UInt`](UInt.md)\<`64`\> - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt`](UInt.md).[`divMod`](UInt.md#divmod) - -*** - -### equals() - -> **equals**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L406) - -Checks if a [UInt](UInt.md) is equal to another one. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`equals`](UInt.md#equals) - -*** - -### greaterThan() - -> **greaterThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:378](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L378) - -Checks if a [UInt](UInt.md) is greater than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`greaterThan`](UInt.md#greaterthan) - -*** - -### greaterThanOrEqual() - -> **greaterThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:392](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L392) - -Checks if a [UInt](UInt.md) is greater than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`greaterThanOrEqual`](UInt.md#greaterthanorequal) - -*** - -### lessThan() - -> **lessThan**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:364](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L364) - -Checks if a [UInt](UInt.md) is less than another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`lessThan`](UInt.md#lessthan) - -*** - -### lessThanOrEqual() - -> **lessThanOrEqual**(`y`): `Bool` - -Defined in: [packages/library/src/math/UInt.ts:325](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L325) - -Checks if a [UInt](UInt.md) is less than or equal to another one. - -#### Parameters - -##### y - -[`UInt`](UInt.md)\<`64`\> - -#### Returns - -`Bool` - -#### Inherited from - -[`UInt`](UInt.md).[`lessThanOrEqual`](UInt.md#lessthanorequal) - -*** - -### mod() - -> **mod**(`y`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:275](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L275) - -Integer remainder. - -`x.mod(y)` returns the value `z` such that `0 <= z < y` and -`x - z` is divisble by `y`. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt`](UInt.md).[`mod`](UInt.md#mod) - -*** - -### mul() - -> **mul**(`y`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:282](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L282) - -Multiplication with overflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt`](UInt.md).[`mul`](UInt.md#mul) - -*** - -### numBits() - -> **numBits**(): `64` - -Defined in: [packages/library/src/math/UInt64.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L43) - -#### Returns - -`64` - -#### Overrides - -[`UInt`](UInt.md).[`numBits`](UInt.md#numbits) - -*** - -### sqrtFloor() - -> **sqrtFloor**(): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:265](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L265) - -Wraps sqrtMod() by only returning the sqrt and omitting the rest field. - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sqrtFloor`](UInt.md#sqrtfloor) - -*** - -### sqrtMod() - -> **sqrtMod**(): `object` - -Defined in: [packages/library/src/math/UInt.ts:202](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L202) - -Implements a non-overflowing square-root with rest. -Normal Field.sqrt() provides the sqrt as it is defined by the finite -field operations. This implementation however mimics the natural-numbers -style of sqrt to be used inside applications with the tradeoff that it -also returns a "rest" that indicates the amount the actual result is off -(since we floor the result to stay inside the ff). - -Some assertions are hard-failing, because they represent malicious -witness values - -#### Returns - -`object` - -sqrt: The non-overflowing sqrt - -rest: The remainder indicating how far off the result -is from the "real" sqrt - -##### rest - -> **rest**: [`UInt`](UInt.md)\<`64`\> - -##### sqrt - -> **sqrt**: [`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sqrtMod`](UInt.md#sqrtmod) - -*** - -### sub() - -> **sub**(`y`): [`UInt`](UInt.md)\<`64`\> - -Defined in: [packages/library/src/math/UInt.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L313) - -Subtraction with underflow checking. - -#### Parameters - -##### y - -`number` | `bigint` | [`UInt`](UInt.md)\<`64`\> - -#### Returns - -[`UInt`](UInt.md)\<`64`\> - -#### Inherited from - -[`UInt`](UInt.md).[`sub`](UInt.md#sub) - -*** - -### toBigInt() - -> **toBigInt**(): `bigint` - -Defined in: [packages/library/src/math/UInt.ts:113](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L113) - -Turns the [UInt](UInt.md) into a BigInt. - -#### Returns - -`bigint` - -#### Inherited from - -[`UInt`](UInt.md).[`toBigInt`](UInt.md#tobigint) - -*** - -### toO1UInt64() - -> **toO1UInt64**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:420](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L420) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), asserting that it fits in 32 bits. - -#### Returns - -`UInt64` - -#### Inherited from - -[`UInt`](UInt.md).[`toO1UInt64`](UInt.md#too1uint64) - -*** - -### toO1UInt64Clamped() - -> **toO1UInt64Clamped**(): `UInt64` - -Defined in: [packages/library/src/math/UInt.ts:430](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L430) - -Turns the [UInt](UInt.md) into a o1js [UInt64](UInt64.md), -clamping to the 64 bits range if it's too large. - -#### Returns - -`UInt64` - -#### Inherited from - -[`UInt`](UInt.md).[`toO1UInt64Clamped`](UInt.md#too1uint64clamped) - -*** - -### toString() - -> **toString**(): `string` - -Defined in: [packages/library/src/math/UInt.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L105) - -Turns the [UInt](UInt.md) into a string. - -#### Returns - -`string` - -#### Inherited from - -[`UInt`](UInt.md).[`toString`](UInt.md#tostring) - -*** - -### check() - -> `static` **check**(`x`): `void` - -Defined in: [packages/library/src/math/UInt64.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L20) - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### x - -###### value - -`Field` - -#### Returns - -`void` - -#### Overrides - -`UInt.check` - -*** - -### checkConstant() - -> `static` **checkConstant**(`x`, `numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L54) - -#### Parameters - -##### x - -`Field` - -##### numBits - -`number` - -#### Returns - -`Field` - -#### Inherited from - -[`UInt`](UInt.md).[`checkConstant`](UInt.md#checkconstant) - -*** - -### from() - -> `static` **from**(`x`): [`UInt64`](UInt64.md) - -Defined in: [packages/library/src/math/UInt64.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt64.ts#L24) - -#### Parameters - -##### x - -`string` | `number` | `bigint` | [`UInt64`](UInt64.md) - -#### Returns - -[`UInt64`](UInt64.md) - -*** - -### maxIntField() - -> `static` **maxIntField**(`numBits`): `Field` - -Defined in: [packages/library/src/math/UInt.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L70) - -Creates a [UInt](UInt.md) with a value of 18,446,744,073,709,551,615. - -#### Parameters - -##### numBits - -`number` - -#### Returns - -`Field` - -#### Inherited from - -[`UInt`](UInt.md).[`maxIntField`](UInt.md#maxintfield) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -[`UInt`](UInt.md).[`sizeInFields`](UInt.md#sizeinfields) diff --git a/src/pages/docs/reference/library/classes/VanillaProtocolModules.md b/src/pages/docs/reference/library/classes/VanillaProtocolModules.md deleted file mode 100644 index 2c890a7..0000000 --- a/src/pages/docs/reference/library/classes/VanillaProtocolModules.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: VanillaProtocolModules ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / VanillaProtocolModules - -# Class: VanillaProtocolModules - -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L18) - -## Constructors - -### new VanillaProtocolModules() - -> **new VanillaProtocolModules**(): [`VanillaProtocolModules`](VanillaProtocolModules.md) - -#### Returns - -[`VanillaProtocolModules`](VanillaProtocolModules.md) - -## Methods - -### defaultConfig() - -> `static` **defaultConfig**(): `object` - -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L51) - -#### Returns - -`object` - -##### AccountState - -> **AccountState**: `object` = `{}` - -##### BlockHeight - -> **BlockHeight**: `object` = `{}` - -##### BlockProver - -> **BlockProver**: `object` = `{}` - -##### LastStateRoot - -> **LastStateRoot**: `object` = `{}` - -##### StateTransitionProver - -> **StateTransitionProver**: `object` = `{}` - -##### TransactionFee - -> **TransactionFee**: `object` - -###### TransactionFee.baseFee - -> **TransactionFee.baseFee**: `bigint` = `0n` - -###### TransactionFee.feeRecipient - -> **TransactionFee.feeRecipient**: `string` - -###### TransactionFee.methods - -> **TransactionFee.methods**: `object` = `{}` - -###### TransactionFee.perWeightUnitFee - -> **TransactionFee.perWeightUnitFee**: `bigint` = `0n` - -###### TransactionFee.tokenId - -> **TransactionFee.tokenId**: `bigint` = `0n` - -*** - -### mandatoryConfig() - -> `static` **mandatoryConfig**(): `object` - -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L41) - -#### Returns - -`object` - -##### AccountState - -> **AccountState**: `object` = `{}` - -##### BlockHeight - -> **BlockHeight**: `object` = `{}` - -##### BlockProver - -> **BlockProver**: `object` = `{}` - -##### LastStateRoot - -> **LastStateRoot**: `object` = `{}` - -##### StateTransitionProver - -> **StateTransitionProver**: `object` = `{}` - -*** - -### mandatoryModules() - -> `static` **mandatoryModules**\<`ProtocolModules`\>(`additionalModules`): [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `ProtocolModules` - -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L19) - -#### Type Parameters - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) - -#### Parameters - -##### additionalModules - -`ProtocolModules` - -#### Returns - -[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `ProtocolModules` - -*** - -### with() - -> `static` **with**\<`ProtocolModules`\>(`additionalModules`): [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object` & `ProtocolModules` - -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L32) - -#### Type Parameters - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) - -#### Parameters - -##### additionalModules - -`ProtocolModules` - -#### Returns - -[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object` & `ProtocolModules` diff --git a/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md b/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md deleted file mode 100644 index d82a742..0000000 --- a/src/pages/docs/reference/library/classes/VanillaRuntimeModules.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: VanillaRuntimeModules ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / VanillaRuntimeModules - -# Class: VanillaRuntimeModules - -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/VanillaRuntimeModules.ts#L10) - -## Constructors - -### new VanillaRuntimeModules() - -> **new VanillaRuntimeModules**(): [`VanillaRuntimeModules`](VanillaRuntimeModules.md) - -#### Returns - -[`VanillaRuntimeModules`](VanillaRuntimeModules.md) - -## Methods - -### defaultConfig() - -> `static` **defaultConfig**(): `object` - -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/VanillaRuntimeModules.ts#L20) - -#### Returns - -`object` - -##### Balances - -> **Balances**: `object` = `{}` - -*** - -### with() - -> `static` **with**\<`RuntimeModules`\>(`additionalModules`): `object` & `RuntimeModules` - -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/VanillaRuntimeModules.ts#L11) - -#### Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -#### Parameters - -##### additionalModules - -`RuntimeModules` - -#### Returns - -`object` & `RuntimeModules` diff --git a/src/pages/docs/reference/library/classes/WithdrawalEvent.md b/src/pages/docs/reference/library/classes/WithdrawalEvent.md deleted file mode 100644 index ffa9f02..0000000 --- a/src/pages/docs/reference/library/classes/WithdrawalEvent.md +++ /dev/null @@ -1,489 +0,0 @@ ---- -title: WithdrawalEvent ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / WithdrawalEvent - -# Class: WithdrawalEvent - -Defined in: [packages/library/src/runtime/Withdrawals.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L20) - -## Extends - -- `object` - -## Constructors - -### new WithdrawalEvent() - -> **new WithdrawalEvent**(`value`): [`WithdrawalEvent`](WithdrawalEvent.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -[`WithdrawalEvent`](WithdrawalEvent.md) - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).constructor` - -## Properties - -### key - -> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -Defined in: [packages/library/src/runtime/Withdrawals.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L21) - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).key` - -*** - -### value - -> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -Defined in: [packages/library/src/runtime/Withdrawals.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L22) - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).value` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### key - -> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -##### value - -> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### key - -> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -##### value - -> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### key - -\{ `index`: `string`; `tokenId`: `string`; \} = `WithdrawalKey` - -###### key.index - -`string` = `Field` - -###### key.tokenId - -`string` = `Field` - -###### value - -\{ `address`: `string`; `amount`: `string`; `tokenId`: `string`; \} = `Withdrawal` - -###### value.address - -`string` - -###### value.amount - -`string` - -###### value.tokenId - -`string` - -#### Returns - -`object` - -##### key - -> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -##### value - -> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`object` - -##### key - -> **key**: `object` = `WithdrawalKey` - -###### key.index - -> **key.index**: `string` = `Field` - -###### key.tokenId - -> **key.tokenId**: `string` = `Field` - -##### value - -> **value**: `object` = `Withdrawal` - -###### value.address - -> **value.address**: `string` - -###### value.amount - -> **value.amount**: `string` - -###### value.tokenId - -> **value.tokenId**: `string` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`object` - -##### key - -> **key**: `object` = `WithdrawalKey` - -###### key.index - -> **key.index**: `bigint` = `Field` - -###### key.tokenId - -> **key.tokenId**: `bigint` = `Field` - -##### value - -> **value**: `object` = `Withdrawal` - -###### value.address - -> **value.address**: `object` - -###### value.address.isOdd - -> **value.address.isOdd**: `boolean` - -###### value.address.x - -> **value.address.x**: `bigint` - -###### value.amount - -> **value.amount**: `bigint` - -###### value.tokenId - -> **value.tokenId**: `bigint` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).sizeInFields` diff --git a/src/pages/docs/reference/library/classes/WithdrawalKey.md b/src/pages/docs/reference/library/classes/WithdrawalKey.md deleted file mode 100644 index 2035287..0000000 --- a/src/pages/docs/reference/library/classes/WithdrawalKey.md +++ /dev/null @@ -1,421 +0,0 @@ ---- -title: WithdrawalKey ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / WithdrawalKey - -# Class: WithdrawalKey - -Defined in: [packages/library/src/runtime/Withdrawals.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L15) - -## Extends - -- `object` - -## Constructors - -### new WithdrawalKey() - -> **new WithdrawalKey**(`value`): [`WithdrawalKey`](WithdrawalKey.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -[`WithdrawalKey`](WithdrawalKey.md) - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).constructor` - -## Properties - -### index - -> **index**: `Field` = `Field` - -Defined in: [packages/library/src/runtime/Withdrawals.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L16) - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).index` - -*** - -### tokenId - -> **tokenId**: `Field` = `Field` - -Defined in: [packages/library/src/runtime/Withdrawals.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L17) - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).tokenId` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### index - -`string` = `Field` - -###### tokenId - -`string` = `Field` - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### index - -> **index**: `string` = `Field` - -##### tokenId - -> **tokenId**: `string` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### index - -> **index**: `bigint` = `Field` - -##### tokenId - -> **tokenId**: `bigint` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/library/classes/Withdrawals.md b/src/pages/docs/reference/library/classes/Withdrawals.md deleted file mode 100644 index c66cbdb..0000000 --- a/src/pages/docs/reference/library/classes/Withdrawals.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -title: Withdrawals ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / Withdrawals - -# Class: Withdrawals - -Defined in: [packages/library/src/runtime/Withdrawals.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L26) - -Base class for runtime modules providing the necessary utilities. - -## Extends - -- [`RuntimeModule`](../../module/classes/RuntimeModule.md) - -## Constructors - -### new Withdrawals() - -> **new Withdrawals**(`balances`): [`Withdrawals`](Withdrawals.md) - -Defined in: [packages/library/src/runtime/Withdrawals.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L38) - -#### Parameters - -##### balances - -[`Balances`](Balances.md) - -#### Returns - -[`Withdrawals`](Withdrawals.md) - -#### Overrides - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`constructor`](../../module/classes/RuntimeModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`currentConfig`](../../module/classes/RuntimeModule.md#currentconfig) - -*** - -### events - -> **events**: [`RuntimeEvents`](../../module/classes/RuntimeEvents.md)\<\{ `withdrawal`: *typeof* [`WithdrawalEvent`](WithdrawalEvent.md); \}\> - -Defined in: [packages/library/src/runtime/Withdrawals.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L27) - -#### Overrides - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`events`](../../module/classes/RuntimeModule.md#events) - -*** - -### isRuntimeModule - -> **isRuntimeModule**: `boolean` - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:27 - -This property exists only to typecheck that the RuntimeModule -was extended correctly in e.g. a decorator. We need at least -one non-optional property in this class to make the typechecking work. - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`isRuntimeModule`](../../module/classes/RuntimeModule.md#isruntimemodule) - -*** - -### name? - -> `optional` **name**: `string` - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:28 - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`name`](../../module/classes/RuntimeModule.md#name) - -*** - -### runtime? - -> `optional` **runtime**: [`RuntimeEnvironment`](../../module/interfaces/RuntimeEnvironment.md) - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:29 - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`runtime`](../../module/classes/RuntimeModule.md#runtime) - -*** - -### runtimeMethodNames - -> `readonly` **runtimeMethodNames**: `string`[] - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:21 - -Holds all method names that are callable throw transactions - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`runtimeMethodNames`](../../module/classes/RuntimeModule.md#runtimemethodnames) - -*** - -### withdrawalCounters - -> **withdrawalCounters**: [`StateMap`](../../protocol/classes/StateMap.md)\<`Field`, `Field`\> - -Defined in: [packages/library/src/runtime/Withdrawals.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L31) - -*** - -### withdrawals - -> **withdrawals**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`WithdrawalKey`](WithdrawalKey.md), [`Withdrawal`](../../protocol/classes/Withdrawal.md)\> - -Defined in: [packages/library/src/runtime/Withdrawals.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L33) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:17 - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`presets`](../../module/classes/RuntimeModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`config`](../../module/classes/RuntimeModule.md#config) - -*** - -### network - -#### Get Signature - -> **get** **network**(): [`NetworkState`](../../protocol/classes/NetworkState.md) - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:34 - -##### Returns - -[`NetworkState`](../../protocol/classes/NetworkState.md) - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`network`](../../module/classes/RuntimeModule.md#network) - -*** - -### transaction - -#### Get Signature - -> **get** **transaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:33 - -##### Returns - -[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`transaction`](../../module/classes/RuntimeModule.md#transaction) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`create`](../../module/classes/RuntimeModule.md#create) - -*** - -### getInputs() - -> **getInputs**(): [`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) - -Defined in: packages/module/dist/runtime/RuntimeModule.d.ts:32 - -#### Returns - -[`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) - -#### Inherited from - -[`RuntimeModule`](../../module/classes/RuntimeModule.md).[`getInputs`](../../module/classes/RuntimeModule.md#getinputs) - -*** - -### queueWithdrawal() - -> `protected` **queueWithdrawal**(`withdrawal`): `Promise`\<`void`\> - -Defined in: [packages/library/src/runtime/Withdrawals.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L42) - -#### Parameters - -##### withdrawal - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### withdraw() - -> **withdraw**(`address`, `amount`, `tokenId`): `Promise`\<`void`\> - -Defined in: [packages/library/src/runtime/Withdrawals.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Withdrawals.ts#L59) - -#### Parameters - -##### address - -`PublicKey` - -##### amount - -[`UInt64`](UInt64.md) - -##### tokenId - -`Field` - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/library/interfaces/BalancesEvents.md b/src/pages/docs/reference/library/interfaces/BalancesEvents.md deleted file mode 100644 index 3177a80..0000000 --- a/src/pages/docs/reference/library/interfaces/BalancesEvents.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: BalancesEvents ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / BalancesEvents - -# Interface: BalancesEvents - -Defined in: [packages/library/src/runtime/Balances.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L30) - -## Extends - -- [`EventsRecord`](../../common/type-aliases/EventsRecord.md) - -## Indexable - -\[`key`: `string`\]: `unknown`[] - -## Properties - -### setBalance - -> **setBalance**: \[[`BalancesKey`](../classes/BalancesKey.md), [`Balance`](../classes/Balance.md)\] - -Defined in: [packages/library/src/runtime/Balances.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L31) diff --git a/src/pages/docs/reference/library/interfaces/FeeIndexes.md b/src/pages/docs/reference/library/interfaces/FeeIndexes.md deleted file mode 100644 index ba1276f..0000000 --- a/src/pages/docs/reference/library/interfaces/FeeIndexes.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: FeeIndexes ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / FeeIndexes - -# Interface: FeeIndexes - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L28) - -## Indexable - -\[`methodId`: `string`\]: `bigint` diff --git a/src/pages/docs/reference/library/interfaces/FeeTreeValues.md b/src/pages/docs/reference/library/interfaces/FeeTreeValues.md deleted file mode 100644 index 6ccd649..0000000 --- a/src/pages/docs/reference/library/interfaces/FeeTreeValues.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: FeeTreeValues ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / FeeTreeValues - -# Interface: FeeTreeValues - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L24) - -## Indexable - -\[`methodId`: `string`\]: [`MethodFeeConfig`](MethodFeeConfig.md) diff --git a/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md b/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md deleted file mode 100644 index f28d685..0000000 --- a/src/pages/docs/reference/library/interfaces/MethodFeeConfig.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: MethodFeeConfig ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / MethodFeeConfig - -# Interface: MethodFeeConfig - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L17) - -## Properties - -### baseFee - -> **baseFee**: `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L19) - -*** - -### methodId - -> **methodId**: `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L18) - -*** - -### perWeightUnitFee - -> **perWeightUnitFee**: `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L20) - -*** - -### weight - -> **weight**: `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L21) diff --git a/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md b/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md deleted file mode 100644 index 43cce2c..0000000 --- a/src/pages/docs/reference/library/interfaces/RuntimeFeeAnalyzerServiceConfig.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: RuntimeFeeAnalyzerServiceConfig ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / RuntimeFeeAnalyzerServiceConfig - -# Interface: RuntimeFeeAnalyzerServiceConfig - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L46) - -## Extended by - -- [`TransactionFeeHookConfig`](TransactionFeeHookConfig.md) - -## Properties - -### baseFee - -> **baseFee**: `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) - -*** - -### feeRecipient - -> **feeRecipient**: `string` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) - -*** - -### methods - -> **methods**: `object` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) - -#### Index Signature - -\[`methodId`: `string`\]: `Partial`\<[`MethodFeeConfig`](MethodFeeConfig.md)\> - -*** - -### perWeightUnitFee - -> **perWeightUnitFee**: `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) - -*** - -### tokenId - -> **tokenId**: `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) diff --git a/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md b/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md deleted file mode 100644 index a1a62f1..0000000 --- a/src/pages/docs/reference/library/interfaces/TransactionFeeHookConfig.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: TransactionFeeHookConfig ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / TransactionFeeHookConfig - -# Interface: TransactionFeeHookConfig - -Defined in: [packages/library/src/hooks/TransactionFeeHook.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/TransactionFeeHook.ts#L33) - -## Extends - -- [`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md) - -## Properties - -### baseFee - -> **baseFee**: `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L49) - -#### Inherited from - -[`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md).[`baseFee`](RuntimeFeeAnalyzerServiceConfig.md#basefee) - -*** - -### feeRecipient - -> **feeRecipient**: `string` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L48) - -#### Inherited from - -[`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md).[`feeRecipient`](RuntimeFeeAnalyzerServiceConfig.md#feerecipient) - -*** - -### methods - -> **methods**: `object` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L51) - -#### Index Signature - -\[`methodId`: `string`\]: `Partial`\<[`MethodFeeConfig`](MethodFeeConfig.md)\> - -#### Inherited from - -[`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md).[`methods`](RuntimeFeeAnalyzerServiceConfig.md#methods) - -*** - -### perWeightUnitFee - -> **perWeightUnitFee**: `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L50) - -#### Inherited from - -[`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md).[`perWeightUnitFee`](RuntimeFeeAnalyzerServiceConfig.md#perweightunitfee) - -*** - -### tokenId - -> **tokenId**: `bigint` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L47) - -#### Inherited from - -[`RuntimeFeeAnalyzerServiceConfig`](RuntimeFeeAnalyzerServiceConfig.md).[`tokenId`](RuntimeFeeAnalyzerServiceConfig.md#tokenid) diff --git a/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md b/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md deleted file mode 100644 index b2206cd..0000000 --- a/src/pages/docs/reference/library/type-aliases/AdditionalSequencerModules.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: AdditionalSequencerModules ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / AdditionalSequencerModules - -# Type Alias: AdditionalSequencerModules - -> **AdditionalSequencerModules**: [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) & [`MinimumAdditionalSequencerModules`](MinimumAdditionalSequencerModules.md) - -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L36) diff --git a/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md deleted file mode 100644 index c6db9f6..0000000 --- a/src/pages/docs/reference/library/type-aliases/InMemorySequencerModulesRecord.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: InMemorySequencerModulesRecord ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / InMemorySequencerModulesRecord - -# Type Alias: InMemorySequencerModulesRecord - -> **InMemorySequencerModulesRecord**: `object` - -Defined in: [packages/library/src/sequencer/InMemorySequencerModules.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/InMemorySequencerModules.ts#L18) - -## Type declaration - -### BaseLayer - -> **BaseLayer**: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md) - -### BatchProducerModule - -> **BatchProducerModule**: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md) - -### BlockProducerModule - -> **BlockProducerModule**: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md) - -### BlockTrigger - -> **BlockTrigger**: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md) - -### Database - -> **Database**: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md) - -### LocalTaskWorkerModule - -> **LocalTaskWorkerModule**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<[`TaskWorkerModulesWithoutSettlement`](../../sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md)\>\> - -### Mempool - -> **Mempool**: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md) - -### TaskQueue - -> **TaskQueue**: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md) diff --git a/src/pages/docs/reference/library/type-aliases/MinimalBalances.md b/src/pages/docs/reference/library/type-aliases/MinimalBalances.md deleted file mode 100644 index 522dd42..0000000 --- a/src/pages/docs/reference/library/type-aliases/MinimalBalances.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: MinimalBalances ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / MinimalBalances - -# Type Alias: MinimalBalances - -> **MinimalBalances**: `object` - -Defined in: [packages/library/src/runtime/Balances.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L34) - -## Type declaration - -### balances - -> **balances**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`BalancesKey`](../classes/BalancesKey.md), [`Balance`](../classes/Balance.md)\> - -### transfer() - -> **transfer**: (`tokenId`, `from`, `to`, `amount`) => `void` - -#### Parameters - -##### tokenId - -[`TokenId`](../classes/TokenId.md) - -##### from - -`PublicKey` - -##### to - -`PublicKey` - -##### amount - -[`Balance`](../classes/Balance.md) - -#### Returns - -`void` diff --git a/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md b/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md deleted file mode 100644 index e19a11e..0000000 --- a/src/pages/docs/reference/library/type-aliases/MinimumAdditionalSequencerModules.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: MinimumAdditionalSequencerModules ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / MinimumAdditionalSequencerModules - -# Type Alias: MinimumAdditionalSequencerModules - -> **MinimumAdditionalSequencerModules**: `object` - -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L26) - -## Type declaration - -### BaseLayer - -> **BaseLayer**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BaseLayer`](../../sequencer/interfaces/BaseLayer.md) & [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`unknown`\>\> - -### BlockTrigger - -> **BlockTrigger**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BlockTrigger`](../../sequencer/interfaces/BlockTrigger.md) & [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`unknown`\>\> - -### Database - -> **Database**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Database`](../../sequencer/interfaces/Database.md) & [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`unknown`\>\> - -### TaskQueue - -> **TaskQueue**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`TaskQueue`](../../sequencer/interfaces/TaskQueue.md) & [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<`unknown`\>\> diff --git a/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md deleted file mode 100644 index 36c61a5..0000000 --- a/src/pages/docs/reference/library/type-aliases/SimpleSequencerModulesRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: SimpleSequencerModulesRecord ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / SimpleSequencerModulesRecord - -# Type Alias: SimpleSequencerModulesRecord - -> **SimpleSequencerModulesRecord**: [`MinimumAdditionalSequencerModules`](MinimumAdditionalSequencerModules.md) & `PreconfiguredSimpleSequencerModulesRecord` - -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L33) diff --git a/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md b/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md deleted file mode 100644 index 61966e6..0000000 --- a/src/pages/docs/reference/library/type-aliases/SimpleSequencerWorkerModulesRecord.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: SimpleSequencerWorkerModulesRecord ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / SimpleSequencerWorkerModulesRecord - -# Type Alias: SimpleSequencerWorkerModulesRecord - -> **SimpleSequencerWorkerModulesRecord**: `object` - -Defined in: [packages/library/src/sequencer/SimpleSequencerModules.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/sequencer/SimpleSequencerModules.ts#L39) - -## Type declaration - -### LocalTaskWorkerModule - -> **LocalTaskWorkerModule**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<`ReturnType`\<*typeof* [`allTasks`](../../sequencer/classes/VanillaTaskWorkerModules.md#alltasks)\>\>\> - -### TaskQueue - -> **TaskQueue**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`TaskQueue`](../../sequencer/interfaces/TaskQueue.md)\> diff --git a/src/pages/docs/reference/library/type-aliases/UIntConstructor.md b/src/pages/docs/reference/library/type-aliases/UIntConstructor.md deleted file mode 100644 index e909b53..0000000 --- a/src/pages/docs/reference/library/type-aliases/UIntConstructor.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: UIntConstructor ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / UIntConstructor - -# Type Alias: UIntConstructor\ - -> **UIntConstructor**\<`BITS`\>: `object` - -Defined in: [packages/library/src/math/UInt.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/math/UInt.ts#L24) - -## Type Parameters - -• **BITS** *extends* `number` - -## Type declaration - -### Safe - -> **Safe**: `object` - -#### Safe.fromField() - -##### Parameters - -###### x - -`Field` - -##### Returns - -[`UInt`](../classes/UInt.md)\<`BITS`\> - -### Unsafe - -> **Unsafe**: `object` - -#### Unsafe.fromField() - -##### Parameters - -###### x - -`Field` - -##### Returns - -[`UInt`](../classes/UInt.md)\<`BITS`\> - -### max - -#### Get Signature - -> **get** **max**(): [`UInt`](../classes/UInt.md)\<`BITS`\> - -##### Returns - -[`UInt`](../classes/UInt.md)\<`BITS`\> - -### zero - -#### Get Signature - -> **get** **zero**(): [`UInt`](../classes/UInt.md)\<`BITS`\> - -##### Returns - -[`UInt`](../classes/UInt.md)\<`BITS`\> - -### check() - -#### Parameters - -##### x - -###### value - -`Field` - -#### Returns - -`void` - -### from() - -#### Parameters - -##### x - -`string` | `number` | `bigint` | [`UInt`](../classes/UInt.md)\<`BITS`\> - -#### Returns - -[`UInt`](../classes/UInt.md)\<`BITS`\> diff --git a/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md b/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md deleted file mode 100644 index eb301f0..0000000 --- a/src/pages/docs/reference/library/type-aliases/VanillaProtocolModulesRecord.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: VanillaProtocolModulesRecord ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / VanillaProtocolModulesRecord - -# Type Alias: VanillaProtocolModulesRecord - -> **VanillaProtocolModulesRecord**: [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object` - -Defined in: [packages/library/src/protocol/VanillaProtocolModules.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/protocol/VanillaProtocolModules.ts#L14) - -## Type declaration - -### TransactionFee - -> **TransactionFee**: *typeof* [`TransactionFeeHook`](../classes/TransactionFeeHook.md) diff --git a/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md b/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md deleted file mode 100644 index 76ce19a..0000000 --- a/src/pages/docs/reference/library/type-aliases/VanillaRuntimeModulesRecord.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: VanillaRuntimeModulesRecord ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / VanillaRuntimeModulesRecord - -# Type Alias: VanillaRuntimeModulesRecord - -> **VanillaRuntimeModulesRecord**: `object` - -Defined in: [packages/library/src/runtime/VanillaRuntimeModules.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/VanillaRuntimeModules.ts#L6) - -## Type declaration - -### Balances - -> **Balances**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`MinimalBalances`](MinimalBalances.md) & [`RuntimeModule`](../../module/classes/RuntimeModule.md)\> diff --git a/src/pages/docs/reference/library/variables/errors.md b/src/pages/docs/reference/library/variables/errors.md deleted file mode 100644 index 82b8a73..0000000 --- a/src/pages/docs/reference/library/variables/errors.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: errors ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / errors - -# Variable: errors - -> `const` **errors**: `object` - -Defined in: [packages/library/src/runtime/Balances.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/runtime/Balances.ts#L13) - -## Type declaration - -### fromBalanceInsufficient() - -> **fromBalanceInsufficient**: () => `string` - -#### Returns - -`string` - -### senderNotFrom() - -> **senderNotFrom**: () => `string` - -#### Returns - -`string` diff --git a/src/pages/docs/reference/library/variables/treeFeeHeight.md b/src/pages/docs/reference/library/variables/treeFeeHeight.md deleted file mode 100644 index 496d19e..0000000 --- a/src/pages/docs/reference/library/variables/treeFeeHeight.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: treeFeeHeight ---- - -[**@proto-kit/library**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/library](../README.md) / treeFeeHeight - -# Variable: treeFeeHeight - -> `const` **treeFeeHeight**: `10` = `10` - -Defined in: [packages/library/src/hooks/RuntimeFeeAnalyzerService.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/library/src/hooks/RuntimeFeeAnalyzerService.ts#L43) diff --git a/src/pages/docs/reference/module/README.md b/src/pages/docs/reference/module/README.md deleted file mode 100644 index 99e640e..0000000 --- a/src/pages/docs/reference/module/README.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: "@proto-kit/module" ---- - -**@proto-kit/module** - -*** - -[Documentation](../../README.md) / @proto-kit/module - -# YAB: Module - -Set of APIs to define YAB runtime modules and application chains. - -**Application chain** consists of multiple _runtime modules_. Runtime modules can be either implemented as part of the chain directly, or imported from 3rd parties. Here's an example of how a chain with two runtime modules can be defined: - -```typescript -const chain = Chain.from({ - state: new InMemoryStateService(), - // specify which modules should the chain consist of - modules: { - Balances, - Admin, - }, -}); - -// compile the chain into a verification key -const { verificationKey } = await chain.compile(); -``` - -Chain works as a wrapper for all circuit logic contained by the runtime module methods. Compilation produces a _wrap circuit_ including all known methods of the configured runtime modules. - -Here's an example `Balances` runtime module: - -```typescript -@runtimeModule() -export class Balances extends RuntimeModule { - @state() public totalSupply = State.from(UInt64); - - @state() public balances = StateMap.from( - PublicKey, - UInt64 - ); - - public constructor(public admin: Admin) { - super(); - } - - @runtimeMethod() - public getTotalSupply() { - this.totalSupply.get(); - } - - @runtimeMethod() - public setTotalSupply() { - this.totalSupply.set(UInt64.from(20)); - this.admin.isAdmin(); - } - - @runtimeMethod() - public getBalance(address: PublicKey): Option { - return this.balances.get(address); - } -} -``` - -The Balances runtime module shows how the YAB runtime module API can be used: - -- `runtimeModule()` - marks the class as a runtime module -- `class Balance extends RuntimeModule` - introduces runtime module APIs into the runtime module -- `@state() public totalSupply = State.from(UInt64)` - defines a runtime module state of type `UInt64`, which can be either get or set -- `@state() public balances = StateMap.from(PublicKey, UInt64)` - defines a runtime module map state, which allows values to be stored under keys, respective of the given key & value types. -- `public constructor(public admin: Admin)` - injects a runtime module dependency to another runtime module `Admin`, which is a standalone runtime module -- `@runtimeMethod() public getTotalSupply()` - defines a runtime module method containing circuit logic for a runtime state transition. Methods define how the chain state is transformed from the initial state to the resulting state. -- `this.admin.isAdmin()` - shows how runtime module interoperability works, a configured runtime module is injected in the constructor, and can be used within the existing methods. Code of the called runtime module becomes part of the original method circuit (setTotalSupply in this case). - -## Method wrapper circuit - -Every runtime module method gets wrapped into an extra outter circuit, which allows the underlying runtime to make assertions about the results of the method execution, such as: - -- State transitions -- Execution status -- Transaction hash (method invocation arguments) -- Network state (TODO) - -The good thing is, the YAB runtime module API does this for you automatically, but it pays off to keep this in mind when debugging your runtime modules. Due to the nature of the underlying ZK method lifecycle, methods cannot produce any side effects beyond the state transitions, which are implicitly generated using the `State` API. Again due to method lifecycle implications, your method code will run multiple times at different stages of its lifecycle, such as: - -- Compilation -- Simulation -- Proving - -> Please be careful about keeping your runtime module methods side-effect free, since it may introduce inconsistencies in the method lifecycle which may lead to the inability to generate an execution proof. - -## Testing - -Runtime module methods can be ran or tested in two different modes: - -- Simulation -- Proving - -Simulation mode means that only the method javascript code will run, and no proving will be done. This is the fastest way of testing your module methods. - -Provnig mode means that the whole chain needs to be compiled, and then every method execution can be additionally proven by accessing the provers generated during method simulation. - -Here's an example of how a runtime module method execution proof can be generated, but please keep in mind you also need to enable proofs and compile the chain. More detailed examples can be found in `test/modules`: - -```typescript -const chain = Chain.from({ - state, - - modules: { - Balances, - Admin, - }, -}); - -const balances = chain.resolve("Balances"); -balances.getTotalSupply(); - -const { - result: { prove }, -} = container.resolve(MethodExecutionContext); -const proof = await prove(); -``` diff --git a/src/pages/docs/reference/module/_meta.tsx b/src/pages/docs/reference/module/_meta.tsx deleted file mode 100644 index 4d63940..0000000 --- a/src/pages/docs/reference/module/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/module/classes/InMemoryStateService.md b/src/pages/docs/reference/module/classes/InMemoryStateService.md deleted file mode 100644 index f2ce134..0000000 --- a/src/pages/docs/reference/module/classes/InMemoryStateService.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: InMemoryStateService ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / InMemoryStateService - -# Class: InMemoryStateService - -Defined in: [module/src/state/InMemoryStateService.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/state/InMemoryStateService.ts#L7) - -Naive implementation of an in-memory variant of the StateService interface - -## Extended by - -- [`CachedStateService`](../../sequencer/classes/CachedStateService.md) -- [`PreFilledStateService`](../../sequencer/classes/PreFilledStateService.md) - -## Implements - -- [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) - -## Constructors - -### new InMemoryStateService() - -> **new InMemoryStateService**(): [`InMemoryStateService`](InMemoryStateService.md) - -#### Returns - -[`InMemoryStateService`](InMemoryStateService.md) - -## Properties - -### values - -> **values**: `Record`\<`string`, `null` \| `Field`[]\> = `{}` - -Defined in: [module/src/state/InMemoryStateService.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/state/InMemoryStateService.ts#L12) - -This mapping container null values if the specific entry has been deleted. -This is used by the CachedState service to keep track of deletions - -## Methods - -### get() - -> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> - -Defined in: [module/src/state/InMemoryStateService.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/state/InMemoryStateService.ts#L14) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| `Field`[]\> - -#### Implementation of - -[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`get`](../../protocol/interfaces/SimpleAsyncStateService.md#get) - -*** - -### set() - -> **set**(`key`, `value`): `Promise`\<`void`\> - -Defined in: [module/src/state/InMemoryStateService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/state/InMemoryStateService.ts#L18) - -#### Parameters - -##### key - -`Field` - -##### value - -`undefined` | `Field`[] - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`set`](../../protocol/interfaces/SimpleAsyncStateService.md#set) diff --git a/src/pages/docs/reference/module/classes/MethodIdFactory.md b/src/pages/docs/reference/module/classes/MethodIdFactory.md deleted file mode 100644 index b1e9ee0..0000000 --- a/src/pages/docs/reference/module/classes/MethodIdFactory.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: MethodIdFactory ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / MethodIdFactory - -# Class: MethodIdFactory - -Defined in: [module/src/factories/MethodIdFactory.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/factories/MethodIdFactory.ts#L5) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Implements - -- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) - -## Constructors - -### new MethodIdFactory() - -> **new MethodIdFactory**(): [`MethodIdFactory`](MethodIdFactory.md) - -#### Returns - -[`MethodIdFactory`](MethodIdFactory.md) - -## Methods - -### dependencies() - -> **dependencies**(): `object` - -Defined in: [module/src/factories/MethodIdFactory.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/factories/MethodIdFactory.ts#L6) - -#### Returns - -`object` - -##### methodIdResolver - -> **methodIdResolver**: `object` - -###### methodIdResolver.useClass - -> **methodIdResolver.useClass**: *typeof* [`MethodIdResolver`](MethodIdResolver.md) = `MethodIdResolver` - -#### Implementation of - -[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) diff --git a/src/pages/docs/reference/module/classes/MethodIdResolver.md b/src/pages/docs/reference/module/classes/MethodIdResolver.md deleted file mode 100644 index 189934f..0000000 --- a/src/pages/docs/reference/module/classes/MethodIdResolver.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: MethodIdResolver ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / MethodIdResolver - -# Class: MethodIdResolver - -Defined in: [module/src/runtime/MethodIdResolver.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/MethodIdResolver.ts#L18) - -Please see `getMethodId` to learn more about -methodId encoding - -## Constructors - -### new MethodIdResolver() - -> **new MethodIdResolver**(`runtime`): [`MethodIdResolver`](MethodIdResolver.md) - -Defined in: [module/src/runtime/MethodIdResolver.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/MethodIdResolver.ts#L23) - -#### Parameters - -##### runtime - -[`Runtime`](Runtime.md)\<[`RuntimeModulesRecord`](../type-aliases/RuntimeModulesRecord.md)\> - -#### Returns - -[`MethodIdResolver`](MethodIdResolver.md) - -## Methods - -### getMethodId() - -> **getMethodId**(`moduleName`, `methodName`): `bigint` - -Defined in: [module/src/runtime/MethodIdResolver.ts:100](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/MethodIdResolver.ts#L100) - -#### Parameters - -##### moduleName - -`string` - -##### methodName - -`string` - -#### Returns - -`bigint` - -*** - -### getMethodNameFromId() - -> **getMethodNameFromId**(`methodId`): `undefined` \| \[`string`, `string`\] - -Defined in: [module/src/runtime/MethodIdResolver.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/MethodIdResolver.ts#L86) - -#### Parameters - -##### methodId - -`bigint` - -#### Returns - -`undefined` \| \[`string`, `string`\] - -*** - -### methodIdMap() - -> **methodIdMap**(): [`RuntimeMethodIdMapping`](../../protocol/type-aliases/RuntimeMethodIdMapping.md) - -Defined in: [module/src/runtime/MethodIdResolver.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/MethodIdResolver.ts#L47) - -The purpose of this method is to provide a dictionary where -we can look up properties like methodId and invocationType -for each runtimeMethod using their module name and method name - -#### Returns - -[`RuntimeMethodIdMapping`](../../protocol/type-aliases/RuntimeMethodIdMapping.md) diff --git a/src/pages/docs/reference/module/classes/MethodParameterEncoder.md b/src/pages/docs/reference/module/classes/MethodParameterEncoder.md deleted file mode 100644 index a2033ee..0000000 --- a/src/pages/docs/reference/module/classes/MethodParameterEncoder.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: MethodParameterEncoder ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / MethodParameterEncoder - -# Class: MethodParameterEncoder - -Defined in: [module/src/method/MethodParameterEncoder.ts:110](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L110) - -## Constructors - -### new MethodParameterEncoder() - -> **new MethodParameterEncoder**(`types`): [`MethodParameterEncoder`](MethodParameterEncoder.md) - -Defined in: [module/src/method/MethodParameterEncoder.ts:128](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L128) - -#### Parameters - -##### types - -`ArgTypeArray` - -#### Returns - -[`MethodParameterEncoder`](MethodParameterEncoder.md) - -## Methods - -### decode() - -> **decode**(`fields`, `auxiliary`): `Promise`\<`ArgArray`\> - -Defined in: [module/src/method/MethodParameterEncoder.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L130) - -#### Parameters - -##### fields - -`Field`[] - -##### auxiliary - -`string`[] - -#### Returns - -`Promise`\<`ArgArray`\> - -*** - -### encode() - -> **encode**(`args`): `object` - -Defined in: [module/src/method/MethodParameterEncoder.ts:192](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L192) - -Variant of encode() for provable code that skips the unprovable -json encoding - -#### Parameters - -##### args - -[`ArgumentTypes`](../../common/type-aliases/ArgumentTypes.md) - -#### Returns - -`object` - -##### auxiliary - -> **auxiliary**: `string`[] - -##### fields - -> **fields**: `Field`[] - -*** - -### fieldSize() - -> **fieldSize**(): `number` - -Defined in: [module/src/method/MethodParameterEncoder.ts:254](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L254) - -#### Returns - -`number` - -*** - -### fieldSize() - -> `static` **fieldSize**(`type`): `undefined` \| `number` - -Defined in: [module/src/method/MethodParameterEncoder.ts:117](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L117) - -#### Parameters - -##### type - -`ArgumentType` - -#### Returns - -`undefined` \| `number` - -*** - -### fromMethod() - -> `static` **fromMethod**(`target`, `methodName`): [`MethodParameterEncoder`](MethodParameterEncoder.md) - -Defined in: [module/src/method/MethodParameterEncoder.ts:111](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/MethodParameterEncoder.ts#L111) - -#### Parameters - -##### target - -[`RuntimeModule`](RuntimeModule.md)\<`unknown`\> - -##### methodName - -`string` - -#### Returns - -[`MethodParameterEncoder`](MethodParameterEncoder.md) diff --git a/src/pages/docs/reference/module/classes/Runtime.md b/src/pages/docs/reference/module/classes/Runtime.md deleted file mode 100644 index 48a1eff..0000000 --- a/src/pages/docs/reference/module/classes/Runtime.md +++ /dev/null @@ -1,782 +0,0 @@ ---- -title: Runtime ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / Runtime - -# Class: Runtime\ - -Defined in: [module/src/runtime/Runtime.ts:270](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L270) - -Wrapper for an application specific runtime, which helps orchestrate -runtime modules into an interoperable runtime. - -## Extends - -- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Modules`\> - -## Type Parameters - -• **Modules** *extends* [`RuntimeModulesRecord`](../type-aliases/RuntimeModulesRecord.md) - -## Implements - -- [`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md) -- [`CompilableModule`](../../common/interfaces/CompilableModule.md) - -## Constructors - -### new Runtime() - -> **new Runtime**\<`Modules`\>(`definition`): [`Runtime`](Runtime.md)\<`Modules`\> - -Defined in: [module/src/runtime/Runtime.ts:296](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L296) - -Creates a new Runtime from the provided config - -#### Parameters - -##### definition - -[`RuntimeDefinition`](../interfaces/RuntimeDefinition.md)\<`Modules`\> - -#### Returns - -[`Runtime`](Runtime.md)\<`Modules`\> - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) - -*** - -### definition - -> **definition**: [`RuntimeDefinition`](../interfaces/RuntimeDefinition.md)\<`Modules`\> - -Defined in: [module/src/runtime/Runtime.ts:287](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L287) - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) - -*** - -### program? - -> `optional` **program**: `any` - -Defined in: [module/src/runtime/Runtime.ts:285](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L285) - -*** - -### zkProgrammable - -> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> - -Defined in: [module/src/runtime/Runtime.ts:289](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L289) - -#### Implementation of - -[`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md).[`zkProgrammable`](../interfaces/RuntimeEnvironment.md#zkprogrammable) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [module/src/runtime/Runtime.ts:309](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L309) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Implementation of - -[`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md).[`areProofsEnabled`](../interfaces/RuntimeEnvironment.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) - -*** - -### dependencyContainer - -#### Get Signature - -> **get** **dependencyContainer**(): `DependencyContainer` - -Defined in: [module/src/runtime/Runtime.ts:330](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L330) - -##### Returns - -`DependencyContainer` - -The dependency injection container of this runtime - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) - -*** - -### methodIdResolver - -#### Get Signature - -> **get** **methodIdResolver**(): [`MethodIdResolver`](MethodIdResolver.md) - -Defined in: [module/src/runtime/Runtime.ts:323](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L323) - -##### Returns - -[`MethodIdResolver`](MethodIdResolver.md) - -#### Implementation of - -[`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md).[`methodIdResolver`](../interfaces/RuntimeEnvironment.md#methodidresolver) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) - -*** - -### runtimeModuleNames - -#### Get Signature - -> **get** **runtimeModuleNames**(): `string`[] - -Defined in: [module/src/runtime/Runtime.ts:382](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L382) - -##### Returns - -`string`[] - -A list of names of all the registered module names - -*** - -### stateService - -#### Get Signature - -> **get** **stateService**(): [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) - -Defined in: [module/src/runtime/Runtime.ts:319](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L319) - -##### Returns - -[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) - -#### Implementation of - -[`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md).[`stateService`](../interfaces/RuntimeEnvironment.md#stateservice) - -*** - -### stateServiceProvider - -#### Get Signature - -> **get** **stateServiceProvider**(): [`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) - -Defined in: [module/src/runtime/Runtime.ts:313](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L313) - -##### Returns - -[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) - -#### Implementation of - -[`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md).[`stateServiceProvider`](../interfaces/RuntimeEnvironment.md#stateserviceprovider) - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` - -Defined in: common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) - -*** - -### compile() - -> **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> - -Defined in: [module/src/runtime/Runtime.ts:386](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L386) - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> - -#### Implementation of - -[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [module/src/runtime/Runtime.ts:303](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L303) - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) - -*** - -### decorateModule() - -> **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: [module/src/runtime/Runtime.ts:369](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L369) - -Add a name and other respective properties required by RuntimeModules, -that come from the current Runtime - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -Name of the runtime module to decorate - -##### containedModule - -`InstanceType`\<`Modules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>\]\> - -#### Returns - -`void` - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) - -*** - -### getMethodById() - -> **getMethodById**(`methodId`): `undefined` \| (...`args`) => `Promise`\<`unknown`\> - -Defined in: [module/src/runtime/Runtime.ts:338](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L338) - -#### Parameters - -##### methodId - -`bigint` - -The encoded name of the method to call. -Encoding: "stringToField(module.name) << 128 + stringToField(method-name)" - -#### Returns - -`undefined` \| (...`args`) => `Promise`\<`unknown`\> - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>[] - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` - -Defined in: common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -`Modules` - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -`Modules` - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -Defined in: common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`Modules`\>(`definition`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](Runtime.md)\<`Modules`\>\> - -Defined in: [module/src/runtime/Runtime.ts:274](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L274) - -#### Type Parameters - -• **Modules** *extends* [`RuntimeModulesRecord`](../type-aliases/RuntimeModulesRecord.md) - -#### Parameters - -##### definition - -[`RuntimeDefinition`](../interfaces/RuntimeDefinition.md)\<`Modules`\> - -#### Returns - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](Runtime.md)\<`Modules`\>\> diff --git a/src/pages/docs/reference/module/classes/RuntimeEvents.md b/src/pages/docs/reference/module/classes/RuntimeEvents.md deleted file mode 100644 index 5b67010..0000000 --- a/src/pages/docs/reference/module/classes/RuntimeEvents.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: RuntimeEvents ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeEvents - -# Class: RuntimeEvents\ - -Defined in: [module/src/runtime/RuntimeModule.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L25) - -## Type Parameters - -• **Events** *extends* `EventRecord` - -## Constructors - -### new RuntimeEvents() - -> **new RuntimeEvents**\<`Events`\>(`events`): [`RuntimeEvents`](RuntimeEvents.md)\<`Events`\> - -Defined in: [module/src/runtime/RuntimeModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L26) - -#### Parameters - -##### events - -`Events` - -#### Returns - -[`RuntimeEvents`](RuntimeEvents.md)\<`Events`\> - -## Methods - -### emit() - -> **emit**\<`Key`\>(`eventName`, `event`): `void` - -Defined in: [module/src/runtime/RuntimeModule.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L47) - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### eventName - -`Key` - -##### event - -`InferProvable`\<`Events`\[`Key`\]\> - -#### Returns - -`void` - -*** - -### emitIf() - -> **emitIf**\<`Key`\>(`condition`, `eventName`, `event`): `void` - -Defined in: [module/src/runtime/RuntimeModule.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L28) - -#### Type Parameters - -• **Key** *extends* `string` \| `number` \| `symbol` - -#### Parameters - -##### condition - -`Bool` - -##### eventName - -`Key` - -##### event - -`InferProvable`\<`Events`\[`Key`\]\> - -#### Returns - -`void` diff --git a/src/pages/docs/reference/module/classes/RuntimeModule.md b/src/pages/docs/reference/module/classes/RuntimeModule.md deleted file mode 100644 index de5b8cc..0000000 --- a/src/pages/docs/reference/module/classes/RuntimeModule.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -title: RuntimeModule ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeModule - -# Class: RuntimeModule\ - -Defined in: [module/src/runtime/RuntimeModule.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L59) - -Base class for runtime modules providing the necessary utilities. - -## Extends - -- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> - -## Extended by - -- [`Balances`](../../library/classes/Balances.md) -- [`Withdrawals`](../../library/classes/Withdrawals.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -## Constructors - -### new RuntimeModule() - -> **new RuntimeModule**\<`Config`\>(): [`RuntimeModule`](RuntimeModule.md)\<`Config`\> - -Defined in: [module/src/runtime/RuntimeModule.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L82) - -#### Returns - -[`RuntimeModule`](RuntimeModule.md)\<`Config`\> - -#### Overrides - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) - -*** - -### events? - -> `optional` **events**: [`RuntimeEvents`](RuntimeEvents.md)\<`any`\> = `undefined` - -Defined in: [module/src/runtime/RuntimeModule.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L80) - -*** - -### isRuntimeModule - -> **isRuntimeModule**: `boolean` = `true` - -Defined in: [module/src/runtime/RuntimeModule.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L74) - -This property exists only to typecheck that the RuntimeModule -was extended correctly in e.g. a decorator. We need at least -one non-optional property in this class to make the typechecking work. - -*** - -### name? - -> `optional` **name**: `string` - -Defined in: [module/src/runtime/RuntimeModule.ts:76](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L76) - -*** - -### runtime? - -> `optional` **runtime**: [`RuntimeEnvironment`](../interfaces/RuntimeEnvironment.md) - -Defined in: [module/src/runtime/RuntimeModule.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L78) - -*** - -### runtimeMethodNames - -> `readonly` **runtimeMethodNames**: `string`[] = `[]` - -Defined in: [module/src/runtime/RuntimeModule.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L67) - -Holds all method names that are callable throw transactions - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [module/src/runtime/RuntimeModule.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L62) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) - -*** - -### network - -#### Get Signature - -> **get** **network**(): [`NetworkState`](../../protocol/classes/NetworkState.md) - -Defined in: [module/src/runtime/RuntimeModule.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L109) - -##### Returns - -[`NetworkState`](../../protocol/classes/NetworkState.md) - -*** - -### transaction - -#### Get Signature - -> **get** **transaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -Defined in: [module/src/runtime/RuntimeModule.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L105) - -##### Returns - -[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) - -*** - -### getInputs() - -> **getInputs**(): [`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) - -Defined in: [module/src/runtime/RuntimeModule.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeModule.ts#L92) - -#### Returns - -[`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) diff --git a/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md b/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md deleted file mode 100644 index 188e2b5..0000000 --- a/src/pages/docs/reference/module/classes/RuntimeZkProgrammable.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: RuntimeZkProgrammable ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeZkProgrammable - -# Class: RuntimeZkProgrammable\ - -Defined in: [module/src/runtime/Runtime.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L77) - -## Extends - -- [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<`undefined`, [`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> - -## Type Parameters - -• **Modules** *extends* [`RuntimeModulesRecord`](../type-aliases/RuntimeModulesRecord.md) - -## Constructors - -### new RuntimeZkProgrammable() - -> **new RuntimeZkProgrammable**\<`Modules`\>(`runtime`): [`RuntimeZkProgrammable`](RuntimeZkProgrammable.md)\<`Modules`\> - -Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L80) - -#### Parameters - -##### runtime - -[`Runtime`](Runtime.md)\<`Modules`\> - -#### Returns - -[`RuntimeZkProgrammable`](RuntimeZkProgrammable.md)\<`Modules`\> - -#### Overrides - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`constructor`](../../common/classes/ZkProgrammable.md#constructors) - -## Properties - -### runtime - -> **runtime**: [`Runtime`](Runtime.md)\<`Modules`\> - -Defined in: [module/src/runtime/Runtime.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L80) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [module/src/runtime/Runtime.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L84) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Overrides - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`areProofsEnabled`](../../common/classes/ZkProgrammable.md#areproofsenabled) - -*** - -### zkProgram - -#### Get Signature - -> **get** **zkProgram**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] - -Defined in: common/dist/zkProgrammable/ZkProgrammable.d.ts:34 - -##### Returns - -[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] - -#### Inherited from - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgram`](../../common/classes/ZkProgrammable.md#zkprogram) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> - -Defined in: common/dist/zkProgrammable/ZkProgrammable.d.ts:35 - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> - -#### Inherited from - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`compile`](../../common/classes/ZkProgrammable.md#compile) - -*** - -### zkProgramFactory() - -> **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\>[] - -Defined in: [module/src/runtime/Runtime.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L88) - -#### Returns - -[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\>[] - -#### Overrides - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgramFactory`](../../common/classes/ZkProgrammable.md#zkprogramfactory) diff --git a/src/pages/docs/reference/module/functions/combineMethodName.md b/src/pages/docs/reference/module/functions/combineMethodName.md deleted file mode 100644 index e1c6b70..0000000 --- a/src/pages/docs/reference/module/functions/combineMethodName.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: combineMethodName ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / combineMethodName - -# Function: combineMethodName() - -> **combineMethodName**(`runtimeModuleName`, `methodName`): `string` - -Defined in: [module/src/method/runtimeMethod.ts:166](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L166) - -## Parameters - -### runtimeModuleName - -`string` - -### methodName - -`string` - -## Returns - -`string` diff --git a/src/pages/docs/reference/module/functions/getAllPropertyNames.md b/src/pages/docs/reference/module/functions/getAllPropertyNames.md deleted file mode 100644 index 241d93a..0000000 --- a/src/pages/docs/reference/module/functions/getAllPropertyNames.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: getAllPropertyNames ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / getAllPropertyNames - -# Function: getAllPropertyNames() - -> **getAllPropertyNames**(`obj`): (`string` \| `symbol`)[] - -Defined in: [module/src/runtime/Runtime.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L39) - -## Parameters - -### obj - -`any` - -## Returns - -(`string` \| `symbol`)[] diff --git a/src/pages/docs/reference/module/functions/isRuntimeMethod.md b/src/pages/docs/reference/module/functions/isRuntimeMethod.md deleted file mode 100644 index 7f0f7a6..0000000 --- a/src/pages/docs/reference/module/functions/isRuntimeMethod.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: isRuntimeMethod ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / isRuntimeMethod - -# Function: isRuntimeMethod() - -> **isRuntimeMethod**(`target`, `propertyKey`): `boolean` - -Defined in: [module/src/method/runtimeMethod.ts:185](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L185) - -Checks the metadata of the provided runtime module and its method, -to see if it has been decorated with @runtimeMethod() - -## Parameters - -### target - -[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\> - -Runtime module to check - -### propertyKey - -`string` - -Name of the method to check in the prior runtime module - -## Returns - -`boolean` - -- If the provided method name is a runtime method or not diff --git a/src/pages/docs/reference/module/functions/runtimeMessage.md b/src/pages/docs/reference/module/functions/runtimeMessage.md deleted file mode 100644 index 8f41ef7..0000000 --- a/src/pages/docs/reference/module/functions/runtimeMessage.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: runtimeMessage ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeMessage - -# Function: runtimeMessage() - -> **runtimeMessage**(): (`target`, `methodName`, `descriptor`) => `void` - -Defined in: [module/src/method/runtimeMethod.ts:298](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L298) - -## Returns - -`Function` - -### Parameters - -#### target - -[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\> - -#### methodName - -`string` - -#### descriptor - -`TypedPropertyDescriptor`\<(...`args`) => `Promise`\<`any`\>\> - -### Returns - -`void` diff --git a/src/pages/docs/reference/module/functions/runtimeMethod.md b/src/pages/docs/reference/module/functions/runtimeMethod.md deleted file mode 100644 index 783550e..0000000 --- a/src/pages/docs/reference/module/functions/runtimeMethod.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: runtimeMethod ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeMethod - -# Function: runtimeMethod() - -> **runtimeMethod**(): (`target`, `methodName`, `descriptor`) => `void` - -Defined in: [module/src/method/runtimeMethod.ts:304](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L304) - -## Returns - -`Function` - -### Parameters - -#### target - -[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\> - -#### methodName - -`string` - -#### descriptor - -`TypedPropertyDescriptor`\<(...`args`) => `Promise`\<`any`\>\> - -### Returns - -`void` diff --git a/src/pages/docs/reference/module/functions/runtimeModule.md b/src/pages/docs/reference/module/functions/runtimeModule.md deleted file mode 100644 index e501704..0000000 --- a/src/pages/docs/reference/module/functions/runtimeModule.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: runtimeModule ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeModule - -# Function: runtimeModule() - -> **runtimeModule**(): (`target`) => `void` - -Defined in: [module/src/module/decorator.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/module/decorator.ts#L10) - -Marks the decorated class as a runtime module, while also -making it injectable with our dependency injection solution. - -## Returns - -`Function` - -### Parameters - -#### target - -[`StaticConfigurableModule`](../../common/interfaces/StaticConfigurableModule.md)\<`unknown`\> & [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\>\> - -Check if the target class extends RuntimeModule, while -also providing static config presets - -### Returns - -`void` diff --git a/src/pages/docs/reference/module/functions/state.md b/src/pages/docs/reference/module/functions/state.md deleted file mode 100644 index a21e2c2..0000000 --- a/src/pages/docs/reference/module/functions/state.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: state ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / state - -# Function: state() - -> **state**(): \<`TargetRuntimeModule`\>(`target`, `propertyKey`) => `void` - -Defined in: [module/src/state/decorator.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/state/decorator.ts#L23) - -Decorates a runtime module property as state, passing down some -underlying values to improve developer experience. - -## Returns - -`Function` - -### Type Parameters - -• **TargetRuntimeModule** *extends* [`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\> - -### Parameters - -#### target - -`TargetRuntimeModule` - -#### propertyKey - -`string` - -### Returns - -`void` diff --git a/src/pages/docs/reference/module/functions/toEventsHash.md b/src/pages/docs/reference/module/functions/toEventsHash.md deleted file mode 100644 index f79381a..0000000 --- a/src/pages/docs/reference/module/functions/toEventsHash.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: toEventsHash ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / toEventsHash - -# Function: toEventsHash() - -> **toEventsHash**(`events`): `Field` - -Defined in: [module/src/method/runtimeMethod.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L59) - -## Parameters - -### events - -`object`[] - -## Returns - -`Field` diff --git a/src/pages/docs/reference/module/functions/toStateTransitionsHash.md b/src/pages/docs/reference/module/functions/toStateTransitionsHash.md deleted file mode 100644 index 9015968..0000000 --- a/src/pages/docs/reference/module/functions/toStateTransitionsHash.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: toStateTransitionsHash ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / toStateTransitionsHash - -# Function: toStateTransitionsHash() - -> **toStateTransitionsHash**(`stateTransitions`): `Field` - -Defined in: [module/src/method/runtimeMethod.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L42) - -## Parameters - -### stateTransitions - -[`StateTransition`](../../protocol/classes/StateTransition.md)\<`any`\>[] - -## Returns - -`Field` diff --git a/src/pages/docs/reference/module/functions/toWrappedMethod.md b/src/pages/docs/reference/module/functions/toWrappedMethod.md deleted file mode 100644 index ecc1982..0000000 --- a/src/pages/docs/reference/module/functions/toWrappedMethod.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: toWrappedMethod ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / toWrappedMethod - -# Function: toWrappedMethod() - -> **toWrappedMethod**(`this`, `methodName`, `moduleMethod`, `options`): [`AsyncWrappedMethod`](../type-aliases/AsyncWrappedMethod.md) - -Defined in: [module/src/method/runtimeMethod.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L79) - -## Parameters - -### this - -[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\> - -### methodName - -`string` - -### moduleMethod - -(...`args`) => `Promise`\<`any`\> - -### options - -#### invocationType - -[`RuntimeMethodInvocationType`](../type-aliases/RuntimeMethodInvocationType.md) - -## Returns - -[`AsyncWrappedMethod`](../type-aliases/AsyncWrappedMethod.md) diff --git a/src/pages/docs/reference/module/globals.md b/src/pages/docs/reference/module/globals.md deleted file mode 100644 index 0dfd984..0000000 --- a/src/pages/docs/reference/module/globals.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "@proto-kit/module" ---- - -[**@proto-kit/module**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/module - -# @proto-kit/module - -## Classes - -- [InMemoryStateService](classes/InMemoryStateService.md) -- [MethodIdFactory](classes/MethodIdFactory.md) -- [MethodIdResolver](classes/MethodIdResolver.md) -- [MethodParameterEncoder](classes/MethodParameterEncoder.md) -- [Runtime](classes/Runtime.md) -- [RuntimeEvents](classes/RuntimeEvents.md) -- [RuntimeModule](classes/RuntimeModule.md) -- [RuntimeZkProgrammable](classes/RuntimeZkProgrammable.md) - -## Interfaces - -- [RuntimeDefinition](interfaces/RuntimeDefinition.md) -- [RuntimeEnvironment](interfaces/RuntimeEnvironment.md) - -## Type Aliases - -- [AsyncWrappedMethod](type-aliases/AsyncWrappedMethod.md) -- [RuntimeMethodInvocationType](type-aliases/RuntimeMethodInvocationType.md) -- [RuntimeModulesRecord](type-aliases/RuntimeModulesRecord.md) -- [WrappedMethod](type-aliases/WrappedMethod.md) - -## Variables - -- [runtimeMethodMetadataKey](variables/runtimeMethodMetadataKey.md) -- [runtimeMethodNamesMetadataKey](variables/runtimeMethodNamesMetadataKey.md) -- [runtimeMethodTypeMetadataKey](variables/runtimeMethodTypeMetadataKey.md) - -## Functions - -- [checkArgsProvable](functions/checkArgsProvable.md) -- [combineMethodName](functions/combineMethodName.md) -- [getAllPropertyNames](functions/getAllPropertyNames.md) -- [isFlexibleProvablePure](functions/isFlexibleProvablePure.md) -- [isRuntimeMethod](functions/isRuntimeMethod.md) -- [runtimeMessage](functions/runtimeMessage.md) -- [runtimeMethod](functions/runtimeMethod.md) -- [runtimeModule](functions/runtimeModule.md) -- [state](functions/state.md) -- [toEventsHash](functions/toEventsHash.md) -- [toStateTransitionsHash](functions/toStateTransitionsHash.md) -- [toWrappedMethod](functions/toWrappedMethod.md) diff --git a/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md b/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md deleted file mode 100644 index cb83c1d..0000000 --- a/src/pages/docs/reference/module/interfaces/RuntimeDefinition.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RuntimeDefinition ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeDefinition - -# Interface: RuntimeDefinition\ - -Defined in: [module/src/runtime/Runtime.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L72) - -Definition / required arguments for the Runtime class - -## Type Parameters - -• **Modules** *extends* [`RuntimeModulesRecord`](../type-aliases/RuntimeModulesRecord.md) - -## Properties - -### config? - -> `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: [module/src/runtime/Runtime.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L74) - -*** - -### modules - -> **modules**: `Modules` - -Defined in: [module/src/runtime/Runtime.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L73) diff --git a/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md b/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md deleted file mode 100644 index 05a3c98..0000000 --- a/src/pages/docs/reference/module/interfaces/RuntimeEnvironment.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: RuntimeEnvironment ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeEnvironment - -# Interface: RuntimeEnvironment - -Defined in: [module/src/runtime/RuntimeEnvironment.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeEnvironment.ts#L10) - -## Extends - -- [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<`undefined`, [`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> - -## Properties - -### zkProgrammable - -> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> - -Defined in: common/dist/zkProgrammable/ZkProgrammable.d.ts:38 - -#### Inherited from - -[`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md).[`zkProgrammable`](../../common/interfaces/WithZkProgrammable.md#zkprogrammable) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [module/src/runtime/RuntimeEnvironment.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeEnvironment.ts#L12) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -*** - -### methodIdResolver - -#### Get Signature - -> **get** **methodIdResolver**(): [`MethodIdResolver`](../classes/MethodIdResolver.md) - -Defined in: [module/src/runtime/RuntimeEnvironment.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeEnvironment.ts#L15) - -##### Returns - -[`MethodIdResolver`](../classes/MethodIdResolver.md) - -*** - -### stateService - -#### Get Signature - -> **get** **stateService**(): [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) - -Defined in: [module/src/runtime/RuntimeEnvironment.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeEnvironment.ts#L13) - -##### Returns - -[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) - -*** - -### stateServiceProvider - -#### Get Signature - -> **get** **stateServiceProvider**(): [`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) - -Defined in: [module/src/runtime/RuntimeEnvironment.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/RuntimeEnvironment.ts#L14) - -##### Returns - -[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) diff --git a/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md b/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md deleted file mode 100644 index e273bca..0000000 --- a/src/pages/docs/reference/module/type-aliases/AsyncWrappedMethod.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: AsyncWrappedMethod ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / AsyncWrappedMethod - -# Type Alias: AsyncWrappedMethod() - -> **AsyncWrappedMethod**: (...`args`) => `Promise`\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> - -Defined in: [module/src/method/runtimeMethod.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L75) - -## Parameters - -### args - -...[`ArgumentTypes`](../../common/type-aliases/ArgumentTypes.md) - -## Returns - -`Promise`\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> diff --git a/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md b/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md deleted file mode 100644 index 4905505..0000000 --- a/src/pages/docs/reference/module/type-aliases/RuntimeMethodInvocationType.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: RuntimeMethodInvocationType ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeMethodInvocationType - -# Type Alias: RuntimeMethodInvocationType - -> **RuntimeMethodInvocationType**: `"SIGNATURE"` \| `"INCOMING_MESSAGE"` - -Defined in: [module/src/method/runtimeMethod.ts:194](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L194) diff --git a/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md b/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md deleted file mode 100644 index dca01ad..0000000 --- a/src/pages/docs/reference/module/type-aliases/RuntimeModulesRecord.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: RuntimeModulesRecord ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / RuntimeModulesRecord - -# Type Alias: RuntimeModulesRecord - -> **RuntimeModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`RuntimeModule`](../classes/RuntimeModule.md)\<`unknown`\>\>\> - -Defined in: [module/src/runtime/Runtime.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/runtime/Runtime.ts#L60) - -Record of modules accepted by the Runtime module container. - -We have to use TypedClass since RuntimeModule -is an abstract class diff --git a/src/pages/docs/reference/module/type-aliases/WrappedMethod.md b/src/pages/docs/reference/module/type-aliases/WrappedMethod.md deleted file mode 100644 index 3133999..0000000 --- a/src/pages/docs/reference/module/type-aliases/WrappedMethod.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: WrappedMethod ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / WrappedMethod - -# Type Alias: WrappedMethod() - -> **WrappedMethod**: (...`args`) => [`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md) - -Defined in: [module/src/method/runtimeMethod.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L74) - -## Parameters - -### args - -...[`ArgumentTypes`](../../common/type-aliases/ArgumentTypes.md) - -## Returns - -[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md) diff --git a/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md deleted file mode 100644 index 1f14745..0000000 --- a/src/pages/docs/reference/module/variables/runtimeMethodMetadataKey.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: runtimeMethodMetadataKey ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeMethodMetadataKey - -# Variable: runtimeMethodMetadataKey - -> `const` **runtimeMethodMetadataKey**: `"yab-method"` = `"yab-method"` - -Defined in: [module/src/method/runtimeMethod.ts:173](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L173) diff --git a/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md deleted file mode 100644 index 62c978e..0000000 --- a/src/pages/docs/reference/module/variables/runtimeMethodNamesMetadataKey.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: runtimeMethodNamesMetadataKey ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeMethodNamesMetadataKey - -# Variable: runtimeMethodNamesMetadataKey - -> `const` **runtimeMethodNamesMetadataKey**: `"proto-kit-runtime-methods"` = `"proto-kit-runtime-methods"` - -Defined in: [module/src/method/runtimeMethod.ts:174](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L174) diff --git a/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md b/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md deleted file mode 100644 index c514ffc..0000000 --- a/src/pages/docs/reference/module/variables/runtimeMethodTypeMetadataKey.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: runtimeMethodTypeMetadataKey ---- - -[**@proto-kit/module**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/module](../README.md) / runtimeMethodTypeMetadataKey - -# Variable: runtimeMethodTypeMetadataKey - -> `const` **runtimeMethodTypeMetadataKey**: `"proto-kit-runtime-method-type"` = `"proto-kit-runtime-method-type"` - -Defined in: [module/src/method/runtimeMethod.ts:175](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/module/src/method/runtimeMethod.ts#L175) diff --git a/src/pages/docs/reference/persistance/README.md b/src/pages/docs/reference/persistance/README.md deleted file mode 100644 index f196fff..0000000 --- a/src/pages/docs/reference/persistance/README.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "@proto-kit/persistance" ---- - -**@proto-kit/persistance** - -*** - -[Documentation](../../README.md) / @proto-kit/persistance - -# @proto-kit/persistance - -## Classes - -- [BatchMapper](classes/BatchMapper.md) -- [BlockMapper](classes/BlockMapper.md) -- [BlockResultMapper](classes/BlockResultMapper.md) -- [FieldMapper](classes/FieldMapper.md) -- [PrismaBatchStore](classes/PrismaBatchStore.md) -- [PrismaBlockStorage](classes/PrismaBlockStorage.md) -- [PrismaDatabaseConnection](classes/PrismaDatabaseConnection.md) -- [PrismaMessageStorage](classes/PrismaMessageStorage.md) -- [PrismaRedisDatabase](classes/PrismaRedisDatabase.md) -- [PrismaSettlementStorage](classes/PrismaSettlementStorage.md) -- [PrismaStateService](classes/PrismaStateService.md) -- [PrismaTransactionStorage](classes/PrismaTransactionStorage.md) -- [RedisConnectionModule](classes/RedisConnectionModule.md) -- [RedisMerkleTreeStore](classes/RedisMerkleTreeStore.md) -- [SettlementMapper](classes/SettlementMapper.md) -- [StateTransitionArrayMapper](classes/StateTransitionArrayMapper.md) -- [StateTransitionMapper](classes/StateTransitionMapper.md) -- [TransactionExecutionResultMapper](classes/TransactionExecutionResultMapper.md) -- [TransactionMapper](classes/TransactionMapper.md) - -## Interfaces - -- [PrismaConnection](interfaces/PrismaConnection.md) -- [PrismaDatabaseConfig](interfaces/PrismaDatabaseConfig.md) -- [PrismaRedisCombinedConfig](interfaces/PrismaRedisCombinedConfig.md) -- [RedisConnection](interfaces/RedisConnection.md) -- [RedisConnectionConfig](interfaces/RedisConnectionConfig.md) - -## Type Aliases - -- [RedisTransaction](type-aliases/RedisTransaction.md) diff --git a/src/pages/docs/reference/persistance/_meta.tsx b/src/pages/docs/reference/persistance/_meta.tsx deleted file mode 100644 index 62983bf..0000000 --- a/src/pages/docs/reference/persistance/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","interfaces": "Interfaces","type-aliases": "Type Aliases" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/persistance/classes/BatchMapper.md b/src/pages/docs/reference/persistance/classes/BatchMapper.md deleted file mode 100644 index a08040b..0000000 --- a/src/pages/docs/reference/persistance/classes/BatchMapper.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: BatchMapper ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / BatchMapper - -# Class: BatchMapper - -Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L9) - -## Implements - -- `ObjectMapper`\<[`Batch`](../../sequencer/interfaces/Batch.md), \[`PrismaBatch`, `string`[]\]\> - -## Constructors - -### new BatchMapper() - -> **new BatchMapper**(): [`BatchMapper`](BatchMapper.md) - -#### Returns - -[`BatchMapper`](BatchMapper.md) - -## Methods - -### mapIn() - -> **mapIn**(`input`): [`Batch`](../../sequencer/interfaces/Batch.md) - -Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L12) - -#### Parameters - -##### input - -\[\{ `height`: `number`; `proof`: `JsonValue`; `settlementTransactionHash`: `null` \| `string`; \}, `string`[]\] - -#### Returns - -[`Batch`](../../sequencer/interfaces/Batch.md) - -#### Implementation of - -`ObjectMapper.mapIn` - -*** - -### mapOut() - -> **mapOut**(`input`): \[\{ `height`: `number`; `proof`: `JsonValue`; `settlementTransactionHash`: `null` \| `string`; \}, `string`[]\] - -Defined in: [packages/persistance/src/services/prisma/mappers/BatchMapper.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BatchMapper.ts#L20) - -#### Parameters - -##### input - -[`Batch`](../../sequencer/interfaces/Batch.md) - -#### Returns - -\[\{ `height`: `number`; `proof`: `JsonValue`; `settlementTransactionHash`: `null` \| `string`; \}, `string`[]\] - -#### Implementation of - -`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/BlockMapper.md b/src/pages/docs/reference/persistance/classes/BlockMapper.md deleted file mode 100644 index efd4113..0000000 --- a/src/pages/docs/reference/persistance/classes/BlockMapper.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -title: BlockMapper ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / BlockMapper - -# Class: BlockMapper - -Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L10) - -## Implements - -- `ObjectMapper`\<[`Block`](../../sequencer/interfaces/Block.md), `PrismaBlock`\> - -## Constructors - -### new BlockMapper() - -> **new BlockMapper**(): [`BlockMapper`](BlockMapper.md) - -#### Returns - -[`BlockMapper`](BlockMapper.md) - -## Methods - -### mapIn() - -> **mapIn**(`input`): [`Block`](../../sequencer/interfaces/Block.md) - -Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L11) - -#### Parameters - -##### input - -###### batchHeight - -`null` \| `number` - -###### beforeNetworkState - -`JsonValue` - -###### duringNetworkState - -`JsonValue` - -###### fromBlockHashRoot - -`string` - -###### fromEternalTransactionsHash - -`string` - -###### fromMessagesHash - -`string` - -###### hash - -`string` - -###### height - -`number` - -###### parentHash - -`null` \| `string` - -###### toEternalTransactionsHash - -`string` - -###### toMessagesHash - -`string` - -###### transactionsHash - -`string` - -#### Returns - -[`Block`](../../sequencer/interfaces/Block.md) - -#### Implementation of - -`ObjectMapper.mapIn` - -*** - -### mapOut() - -> **mapOut**(`input`): `object` - -Defined in: [packages/persistance/src/services/prisma/mappers/BlockMapper.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockMapper.ts#L40) - -#### Parameters - -##### input - -[`Block`](../../sequencer/interfaces/Block.md) - -#### Returns - -`object` - -##### batchHeight - -> **batchHeight**: `null` \| `number` - -##### beforeNetworkState - -> **beforeNetworkState**: `JsonValue` - -##### duringNetworkState - -> **duringNetworkState**: `JsonValue` - -##### fromBlockHashRoot - -> **fromBlockHashRoot**: `string` - -##### fromEternalTransactionsHash - -> **fromEternalTransactionsHash**: `string` - -##### fromMessagesHash - -> **fromMessagesHash**: `string` - -##### hash - -> **hash**: `string` - -##### height - -> **height**: `number` - -##### parentHash - -> **parentHash**: `null` \| `string` - -##### toEternalTransactionsHash - -> **toEternalTransactionsHash**: `string` - -##### toMessagesHash - -> **toMessagesHash**: `string` - -##### transactionsHash - -> **transactionsHash**: `string` - -#### Implementation of - -`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/BlockResultMapper.md b/src/pages/docs/reference/persistance/classes/BlockResultMapper.md deleted file mode 100644 index 9eeb038..0000000 --- a/src/pages/docs/reference/persistance/classes/BlockResultMapper.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: BlockResultMapper ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / BlockResultMapper - -# Class: BlockResultMapper - -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L11) - -## Implements - -- `ObjectMapper`\<[`BlockResult`](../../sequencer/interfaces/BlockResult.md), `DBBlockResult`\> - -## Constructors - -### new BlockResultMapper() - -> **new BlockResultMapper**(`stArrayMapper`): [`BlockResultMapper`](BlockResultMapper.md) - -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L14) - -#### Parameters - -##### stArrayMapper - -[`StateTransitionArrayMapper`](StateTransitionArrayMapper.md) - -#### Returns - -[`BlockResultMapper`](BlockResultMapper.md) - -## Methods - -### mapIn() - -> **mapIn**(`input`): [`BlockResult`](../../sequencer/interfaces/BlockResult.md) - -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L18) - -#### Parameters - -##### input - -###### afterNetworkState - -`JsonValue` - -###### blockHash - -`string` - -###### blockHashRoot - -`string` - -###### blockHashWitness - -`JsonValue` - -###### blockStateTransitions - -`JsonValue` - -###### stateRoot - -`string` - -#### Returns - -[`BlockResult`](../../sequencer/interfaces/BlockResult.md) - -#### Implementation of - -`ObjectMapper.mapIn` - -*** - -### mapOut() - -> **mapOut**(`input`): `object` - -Defined in: [packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/BlockResultMapper.ts#L38) - -#### Parameters - -##### input - -[`BlockResult`](../../sequencer/interfaces/BlockResult.md) - -#### Returns - -`object` - -##### afterNetworkState - -> **afterNetworkState**: `JsonValue` - -##### blockHash - -> **blockHash**: `string` - -##### blockHashRoot - -> **blockHashRoot**: `string` - -##### blockHashWitness - -> **blockHashWitness**: `JsonValue` - -##### blockStateTransitions - -> **blockStateTransitions**: `JsonValue` - -##### stateRoot - -> **stateRoot**: `string` - -#### Implementation of - -`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/FieldMapper.md b/src/pages/docs/reference/persistance/classes/FieldMapper.md deleted file mode 100644 index f397062..0000000 --- a/src/pages/docs/reference/persistance/classes/FieldMapper.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: FieldMapper ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / FieldMapper - -# Class: FieldMapper - -Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L7) - -## Implements - -- `ObjectMapper`\<`Field`[], `string`\> - -## Constructors - -### new FieldMapper() - -> **new FieldMapper**(): [`FieldMapper`](FieldMapper.md) - -#### Returns - -[`FieldMapper`](FieldMapper.md) - -## Methods - -### mapIn() - -> **mapIn**(`input`): `Field`[] - -Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L8) - -#### Parameters - -##### input - -`string` - -#### Returns - -`Field`[] - -#### Implementation of - -`ObjectMapper.mapIn` - -*** - -### mapOut() - -> **mapOut**(`input`): `string` - -Defined in: [packages/persistance/src/services/prisma/mappers/FieldMapper.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/FieldMapper.ts#L12) - -#### Parameters - -##### input - -`Field`[] - -#### Returns - -`string` - -#### Implementation of - -`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md b/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md deleted file mode 100644 index 13da3ce..0000000 --- a/src/pages/docs/reference/persistance/classes/PrismaBatchStore.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: PrismaBatchStore ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaBatchStore - -# Class: PrismaBatchStore - -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L14) - -## Implements - -- [`BatchStorage`](../../sequencer/interfaces/BatchStorage.md) -- [`HistoricalBatchStorage`](../../sequencer/interfaces/HistoricalBatchStorage.md) - -## Constructors - -### new PrismaBatchStore() - -> **new PrismaBatchStore**(`connection`, `batchMapper`): [`PrismaBatchStore`](PrismaBatchStore.md) - -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L15) - -#### Parameters - -##### connection - -[`PrismaConnection`](../interfaces/PrismaConnection.md) - -##### batchMapper - -[`BatchMapper`](BatchMapper.md) - -#### Returns - -[`PrismaBatchStore`](PrismaBatchStore.md) - -## Methods - -### getBatchAt() - -> **getBatchAt**(`height`): `Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L20) - -#### Parameters - -##### height - -`number` - -#### Returns - -`Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> - -#### Implementation of - -[`HistoricalBatchStorage`](../../sequencer/interfaces/HistoricalBatchStorage.md).[`getBatchAt`](../../sequencer/interfaces/HistoricalBatchStorage.md#getbatchat) - -*** - -### getCurrentBatchHeight() - -> **getCurrentBatchHeight**(): `Promise`\<`number`\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L42) - -#### Returns - -`Promise`\<`number`\> - -#### Implementation of - -[`BatchStorage`](../../sequencer/interfaces/BatchStorage.md).[`getCurrentBatchHeight`](../../sequencer/interfaces/BatchStorage.md#getcurrentbatchheight) - -*** - -### getLatestBatch() - -> **getLatestBatch**(): `Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L71) - -#### Returns - -`Promise`\<`undefined` \| [`Batch`](../../sequencer/interfaces/Batch.md)\> - -#### Implementation of - -[`BatchStorage`](../../sequencer/interfaces/BatchStorage.md).[`getLatestBatch`](../../sequencer/interfaces/BatchStorage.md#getlatestbatch) - -*** - -### pushBatch() - -> **pushBatch**(`batch`): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBatchStore.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBatchStore.ts#L51) - -#### Parameters - -##### batch - -[`Batch`](../../sequencer/interfaces/Batch.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`BatchStorage`](../../sequencer/interfaces/BatchStorage.md).[`pushBatch`](../../sequencer/interfaces/BatchStorage.md#pushbatch) diff --git a/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md b/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md deleted file mode 100644 index 4deef1c..0000000 --- a/src/pages/docs/reference/persistance/classes/PrismaBlockStorage.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -title: PrismaBlockStorage ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaBlockStorage - -# Class: PrismaBlockStorage - -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L30) - -## Implements - -- [`BlockQueue`](../../sequencer/interfaces/BlockQueue.md) -- [`BlockStorage`](../../sequencer/interfaces/BlockStorage.md) -- [`HistoricalBlockStorage`](../../sequencer/interfaces/HistoricalBlockStorage.md) - -## Constructors - -### new PrismaBlockStorage() - -> **new PrismaBlockStorage**(`connection`, `transactionResultMapper`, `transactionMapper`, `blockResultMapper`, `blockMapper`): [`PrismaBlockStorage`](PrismaBlockStorage.md) - -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L33) - -#### Parameters - -##### connection - -[`PrismaConnection`](../interfaces/PrismaConnection.md) - -##### transactionResultMapper - -[`TransactionExecutionResultMapper`](TransactionExecutionResultMapper.md) - -##### transactionMapper - -[`TransactionMapper`](TransactionMapper.md) - -##### blockResultMapper - -[`BlockResultMapper`](BlockResultMapper.md) - -##### blockMapper - -[`BlockMapper`](BlockMapper.md) - -#### Returns - -[`PrismaBlockStorage`](PrismaBlockStorage.md) - -## Methods - -### getBlock() - -> **getBlock**(`hash`): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L77) - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> - -#### Implementation of - -[`HistoricalBlockStorage`](../../sequencer/interfaces/HistoricalBlockStorage.md).[`getBlock`](../../sequencer/interfaces/HistoricalBlockStorage.md#getblock) - -*** - -### getBlockAt() - -> **getBlockAt**(`height`): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L73) - -#### Parameters - -##### height - -`number` - -#### Returns - -`Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> - -#### Implementation of - -[`HistoricalBlockStorage`](../../sequencer/interfaces/HistoricalBlockStorage.md).[`getBlockAt`](../../sequencer/interfaces/HistoricalBlockStorage.md#getblockat) - -*** - -### getCurrentBlockHeight() - -> **getCurrentBlockHeight**(): `Promise`\<`number`\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:157](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L157) - -#### Returns - -`Promise`\<`number`\> - -#### Implementation of - -[`BlockStorage`](../../sequencer/interfaces/BlockStorage.md).[`getCurrentBlockHeight`](../../sequencer/interfaces/BlockStorage.md#getcurrentblockheight) - -*** - -### getLatestBlock() - -> **getLatestBlock**(): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:185](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L185) - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> - -#### Implementation of - -[`BlockStorage`](../../sequencer/interfaces/BlockStorage.md).[`getLatestBlock`](../../sequencer/interfaces/BlockStorage.md#getlatestblock) - -*** - -### getLatestBlockAndResult() - -> **getLatestBlockAndResult**(): `Promise`\<`undefined` \| [`BlockWithMaybeResult`](../../sequencer/interfaces/BlockWithMaybeResult.md)\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:167](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L167) - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithMaybeResult`](../../sequencer/interfaces/BlockWithMaybeResult.md)\> - -#### Implementation of - -[`BlockQueue`](../../sequencer/interfaces/BlockQueue.md).[`getLatestBlockAndResult`](../../sequencer/interfaces/BlockQueue.md#getlatestblockandresult) - -*** - -### getNewBlocks() - -> **getNewBlocks**(): `Promise`\<[`BlockWithPreviousResult`](../../sequencer/interfaces/BlockWithPreviousResult.md)[]\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:201](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L201) - -#### Returns - -`Promise`\<[`BlockWithPreviousResult`](../../sequencer/interfaces/BlockWithPreviousResult.md)[]\> - -#### Implementation of - -[`BlockQueue`](../../sequencer/interfaces/BlockQueue.md).[`getNewBlocks`](../../sequencer/interfaces/BlockQueue.md#getnewblocks) - -*** - -### pushBlock() - -> **pushBlock**(`block`): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L81) - -#### Parameters - -##### block - -[`Block`](../../sequencer/interfaces/Block.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`BlockStorage`](../../sequencer/interfaces/BlockStorage.md).[`pushBlock`](../../sequencer/interfaces/BlockStorage.md#pushblock) - -*** - -### pushResult() - -> **pushResult**(`result`): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/services/prisma/PrismaBlockStorage.ts:139](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaBlockStorage.ts#L139) - -#### Parameters - -##### result - -[`BlockResult`](../../sequencer/interfaces/BlockResult.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`BlockQueue`](../../sequencer/interfaces/BlockQueue.md).[`pushResult`](../../sequencer/interfaces/BlockQueue.md#pushresult) diff --git a/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md b/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md deleted file mode 100644 index cb4e79a..0000000 --- a/src/pages/docs/reference/persistance/classes/PrismaDatabaseConnection.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -title: PrismaDatabaseConnection ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaDatabaseConnection - -# Class: PrismaDatabaseConnection - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L37) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Extends - -- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<[`PrismaDatabaseConfig`](../interfaces/PrismaDatabaseConfig.md)\> - -## Implements - -- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) -- [`PrismaConnection`](../interfaces/PrismaConnection.md) - -## Constructors - -### new PrismaDatabaseConnection() - -> **new PrismaDatabaseConnection**(): [`PrismaDatabaseConnection`](PrismaDatabaseConnection.md) - -#### Returns - -[`PrismaDatabaseConnection`](PrismaDatabaseConnection.md) - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`constructor`](../../sequencer/classes/SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`PrismaDatabaseConfig`](../interfaces/PrismaDatabaseConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> - -Defined in: packages/sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`presets`](../../sequencer/classes/SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) - -*** - -### prismaClient - -#### Get Signature - -> **get** **prismaClient**(): `PrismaClient`\<`never`\> - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L43) - -##### Returns - -`PrismaClient`\<`never`\> - -#### Implementation of - -[`PrismaConnection`](../interfaces/PrismaConnection.md).[`prismaClient`](../interfaces/PrismaConnection.md#prismaclient) - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:137](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L137) - -#### Returns - -`Promise`\<`void`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) - -*** - -### dependencies() - -> **dependencies**(): [`OmitKeys`](../../common/type-aliases/OmitKeys.md)\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L50) - -#### Returns - -[`OmitKeys`](../../common/type-aliases/OmitKeys.md)\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> - -#### Implementation of - -[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) - -*** - -### executeInTransaction() - -> **executeInTransaction**(`f`): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:141](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L141) - -#### Parameters - -##### f - -() => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -*** - -### pruneDatabase() - -> **pruneDatabase**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L82) - -#### Returns - -`Promise`\<`void`\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:117](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L117) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) diff --git a/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md b/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md deleted file mode 100644 index d58e2d5..0000000 --- a/src/pages/docs/reference/persistance/classes/PrismaMessageStorage.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: PrismaMessageStorage ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaMessageStorage - -# Class: PrismaMessageStorage - -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L9) - -Interface to store Messages previously fetched by a IncomingMessageadapter - -## Implements - -- [`MessageStorage`](../../sequencer/interfaces/MessageStorage.md) - -## Constructors - -### new PrismaMessageStorage() - -> **new PrismaMessageStorage**(`connection`, `transactionMapper`): [`PrismaMessageStorage`](PrismaMessageStorage.md) - -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L10) - -#### Parameters - -##### connection - -[`PrismaConnection`](../interfaces/PrismaConnection.md) - -##### transactionMapper - -[`TransactionMapper`](TransactionMapper.md) - -#### Returns - -[`PrismaMessageStorage`](PrismaMessageStorage.md) - -## Methods - -### getMessages() - -> **getMessages**(`fromMessageHash`): `Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> - -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L15) - -#### Parameters - -##### fromMessageHash - -`string` - -#### Returns - -`Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> - -#### Implementation of - -[`MessageStorage`](../../sequencer/interfaces/MessageStorage.md).[`getMessages`](../../sequencer/interfaces/MessageStorage.md#getmessages) - -*** - -### pushMessages() - -> **pushMessages**(`fromMessageHash`, `toMessageHash`, `messages`): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/services/prisma/PrismaMessageStorage.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaMessageStorage.ts#L44) - -#### Parameters - -##### fromMessageHash - -`string` - -##### toMessageHash - -`string` - -##### messages - -[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[] - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`MessageStorage`](../../sequencer/interfaces/MessageStorage.md).[`pushMessages`](../../sequencer/interfaces/MessageStorage.md#pushmessages) diff --git a/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md b/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md deleted file mode 100644 index 8bb7bb5..0000000 --- a/src/pages/docs/reference/persistance/classes/PrismaRedisDatabase.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -title: PrismaRedisDatabase ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaRedisDatabase - -# Class: PrismaRedisDatabase - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L31) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Extends - -- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<[`PrismaRedisCombinedConfig`](../interfaces/PrismaRedisCombinedConfig.md)\> - -## Implements - -- [`PrismaConnection`](../interfaces/PrismaConnection.md) -- [`RedisConnection`](../interfaces/RedisConnection.md) -- [`Database`](../../sequencer/interfaces/Database.md) - -## Constructors - -### new PrismaRedisDatabase() - -> **new PrismaRedisDatabase**(): [`PrismaRedisDatabase`](PrismaRedisDatabase.md) - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L39) - -#### Returns - -[`PrismaRedisDatabase`](PrismaRedisDatabase.md) - -#### Overrides - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`constructor`](../../sequencer/classes/SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`PrismaRedisCombinedConfig`](../interfaces/PrismaRedisCombinedConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) - -*** - -### prisma - -> **prisma**: [`PrismaDatabaseConnection`](PrismaDatabaseConnection.md) - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L35) - -*** - -### redis - -> **redis**: [`RedisConnectionModule`](RedisConnectionModule.md) - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L37) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> - -Defined in: packages/sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`presets`](../../sequencer/classes/SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) - -*** - -### currentMulti - -#### Get Signature - -> **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L53) - -##### Returns - -`RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> - -#### Implementation of - -[`RedisConnection`](../interfaces/RedisConnection.md).[`currentMulti`](../interfaces/RedisConnection.md#currentmulti) - -*** - -### prismaClient - -#### Get Signature - -> **get** **prismaClient**(): `PrismaClient`\<`never`\> - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L45) - -##### Returns - -`PrismaClient`\<`never`\> - -#### Implementation of - -[`PrismaConnection`](../interfaces/PrismaConnection.md).[`prismaClient`](../interfaces/PrismaConnection.md#prismaclient) - -*** - -### redisClient - -#### Get Signature - -> **get** **redisClient**(): `RedisClientType` - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L49) - -##### Returns - -`RedisClientType` - -#### Implementation of - -[`RedisConnection`](../interfaces/RedisConnection.md).[`redisClient`](../interfaces/RedisConnection.md#redisclient) - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L78) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Database`](../../sequencer/interfaces/Database.md).[`close`](../../sequencer/interfaces/Database.md#close) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L57) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Overrides - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) - -*** - -### dependencies() - -> **dependencies**(): [`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md) - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L63) - -#### Returns - -[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md) - -#### Implementation of - -[`Database`](../../sequencer/interfaces/Database.md).[`dependencies`](../../sequencer/interfaces/Database.md#dependencies) - -*** - -### executeInTransaction() - -> **executeInTransaction**(`f`): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L88) - -#### Parameters - -##### f - -() => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Database`](../../sequencer/interfaces/Database.md).[`executeInTransaction`](../../sequencer/interfaces/Database.md#executeintransaction) - -*** - -### pruneDatabase() - -> **pruneDatabase**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L83) - -Prunes all data from the database connection. -Note: This function should only be called immediately at startup, -everything else will lead to unexpected behaviour and errors - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Database`](../../sequencer/interfaces/Database.md).[`pruneDatabase`](../../sequencer/interfaces/Database.md#prunedatabase) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L70) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) diff --git a/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md b/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md deleted file mode 100644 index 2326ab0..0000000 --- a/src/pages/docs/reference/persistance/classes/PrismaSettlementStorage.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: PrismaSettlementStorage ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaSettlementStorage - -# Class: PrismaSettlementStorage - -Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L9) - -## Implements - -- [`SettlementStorage`](../../sequencer/interfaces/SettlementStorage.md) - -## Constructors - -### new PrismaSettlementStorage() - -> **new PrismaSettlementStorage**(`connection`, `settlementMapper`): [`PrismaSettlementStorage`](PrismaSettlementStorage.md) - -Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L10) - -#### Parameters - -##### connection - -[`PrismaConnection`](../interfaces/PrismaConnection.md) - -##### settlementMapper - -[`SettlementMapper`](SettlementMapper.md) - -#### Returns - -[`PrismaSettlementStorage`](PrismaSettlementStorage.md) - -## Methods - -### pushSettlement() - -> **pushSettlement**(`settlement`): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/services/prisma/PrismaSettlementStorage.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaSettlementStorage.ts#L15) - -#### Parameters - -##### settlement - -[`Settlement`](../../sequencer/interfaces/Settlement.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`SettlementStorage`](../../sequencer/interfaces/SettlementStorage.md).[`pushSettlement`](../../sequencer/interfaces/SettlementStorage.md#pushsettlement) diff --git a/src/pages/docs/reference/persistance/classes/PrismaStateService.md b/src/pages/docs/reference/persistance/classes/PrismaStateService.md deleted file mode 100644 index 342cff8..0000000 --- a/src/pages/docs/reference/persistance/classes/PrismaStateService.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: PrismaStateService ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaStateService - -# Class: PrismaStateService - -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L16) - -This Interface should be implemented for services that store the state -in an external storage (like a DB). This can be used in conjunction with -CachedStateService to preload keys for In-Circuit usage. - -## Implements - -- [`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md) - -## Constructors - -### new PrismaStateService() - -> **new PrismaStateService**(`connection`, `mask`): [`PrismaStateService`](PrismaStateService.md) - -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L23) - -#### Parameters - -##### connection - -[`PrismaConnection`](../interfaces/PrismaConnection.md) - -##### mask - -`string` - -A indicator to which masking level the values belong - -#### Returns - -[`PrismaStateService`](PrismaStateService.md) - -## Methods - -### commit() - -> **commit**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L28) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md).[`commit`](../../sequencer/interfaces/AsyncStateService.md#commit) - -*** - -### get() - -> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> - -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L79) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| `Field`[]\> - -#### Implementation of - -[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md).[`get`](../../sequencer/interfaces/AsyncStateService.md#get) - -*** - -### getMany() - -> **getMany**(`keys`): `Promise`\<[`StateEntry`](../../sequencer/interfaces/StateEntry.md)[]\> - -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L54) - -#### Parameters - -##### keys - -`Field`[] - -#### Returns - -`Promise`\<[`StateEntry`](../../sequencer/interfaces/StateEntry.md)[]\> - -#### Implementation of - -[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md).[`getMany`](../../sequencer/interfaces/AsyncStateService.md#getmany) - -*** - -### openTransaction() - -> **openTransaction**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L75) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md).[`openTransaction`](../../sequencer/interfaces/AsyncStateService.md#opentransaction) - -*** - -### writeStates() - -> **writeStates**(`entries`): `void` - -Defined in: [packages/persistance/src/services/prisma/PrismaStateService.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaStateService.ts#L84) - -#### Parameters - -##### entries - -[`StateEntry`](../../sequencer/interfaces/StateEntry.md)[] - -#### Returns - -`void` - -#### Implementation of - -[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md).[`writeStates`](../../sequencer/interfaces/AsyncStateService.md#writestates) diff --git a/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md b/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md deleted file mode 100644 index e9d50ce..0000000 --- a/src/pages/docs/reference/persistance/classes/PrismaTransactionStorage.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: PrismaTransactionStorage ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaTransactionStorage - -# Class: PrismaTransactionStorage - -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L9) - -## Implements - -- [`TransactionStorage`](../../sequencer/interfaces/TransactionStorage.md) - -## Constructors - -### new PrismaTransactionStorage() - -> **new PrismaTransactionStorage**(`connection`, `transactionMapper`): [`PrismaTransactionStorage`](PrismaTransactionStorage.md) - -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L10) - -#### Parameters - -##### connection - -[`PrismaConnection`](../interfaces/PrismaConnection.md) - -##### transactionMapper - -[`TransactionMapper`](TransactionMapper.md) - -#### Returns - -[`PrismaTransactionStorage`](PrismaTransactionStorage.md) - -## Methods - -### findTransaction() - -> **findTransaction**(`hash`): `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md); \}\> - -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L42) - -Finds a transaction by its hash. -It returns both pending transaction and already included transactions -In case the transaction has been included, it also returns the block hash -and batch number where applicable. - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md); \}\> - -#### Implementation of - -[`TransactionStorage`](../../sequencer/interfaces/TransactionStorage.md).[`findTransaction`](../../sequencer/interfaces/TransactionStorage.md#findtransaction) - -*** - -### getPendingUserTransactions() - -> **getPendingUserTransactions**(): `Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> - -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L15) - -#### Returns - -`Promise`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md)[]\> - -#### Implementation of - -[`TransactionStorage`](../../sequencer/interfaces/TransactionStorage.md).[`getPendingUserTransactions`](../../sequencer/interfaces/TransactionStorage.md#getpendingusertransactions) - -*** - -### pushUserTransaction() - -> **pushUserTransaction**(`tx`): `Promise`\<`boolean`\> - -Defined in: [packages/persistance/src/services/prisma/PrismaTransactionStorage.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/PrismaTransactionStorage.ts#L31) - -#### Parameters - -##### tx - -[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) - -#### Returns - -`Promise`\<`boolean`\> - -#### Implementation of - -[`TransactionStorage`](../../sequencer/interfaces/TransactionStorage.md).[`pushUserTransaction`](../../sequencer/interfaces/TransactionStorage.md#pushusertransaction) diff --git a/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md b/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md deleted file mode 100644 index 3b708e7..0000000 --- a/src/pages/docs/reference/persistance/classes/RedisConnectionModule.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -title: RedisConnectionModule ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / RedisConnectionModule - -# Class: RedisConnectionModule - -Defined in: [packages/persistance/src/RedisConnection.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L24) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Extends - -- [`SequencerModule`](../../sequencer/classes/SequencerModule.md)\<[`RedisConnectionConfig`](../interfaces/RedisConnectionConfig.md)\> - -## Implements - -- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) -- [`RedisConnection`](../interfaces/RedisConnection.md) - -## Constructors - -### new RedisConnectionModule() - -> **new RedisConnectionModule**(): [`RedisConnectionModule`](RedisConnectionModule.md) - -#### Returns - -[`RedisConnectionModule`](RedisConnectionModule.md) - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`constructor`](../../sequencer/classes/SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`RedisConnectionConfig`](../interfaces/RedisConnectionConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`currentConfig`](../../sequencer/classes/SequencerModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> - -Defined in: packages/sequencer/dist/sequencer/builder/SequencerModule.d.ts:8 - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`presets`](../../sequencer/classes/SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`config`](../../sequencer/classes/SequencerModule.md#config) - -*** - -### currentMulti - -#### Get Signature - -> **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> - -Defined in: [packages/persistance/src/RedisConnection.ts:91](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L91) - -##### Returns - -`RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> - -#### Implementation of - -[`RedisConnection`](../interfaces/RedisConnection.md).[`currentMulti`](../interfaces/RedisConnection.md#currentmulti) - -*** - -### redisClient - -#### Get Signature - -> **get** **redisClient**(): `RedisClientType` - -Defined in: [packages/persistance/src/RedisConnection.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L30) - -##### Returns - -`RedisClientType` - -#### Implementation of - -[`RedisConnection`](../interfaces/RedisConnection.md).[`redisClient`](../interfaces/RedisConnection.md#redisclient) - -## Methods - -### clearDatabase() - -> **clearDatabase**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/RedisConnection.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L56) - -#### Returns - -`Promise`\<`void`\> - -*** - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/RedisConnection.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L81) - -#### Returns - -`Promise`\<`void`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`create`](../../sequencer/classes/SequencerModule.md#create) - -*** - -### dependencies() - -> **dependencies**(): `Pick`\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> - -Defined in: [packages/persistance/src/RedisConnection.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L39) - -#### Returns - -`Pick`\<[`StorageDependencyMinimumDependencies`](../../sequencer/interfaces/StorageDependencyMinimumDependencies.md), `"asyncMerkleStore"` \| `"blockTreeStore"` \| `"unprovenMerkleStore"`\> - -#### Implementation of - -[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) - -*** - -### executeInTransaction() - -> **executeInTransaction**(`f`): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/RedisConnection.ts:98](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L98) - -#### Parameters - -##### f - -() => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -*** - -### init() - -> **init**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/RedisConnection.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L60) - -#### Returns - -`Promise`\<`void`\> - -*** - -### pruneDatabase() - -> **pruneDatabase**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/RedisConnection.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L85) - -#### Returns - -`Promise`\<`void`\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/RedisConnection.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L77) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](../../sequencer/classes/SequencerModule.md).[`start`](../../sequencer/classes/SequencerModule.md#start) diff --git a/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md b/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md deleted file mode 100644 index eefe398..0000000 --- a/src/pages/docs/reference/persistance/classes/RedisMerkleTreeStore.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -title: RedisMerkleTreeStore ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / RedisMerkleTreeStore - -# Class: RedisMerkleTreeStore - -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L10) - -## Implements - -- [`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md) - -## Constructors - -### new RedisMerkleTreeStore() - -> **new RedisMerkleTreeStore**(`connection`, `mask`): [`RedisMerkleTreeStore`](RedisMerkleTreeStore.md) - -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L13) - -#### Parameters - -##### connection - -[`RedisConnection`](../interfaces/RedisConnection.md) - -##### mask - -`string` = `"base"` - -#### Returns - -[`RedisMerkleTreeStore`](RedisMerkleTreeStore.md) - -## Methods - -### commit() - -> **commit**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L26) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md).[`commit`](../../sequencer/interfaces/AsyncMerkleTreeStore.md#commit) - -*** - -### getNodesAsync() - -> **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> - -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L48) - -#### Parameters - -##### nodes - -[`MerkleTreeNodeQuery`](../../sequencer/interfaces/MerkleTreeNodeQuery.md)[] - -#### Returns - -`Promise`\<(`undefined` \| `bigint`)[]\> - -#### Implementation of - -[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md).[`getNodesAsync`](../../sequencer/interfaces/AsyncMerkleTreeStore.md#getnodesasync) - -*** - -### openTransaction() - -> **openTransaction**(): `Promise`\<`void`\> - -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L22) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md).[`openTransaction`](../../sequencer/interfaces/AsyncMerkleTreeStore.md#opentransaction) - -*** - -### writeNodes() - -> **writeNodes**(`nodes`): `void` - -Defined in: [packages/persistance/src/services/redis/RedisMerkleTreeStore.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/redis/RedisMerkleTreeStore.ts#L62) - -#### Parameters - -##### nodes - -[`MerkleTreeNode`](../../sequencer/interfaces/MerkleTreeNode.md)[] - -#### Returns - -`void` - -#### Implementation of - -[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md).[`writeNodes`](../../sequencer/interfaces/AsyncMerkleTreeStore.md#writenodes) diff --git a/src/pages/docs/reference/persistance/classes/SettlementMapper.md b/src/pages/docs/reference/persistance/classes/SettlementMapper.md deleted file mode 100644 index b3faeeb..0000000 --- a/src/pages/docs/reference/persistance/classes/SettlementMapper.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: SettlementMapper ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / SettlementMapper - -# Class: SettlementMapper - -Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L8) - -## Implements - -- `ObjectMapper`\<[`Settlement`](../../sequencer/interfaces/Settlement.md), \[`DBSettlement`, `number`[]\]\> - -## Constructors - -### new SettlementMapper() - -> **new SettlementMapper**(): [`SettlementMapper`](SettlementMapper.md) - -#### Returns - -[`SettlementMapper`](SettlementMapper.md) - -## Methods - -### mapIn() - -> **mapIn**(`input`): [`Settlement`](../../sequencer/interfaces/Settlement.md) - -Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L11) - -#### Parameters - -##### input - -\[\{ `promisedMessagesHash`: `string`; `transactionHash`: `string`; \}, `number`[]\] - -#### Returns - -[`Settlement`](../../sequencer/interfaces/Settlement.md) - -#### Implementation of - -`ObjectMapper.mapIn` - -*** - -### mapOut() - -> **mapOut**(`input`): \[\{ `promisedMessagesHash`: `string`; `transactionHash`: `string`; \}, `number`[]\] - -Defined in: [packages/persistance/src/services/prisma/mappers/SettlementMapper.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/SettlementMapper.ts#L21) - -#### Parameters - -##### input - -[`Settlement`](../../sequencer/interfaces/Settlement.md) - -#### Returns - -\[\{ `promisedMessagesHash`: `string`; `transactionHash`: `string`; \}, `number`[]\] - -#### Implementation of - -`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md b/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md deleted file mode 100644 index 9ac8518..0000000 --- a/src/pages/docs/reference/persistance/classes/StateTransitionArrayMapper.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: StateTransitionArrayMapper ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / StateTransitionArrayMapper - -# Class: StateTransitionArrayMapper - -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L22) - -## Implements - -- `ObjectMapper`\<[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md)[], `Prisma.JsonValue` \| `undefined`\> - -## Constructors - -### new StateTransitionArrayMapper() - -> **new StateTransitionArrayMapper**(`stMapper`): [`StateTransitionArrayMapper`](StateTransitionArrayMapper.md) - -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L26) - -#### Parameters - -##### stMapper - -[`StateTransitionMapper`](StateTransitionMapper.md) - -#### Returns - -[`StateTransitionArrayMapper`](StateTransitionArrayMapper.md) - -## Methods - -### mapIn() - -> **mapIn**(`input`): [`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md)[] - -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L28) - -#### Parameters - -##### input - -`undefined` | `JsonValue` - -#### Returns - -[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md)[] - -#### Implementation of - -`ObjectMapper.mapIn` - -*** - -### mapOut() - -> **mapOut**(`input`): `JsonValue` - -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L39) - -#### Parameters - -##### input - -[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md)[] - -#### Returns - -`JsonValue` - -#### Implementation of - -`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md b/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md deleted file mode 100644 index 71bb007..0000000 --- a/src/pages/docs/reference/persistance/classes/StateTransitionMapper.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: StateTransitionMapper ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / StateTransitionMapper - -# Class: StateTransitionMapper - -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L8) - -## Implements - -- `ObjectMapper`\<[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md), `Prisma.JsonObject`\> - -## Constructors - -### new StateTransitionMapper() - -> **new StateTransitionMapper**(): [`StateTransitionMapper`](StateTransitionMapper.md) - -#### Returns - -[`StateTransitionMapper`](StateTransitionMapper.md) - -## Methods - -### mapIn() - -> **mapIn**(`input`): [`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md) - -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L11) - -#### Parameters - -##### input - -`JsonObject` - -#### Returns - -[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md) - -#### Implementation of - -`ObjectMapper.mapIn` - -*** - -### mapOut() - -> **mapOut**(`input`): `JsonObject` - -Defined in: [packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/StateTransitionMapper.ts#L16) - -#### Parameters - -##### input - -[`UntypedStateTransition`](../../sequencer/classes/UntypedStateTransition.md) - -#### Returns - -`JsonObject` - -#### Implementation of - -`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md b/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md deleted file mode 100644 index 4fe9e0b..0000000 --- a/src/pages/docs/reference/persistance/classes/TransactionExecutionResultMapper.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: TransactionExecutionResultMapper ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / TransactionExecutionResultMapper - -# Class: TransactionExecutionResultMapper - -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L49) - -## Implements - -- `ObjectMapper`\<[`TransactionExecutionResult`](../../sequencer/interfaces/TransactionExecutionResult.md), \[`Omit`\<`DBTransactionExecutionResult`, `"blockHash"`\>, `DBTransaction`\]\> - -## Constructors - -### new TransactionExecutionResultMapper() - -> **new TransactionExecutionResultMapper**(`transactionMapper`, `stArrayMapper`, `eventArrayMapper`): [`TransactionExecutionResultMapper`](TransactionExecutionResultMapper.md) - -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L56) - -#### Parameters - -##### transactionMapper - -[`TransactionMapper`](TransactionMapper.md) - -##### stArrayMapper - -[`StateTransitionArrayMapper`](StateTransitionArrayMapper.md) - -##### eventArrayMapper - -`EventArrayMapper` - -#### Returns - -[`TransactionExecutionResultMapper`](TransactionExecutionResultMapper.md) - -## Methods - -### mapIn() - -> **mapIn**(`input`): [`TransactionExecutionResult`](../../sequencer/interfaces/TransactionExecutionResult.md) - -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L62) - -#### Parameters - -##### input - -\[`Omit`\<\{ `blockHash`: `string`; `events`: `JsonValue`; `protocolTransitions`: `JsonValue`; `stateTransitions`: `JsonValue`; `status`: `boolean`; `statusMessage`: `null` \| `string`; `txHash`: `string`; \}, `"blockHash"`\>, \{ `argsFields`: `string`[]; `auxiliaryData`: `string`[]; `hash`: `string`; `isMessage`: `boolean`; `methodId`: `string`; `nonce`: `string`; `sender`: `string`; `signature_r`: `string`; `signature_s`: `string`; \}\] - -#### Returns - -[`TransactionExecutionResult`](../../sequencer/interfaces/TransactionExecutionResult.md) - -#### Implementation of - -`ObjectMapper.mapIn` - -*** - -### mapOut() - -> **mapOut**(`input`): \[`Omit`\<\{ `blockHash`: `string`; `events`: `JsonValue`; `protocolTransitions`: `JsonValue`; `stateTransitions`: `JsonValue`; `status`: `boolean`; `statusMessage`: `null` \| `string`; `txHash`: `string`; \}, `"blockHash"`\>, \{ `argsFields`: `string`[]; `auxiliaryData`: `string`[]; `hash`: `string`; `isMessage`: `boolean`; `methodId`: `string`; `nonce`: `string`; `sender`: `string`; `signature_r`: `string`; `signature_s`: `string`; \}\] - -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L80) - -#### Parameters - -##### input - -[`TransactionExecutionResult`](../../sequencer/interfaces/TransactionExecutionResult.md) - -#### Returns - -\[`Omit`\<\{ `blockHash`: `string`; `events`: `JsonValue`; `protocolTransitions`: `JsonValue`; `stateTransitions`: `JsonValue`; `status`: `boolean`; `statusMessage`: `null` \| `string`; `txHash`: `string`; \}, `"blockHash"`\>, \{ `argsFields`: `string`[]; `auxiliaryData`: `string`[]; `hash`: `string`; `isMessage`: `boolean`; `methodId`: `string`; `nonce`: `string`; `sender`: `string`; `signature_r`: `string`; `signature_s`: `string`; \}\] - -#### Implementation of - -`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/classes/TransactionMapper.md b/src/pages/docs/reference/persistance/classes/TransactionMapper.md deleted file mode 100644 index 9e276c9..0000000 --- a/src/pages/docs/reference/persistance/classes/TransactionMapper.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: TransactionMapper ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / TransactionMapper - -# Class: TransactionMapper - -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L19) - -## Implements - -- `ObjectMapper`\<[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md), `DBTransaction`\> - -## Constructors - -### new TransactionMapper() - -> **new TransactionMapper**(): [`TransactionMapper`](TransactionMapper.md) - -#### Returns - -[`TransactionMapper`](TransactionMapper.md) - -## Methods - -### mapIn() - -> **mapIn**(`input`): [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) - -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L22) - -#### Parameters - -##### input - -###### argsFields - -`string`[] - -###### auxiliaryData - -`string`[] - -###### hash - -`string` - -###### isMessage - -`boolean` - -###### methodId - -`string` - -###### nonce - -`string` - -###### sender - -`string` - -###### signature_r - -`string` - -###### signature_s - -`string` - -#### Returns - -[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) - -#### Implementation of - -`ObjectMapper.mapIn` - -*** - -### mapOut() - -> **mapOut**(`input`): `object` - -Defined in: [packages/persistance/src/services/prisma/mappers/TransactionMapper.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/services/prisma/mappers/TransactionMapper.ts#L32) - -#### Parameters - -##### input - -[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) - -#### Returns - -`object` - -##### argsFields - -> **argsFields**: `string`[] - -##### auxiliaryData - -> **auxiliaryData**: `string`[] - -##### hash - -> **hash**: `string` - -##### isMessage - -> **isMessage**: `boolean` - -##### methodId - -> **methodId**: `string` - -##### nonce - -> **nonce**: `string` - -##### sender - -> **sender**: `string` - -##### signature\_r - -> **signature\_r**: `string` - -##### signature\_s - -> **signature\_s**: `string` - -#### Implementation of - -`ObjectMapper.mapOut` diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md b/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md deleted file mode 100644 index 520e68a..0000000 --- a/src/pages/docs/reference/persistance/interfaces/PrismaConnection.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: PrismaConnection ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaConnection - -# Interface: PrismaConnection - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L32) - -## Accessors - -### prismaClient - -#### Get Signature - -> **get** **prismaClient**(): `PrismaClient`\<`never`\> - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L33) - -##### Returns - -`PrismaClient`\<`never`\> diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md b/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md deleted file mode 100644 index bfdf8f2..0000000 --- a/src/pages/docs/reference/persistance/interfaces/PrismaDatabaseConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: PrismaDatabaseConfig ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaDatabaseConfig - -# Interface: PrismaDatabaseConfig - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L16) - -## Properties - -### connection? - -> `optional` **connection**: `string` \| \{ `db`: \{ `name`: `string`; `schema`: `string`; \}; `host`: `string`; `password`: `string`; `port`: `number`; `username`: `string`; \} - -Defined in: [packages/persistance/src/PrismaDatabaseConnection.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaDatabaseConnection.ts#L18) diff --git a/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md b/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md deleted file mode 100644 index 9349020..0000000 --- a/src/pages/docs/reference/persistance/interfaces/PrismaRedisCombinedConfig.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: PrismaRedisCombinedConfig ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / PrismaRedisCombinedConfig - -# Interface: PrismaRedisCombinedConfig - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L24) - -## Properties - -### prisma - -> **prisma**: [`PrismaDatabaseConfig`](PrismaDatabaseConfig.md) - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L25) - -*** - -### redis - -> **redis**: [`RedisConnectionConfig`](RedisConnectionConfig.md) - -Defined in: [packages/persistance/src/PrismaRedisDatabase.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/PrismaRedisDatabase.ts#L26) diff --git a/src/pages/docs/reference/persistance/interfaces/RedisConnection.md b/src/pages/docs/reference/persistance/interfaces/RedisConnection.md deleted file mode 100644 index a3581e1..0000000 --- a/src/pages/docs/reference/persistance/interfaces/RedisConnection.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: RedisConnection ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / RedisConnection - -# Interface: RedisConnection - -Defined in: [packages/persistance/src/RedisConnection.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L19) - -## Accessors - -### currentMulti - -#### Get Signature - -> **get** **currentMulti**(): `RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> - -Defined in: [packages/persistance/src/RedisConnection.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L21) - -##### Returns - -`RedisClientMultiCommandType`\<\{ `bf`: \{ `add`: `__module`; `ADD`: `__module`; `card`: `__module`; `CARD`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mExists`: `__module`; `MEXISTS`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cf`: \{ `add`: `__module`; `ADD`: `__module`; `addNX`: `__module`; `ADDNX`: `__module`; `count`: `__module`; `COUNT`: `__module`; `del`: `__module`; `DEL`: `__module`; `exists`: `__module`; `EXISTS`: `__module`; `info`: `__module`; `INFO`: `__module`; `insert`: `__module`; `INSERT`: `__module`; `insertNX`: `__module`; `INSERTNX`: `__module`; `loadChunk`: `__module`; `LOADCHUNK`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; `scanDump`: `__module`; `SCANDUMP`: `__module`; \}; `cms`: \{ `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `initByDim`: `__module`; `INITBYDIM`: `__module`; `initByProb`: `__module`; `INITBYPROB`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `query`: `__module`; `QUERY`: `__module`; \}; `ft`: \{ `_list`: `__module`; `_LIST`: `__module`; `aggregate`: `__module`; `AGGREGATE`: `__module`; `AGGREGATE_WITHCURSOR`: `__module`; `aggregateWithCursor`: `__module`; `aliasAdd`: `__module`; `ALIASADD`: `__module`; `aliasDel`: `__module`; `ALIASDEL`: `__module`; `aliasUpdate`: `__module`; `ALIASUPDATE`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `create`: `__module`; `CREATE`: `__module`; `CURSOR_DEL`: `__module`; `CURSOR_READ`: `__module`; `cursorDel`: `__module`; `cursorRead`: `__module`; `dictAdd`: `__module`; `DICTADD`: `__module`; `dictDel`: `__module`; `DICTDEL`: `__module`; `dictDump`: `__module`; `DICTDUMP`: `__module`; `dropIndex`: `__module`; `DROPINDEX`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `explainCli`: `__module`; `EXPLAINCLI`: `__module`; `info`: `__module`; `INFO`: `__module`; `profileAggregate`: `__module`; `PROFILEAGGREGATE`: `__module`; `profileSearch`: `__module`; `PROFILESEARCH`: `__module`; `search`: `__module`; `SEARCH`: `__module`; `SEARCH_NOCONTENT`: `__module`; `searchNoContent`: `__module`; `spellCheck`: `__module`; `SPELLCHECK`: `__module`; `sugAdd`: `__module`; `SUGADD`: `__module`; `sugDel`: `__module`; `SUGDEL`: `__module`; `sugGet`: `__module`; `SUGGET`: `__module`; `SUGGET_WITHPAYLOADS`: `__module`; `SUGGET_WITHSCORES`: `__module`; `SUGGET_WITHSCORES_WITHPAYLOADS`: `__module`; `sugGetWithPayloads`: `__module`; `sugGetWithScores`: `__module`; `sugGetWithScoresWithPayloads`: `__module`; `sugLen`: `__module`; `SUGLEN`: `__module`; `synDump`: `__module`; `SYNDUMP`: `__module`; `synUpdate`: `__module`; `SYNUPDATE`: `__module`; `tagVals`: `__module`; `TAGVALS`: `__module`; \}; `graph`: \{ `CONFIG_GET`: `__module`; `CONFIG_SET`: `__module`; `configGet`: `__module`; `configSet`: `__module`; `delete`: `__module`; `DELETE`: `__module`; `explain`: `__module`; `EXPLAIN`: `__module`; `list`: `__module`; `LIST`: `__module`; `profile`: `__module`; `PROFILE`: `__module`; `query`: `__module`; `QUERY`: `__module`; `RO_QUERY`: `__module`; `roQuery`: `__module`; `slowLog`: `__module`; `SLOWLOG`: `__module`; \}; `json`: \{ `arrAppend`: `__module`; `ARRAPPEND`: `__module`; `arrIndex`: `__module`; `ARRINDEX`: `__module`; `arrInsert`: `__module`; `ARRINSERT`: `__module`; `arrLen`: `__module`; `ARRLEN`: `__module`; `arrPop`: `__module`; `ARRPOP`: `__module`; `arrTrim`: `__module`; `ARRTRIM`: `__module`; `DEBUG_MEMORY`: `__module`; `debugMemory`: `__module`; `del`: `__module`; `DEL`: `__module`; `forget`: `__module`; `FORGET`: `__module`; `get`: `__module`; `GET`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `mSet`: `__module`; `MSET`: `__module`; `numIncrBy`: `__module`; `NUMINCRBY`: `__module`; `numMultBy`: `__module`; `NUMMULTBY`: `__module`; `objKeys`: `__module`; `OBJKEYS`: `__module`; `objLen`: `__module`; `OBJLEN`: `__module`; `resp`: `__module`; `RESP`: `__module`; `set`: `__module`; `SET`: `__module`; `strAppend`: `__module`; `STRAPPEND`: `__module`; `strLen`: `__module`; `STRLEN`: `__module`; `type`: `__module`; `TYPE`: `__module`; \}; `tDigest`: \{ `add`: `__module`; `ADD`: `__module`; `byRank`: `__module`; `BYRANK`: `__module`; `byRevRank`: `__module`; `BYREVRANK`: `__module`; `cdf`: `__module`; `CDF`: `__module`; `create`: `__module`; `CREATE`: `__module`; `info`: `__module`; `INFO`: `__module`; `max`: `__module`; `MAX`: `__module`; `merge`: `__module`; `MERGE`: `__module`; `min`: `__module`; `MIN`: `__module`; `quantile`: `__module`; `QUANTILE`: `__module`; `rank`: `__module`; `RANK`: `__module`; `reset`: `__module`; `RESET`: `__module`; `revRank`: `__module`; `REVRANK`: `__module`; `TRIMMED_MEAN`: `__module`; `trimmedMean`: `__module`; \}; `topK`: \{ `add`: `__module`; `ADD`: `__module`; `count`: `__module`; `COUNT`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `list`: `__module`; `LIST`: `__module`; `LIST_WITHCOUNT`: `__module`; `listWithCount`: `__module`; `query`: `__module`; `QUERY`: `__module`; `reserve`: `__module`; `RESERVE`: `__module`; \}; `ts`: \{ `add`: `__module`; `ADD`: `__module`; `alter`: `__module`; `ALTER`: `__module`; `create`: `__module`; `CREATE`: `__module`; `createRule`: `__module`; `CREATERULE`: `__module`; `decrBy`: `__module`; `DECRBY`: `__module`; `del`: `__module`; `DEL`: `__module`; `deleteRule`: `__module`; `DELETERULE`: `__module`; `get`: `__module`; `GET`: `__module`; `incrBy`: `__module`; `INCRBY`: `__module`; `info`: `__module`; `INFO`: `__module`; `INFO_DEBUG`: `__module`; `infoDebug`: `__module`; `mAdd`: `__module`; `MADD`: `__module`; `mGet`: `__module`; `MGET`: `__module`; `MGET_WITHLABELS`: `__module`; `mGetWithLabels`: `__module`; `mRange`: `__module`; `MRANGE`: `__module`; `MRANGE_WITHLABELS`: `__module`; `mRangeWithLabels`: `__module`; `mRevRange`: `__module`; `MREVRANGE`: `__module`; `MREVRANGE_WITHLABELS`: `__module`; `mRevRangeWithLabels`: `__module`; `queryIndex`: `__module`; `QUERYINDEX`: `__module`; `range`: `__module`; `RANGE`: `__module`; `revRange`: `__module`; `REVRANGE`: `__module`; \}; \}, `Record`\<`string`, `never`\>, `Record`\<`string`, `never`\>\> - -*** - -### redisClient - -#### Get Signature - -> **get** **redisClient**(): `RedisClientType` - -Defined in: [packages/persistance/src/RedisConnection.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L20) - -##### Returns - -`RedisClientType` diff --git a/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md b/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md deleted file mode 100644 index 86ee13e..0000000 --- a/src/pages/docs/reference/persistance/interfaces/RedisConnectionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: RedisConnectionConfig ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / RedisConnectionConfig - -# Interface: RedisConnectionConfig - -Defined in: [packages/persistance/src/RedisConnection.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L10) - -## Properties - -### host - -> **host**: `string` - -Defined in: [packages/persistance/src/RedisConnection.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L11) - -*** - -### password? - -> `optional` **password**: `string` - -Defined in: [packages/persistance/src/RedisConnection.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L12) - -*** - -### port? - -> `optional` **port**: `number` - -Defined in: [packages/persistance/src/RedisConnection.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L13) - -*** - -### username? - -> `optional` **username**: `string` - -Defined in: [packages/persistance/src/RedisConnection.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L14) diff --git a/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md b/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md deleted file mode 100644 index f6f938c..0000000 --- a/src/pages/docs/reference/persistance/type-aliases/RedisTransaction.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: RedisTransaction ---- - -[**@proto-kit/persistance**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/persistance](../README.md) / RedisTransaction - -# Type Alias: RedisTransaction - -> **RedisTransaction**: `ReturnType`\<`RedisClientType`\[`"multi"`\]\> - -Defined in: [packages/persistance/src/RedisConnection.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/persistance/src/RedisConnection.ts#L17) diff --git a/src/pages/docs/reference/processor/README.md b/src/pages/docs/reference/processor/README.md deleted file mode 100644 index 944d4c4..0000000 --- a/src/pages/docs/reference/processor/README.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "@proto-kit/processor" ---- - -**@proto-kit/processor** - -*** - -[Documentation](../../README.md) / @proto-kit/processor - -# @proto-kit/processor - -## Classes - -- [BlockFetching](classes/BlockFetching.md) -- [Database](classes/Database.md) -- [DatabasePruneModule](classes/DatabasePruneModule.md) -- [HandlersExecutor](classes/HandlersExecutor.md) -- [Processor](classes/Processor.md) -- [ProcessorModule](classes/ProcessorModule.md) -- [ResolverFactoryGraphqlModule](classes/ResolverFactoryGraphqlModule.md) -- [TimedProcessorTrigger](classes/TimedProcessorTrigger.md) - -## Interfaces - -- [BlockFetchingConfig](interfaces/BlockFetchingConfig.md) -- [BlockResponse](interfaces/BlockResponse.md) -- [DatabasePruneModuleConfig](interfaces/DatabasePruneModuleConfig.md) -- [HandlersExecutorConfig](interfaces/HandlersExecutorConfig.md) -- [HandlersRecord](interfaces/HandlersRecord.md) -- [TimedProcessorTriggerConfig](interfaces/TimedProcessorTriggerConfig.md) - -## Type Aliases - -- [BlockHandler](type-aliases/BlockHandler.md) -- [ClientTransaction](type-aliases/ClientTransaction.md) -- [ProcessorModulesRecord](type-aliases/ProcessorModulesRecord.md) - -## Functions - -- [cleanResolvers](functions/cleanResolvers.md) -- [ValidateTakeArg](functions/ValidateTakeArg.md) diff --git a/src/pages/docs/reference/processor/_meta.tsx b/src/pages/docs/reference/processor/_meta.tsx deleted file mode 100644 index a31554d..0000000 --- a/src/pages/docs/reference/processor/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","functions": "Functions","interfaces": "Interfaces","type-aliases": "Type Aliases" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/processor/classes/BlockFetching.md b/src/pages/docs/reference/processor/classes/BlockFetching.md deleted file mode 100644 index a523180..0000000 --- a/src/pages/docs/reference/processor/classes/BlockFetching.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -title: BlockFetching ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / BlockFetching - -# Class: BlockFetching - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L36) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ProcessorModule`](ProcessorModule.md)\<[`BlockFetchingConfig`](../interfaces/BlockFetchingConfig.md)\> - -## Constructors - -### new BlockFetching() - -> **new BlockFetching**(`blockMapper`, `blockResultMapper`, `transactionResultMapper`): [`BlockFetching`](BlockFetching.md) - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L37) - -#### Parameters - -##### blockMapper - -[`BlockMapper`](../../persistance/classes/BlockMapper.md) - -##### blockResultMapper - -[`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) - -##### transactionResultMapper - -[`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) - -#### Returns - -[`BlockFetching`](BlockFetching.md) - -#### Overrides - -[`ProcessorModule`](ProcessorModule.md).[`constructor`](ProcessorModule.md#constructors) - -## Properties - -### blockMapper - -> **blockMapper**: [`BlockMapper`](../../persistance/classes/BlockMapper.md) - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L38) - -*** - -### blockResultMapper - -> **blockResultMapper**: [`BlockResultMapper`](../../persistance/classes/BlockResultMapper.md) - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L39) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`BlockFetchingConfig`](../interfaces/BlockFetchingConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`currentConfig`](ProcessorModule.md#currentconfig) - -*** - -### transactionResultMapper - -> **transactionResultMapper**: [`TransactionExecutionResultMapper`](../../persistance/classes/TransactionExecutionResultMapper.md) - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L40) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`config`](ProcessorModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`create`](ProcessorModule.md#create) - -*** - -### fetchBlock() - -> **fetchBlock**(`height`): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L45) - -#### Parameters - -##### height - -`number` - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:146](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L146) - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`ProcessorModule`](ProcessorModule.md).[`start`](ProcessorModule.md#start) diff --git a/src/pages/docs/reference/processor/classes/Database.md b/src/pages/docs/reference/processor/classes/Database.md deleted file mode 100644 index 4d413a0..0000000 --- a/src/pages/docs/reference/processor/classes/Database.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -title: Database ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / Database - -# Class: Database\ - -Defined in: [packages/processor/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L11) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Extends - -- [`ProcessorModule`](ProcessorModule.md)\<[`NoConfig`](../../common/type-aliases/NoConfig.md)\> - -## Type Parameters - -• **PrismaClient** *extends* `BasePrismaClient` - -## Implements - -- `PrismaDatabaseConnection`\<`PrismaClient`\> -- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) - -## Constructors - -### new Database() - -> **new Database**\<`PrismaClient`\>(`prismaClient`): [`Database`](Database.md)\<`PrismaClient`\> - -Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L15) - -#### Parameters - -##### prismaClient - -`PrismaClient` - -#### Returns - -[`Database`](Database.md)\<`PrismaClient`\> - -#### Overrides - -[`ProcessorModule`](ProcessorModule.md).[`constructor`](ProcessorModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`currentConfig`](ProcessorModule.md#currentconfig) - -*** - -### prismaClient - -> **prismaClient**: `PrismaClient` - -Defined in: [packages/processor/src/storage/Database.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L15) - -#### Implementation of - -`PrismaDatabaseConnection.prismaClient` - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`config`](ProcessorModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`create`](ProcessorModule.md#create) - -*** - -### dependencies() - -> **dependencies**(): `object` - -Defined in: [packages/processor/src/storage/Database.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L29) - -#### Returns - -`object` - -##### BlockStorage - -> **BlockStorage**: `object` - -###### BlockStorage.useClass - -> **BlockStorage.useClass**: *typeof* `BlockStorage` = `BlockStorage` - -#### Implementation of - -[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) - -*** - -### pruneDatabase() - -> **pruneDatabase**(): `Promise`\<`void`\> - -Defined in: [packages/processor/src/storage/Database.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L37) - -#### Returns - -`Promise`\<`void`\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/processor/src/storage/Database.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L50) - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`ProcessorModule`](ProcessorModule.md).[`start`](ProcessorModule.md#start) - -*** - -### from() - -> `static` **from**\<`PrismaClient`\>(`prismaClient`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Database`](Database.md)\<`PrismaClient`\>\> - -Defined in: [packages/processor/src/storage/Database.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/Database.ts#L19) - -#### Type Parameters - -• **PrismaClient** *extends* `BasePrismaClient` - -#### Parameters - -##### prismaClient - -`PrismaClient` - -#### Returns - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Database`](Database.md)\<`PrismaClient`\>\> diff --git a/src/pages/docs/reference/processor/classes/DatabasePruneModule.md b/src/pages/docs/reference/processor/classes/DatabasePruneModule.md deleted file mode 100644 index aac2c5d..0000000 --- a/src/pages/docs/reference/processor/classes/DatabasePruneModule.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: DatabasePruneModule ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / DatabasePruneModule - -# Class: DatabasePruneModule - -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/DatabasePruneModule.ts#L14) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ProcessorModule`](ProcessorModule.md)\<[`DatabasePruneModuleConfig`](../interfaces/DatabasePruneModuleConfig.md)\> - -## Constructors - -### new DatabasePruneModule() - -> **new DatabasePruneModule**(`database`): [`DatabasePruneModule`](DatabasePruneModule.md) - -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/DatabasePruneModule.ts#L15) - -#### Parameters - -##### database - -[`Database`](Database.md)\<`BasePrismaClient`\> - -#### Returns - -[`DatabasePruneModule`](DatabasePruneModule.md) - -#### Overrides - -[`ProcessorModule`](ProcessorModule.md).[`constructor`](ProcessorModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`DatabasePruneModuleConfig`](../interfaces/DatabasePruneModuleConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`currentConfig`](ProcessorModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`config`](ProcessorModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`create`](ProcessorModule.md#create) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/DatabasePruneModule.ts#L21) - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`ProcessorModule`](ProcessorModule.md).[`start`](ProcessorModule.md#start) diff --git a/src/pages/docs/reference/processor/classes/HandlersExecutor.md b/src/pages/docs/reference/processor/classes/HandlersExecutor.md deleted file mode 100644 index 8fc6d2f..0000000 --- a/src/pages/docs/reference/processor/classes/HandlersExecutor.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -title: HandlersExecutor ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / HandlersExecutor - -# Class: HandlersExecutor\ - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L28) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ProcessorModule`](ProcessorModule.md)\<[`HandlersExecutorConfig`](../interfaces/HandlersExecutorConfig.md)\> - -## Type Parameters - -• **PrismaClient** *extends* `BasePrismaClient` - -• **Handlers** *extends* [`HandlersRecord`](../interfaces/HandlersRecord.md)\<`PrismaClient`\> - -## Constructors - -### new HandlersExecutor() - -> **new HandlersExecutor**\<`PrismaClient`, `Handlers`\>(): [`HandlersExecutor`](HandlersExecutor.md)\<`PrismaClient`, `Handlers`\> - -#### Returns - -[`HandlersExecutor`](HandlersExecutor.md)\<`PrismaClient`, `Handlers`\> - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`constructor`](ProcessorModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`HandlersExecutorConfig`](../interfaces/HandlersExecutorConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`currentConfig`](ProcessorModule.md#currentconfig) - -*** - -### database - -> **database**: `undefined` \| `PrismaDatabaseConnection`\<`PrismaClient`\> - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L36) - -*** - -### handlers - -> **handlers**: `undefined` \| `Handlers` - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L34) - -*** - -### isExecuting - -> **isExecuting**: `boolean` = `false` - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L32) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`config`](ProcessorModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L38) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Overrides - -[`ProcessorModule`](ProcessorModule.md).[`create`](ProcessorModule.md#create) - -*** - -### execute() - -> **execute**(`block`): `Promise`\<`void`\> - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L83) - -#### Parameters - -##### block - -[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### onAfterHandlers() - -> **onAfterHandlers**(`client`, `block`): `Promise`\<`void`\> - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L72) - -#### Parameters - -##### client - -[`ClientTransaction`](../type-aliases/ClientTransaction.md)\<`PrismaClient`\> - -##### block - -[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### onBlock() - -> **onBlock**(`client`, `block`): `Promise`\<`void`\> - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L60) - -#### Parameters - -##### client - -[`ClientTransaction`](../type-aliases/ClientTransaction.md)\<`PrismaClient`\> - -##### block - -[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L46) - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`ProcessorModule`](ProcessorModule.md).[`start`](ProcessorModule.md#start) - -*** - -### from() - -> `static` **from**\<`PrismaClient`, `Handlers`\>(`handlers`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`HandlersExecutor`](HandlersExecutor.md)\<`PrismaClient`, `Handlers`\>\> - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L48) - -#### Type Parameters - -• **PrismaClient** *extends* `BasePrismaClient` - -• **Handlers** *extends* [`HandlersRecord`](../interfaces/HandlersRecord.md)\<`PrismaClient`\> - -#### Parameters - -##### handlers - -`Handlers` - -#### Returns - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`HandlersExecutor`](HandlersExecutor.md)\<`PrismaClient`, `Handlers`\>\> diff --git a/src/pages/docs/reference/processor/classes/Processor.md b/src/pages/docs/reference/processor/classes/Processor.md deleted file mode 100644 index 7b1ca08..0000000 --- a/src/pages/docs/reference/processor/classes/Processor.md +++ /dev/null @@ -1,618 +0,0 @@ ---- -title: Processor ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / Processor - -# Class: Processor\ - -Defined in: [packages/processor/src/Processor.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/Processor.ts#L15) - -Reusable module container facilitating registration, resolution -configuration, decoration and validation of modules - -## Extends - -- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Modules`\> - -## Type Parameters - -• **Modules** *extends* [`ProcessorModulesRecord`](../type-aliases/ProcessorModulesRecord.md) - -## Constructors - -### new Processor() - -> **new Processor**\<`Modules`\>(`definition`): [`Processor`](Processor.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:68 - -#### Parameters - -##### definition - -[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -#### Returns - -[`Processor`](Processor.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) - -*** - -### definition - -> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:160 - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) - -*** - -### decorateModule() - -> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:134 - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -`InstanceType`\<`Modules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>\]\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>[] - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -`Modules` - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -`Modules` - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/processor/src/Processor.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/Processor.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`Modules`\>(`definition`): [`Processor`](Processor.md)\<`Modules`\> - -Defined in: [packages/processor/src/Processor.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/Processor.ts#L18) - -#### Type Parameters - -• **Modules** *extends* [`ProcessorModulesRecord`](../type-aliases/ProcessorModulesRecord.md) - -#### Parameters - -##### definition - -[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -#### Returns - -[`Processor`](Processor.md)\<`Modules`\> diff --git a/src/pages/docs/reference/processor/classes/ProcessorModule.md b/src/pages/docs/reference/processor/classes/ProcessorModule.md deleted file mode 100644 index 57dbf65..0000000 --- a/src/pages/docs/reference/processor/classes/ProcessorModule.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: ProcessorModule ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / ProcessorModule - -# Class: `abstract` ProcessorModule\ - -Defined in: [packages/processor/src/ProcessorModule.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/ProcessorModule.ts#L3) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> - -## Extended by - -- [`HandlersExecutor`](HandlersExecutor.md) -- [`Database`](Database.md) -- [`TimedProcessorTrigger`](TimedProcessorTrigger.md) -- [`BlockFetching`](BlockFetching.md) -- [`DatabasePruneModule`](DatabasePruneModule.md) - -## Type Parameters - -• **Config** - -## Constructors - -### new ProcessorModule() - -> **new ProcessorModule**\<`Config`\>(): [`ProcessorModule`](ProcessorModule.md)\<`Config`\> - -#### Returns - -[`ProcessorModule`](ProcessorModule.md)\<`Config`\> - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) - -*** - -### start() - -> `abstract` **start**(): `Promise`\<`void`\> - -Defined in: [packages/processor/src/ProcessorModule.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/ProcessorModule.ts#L6) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md b/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md deleted file mode 100644 index fae3674..0000000 --- a/src/pages/docs/reference/processor/classes/ResolverFactoryGraphqlModule.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: ResolverFactoryGraphqlModule ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / ResolverFactoryGraphqlModule - -# Class: ResolverFactoryGraphqlModule\ - -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L49) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md) - -## Type Parameters - -• **PrismaClient** *extends* `BasePrismaClient` - -## Constructors - -### new ResolverFactoryGraphqlModule() - -> **new ResolverFactoryGraphqlModule**\<`PrismaClient`\>(`graphqlServer`): [`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\> - -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) - -#### Parameters - -##### graphqlServer - -[`GraphqlServer`](../../api/classes/GraphqlServer.md) - -#### Returns - -[`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\> - -#### Overrides - -[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`constructor`](../../api/classes/ResolverFactoryGraphqlModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`currentConfig`](../../api/classes/ResolverFactoryGraphqlModule.md#currentconfig) - -*** - -### database - -> **database**: `undefined` \| `PrismaDatabaseConnection`\<`PrismaClient`\> - -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L62) - -*** - -### graphqlServer - -> **graphqlServer**: [`GraphqlServer`](../../api/classes/GraphqlServer.md) - -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L64) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`config`](../../api/classes/ResolverFactoryGraphqlModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L68) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Overrides - -[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`create`](../../api/classes/ResolverFactoryGraphqlModule.md#create) - -*** - -### resolvers() - -> **resolvers**(): `Promise`\<`NonEmptyArray`\<`Function`\>\> - -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L77) - -#### Returns - -`Promise`\<`NonEmptyArray`\<`Function`\>\> - -#### Overrides - -[`ResolverFactoryGraphqlModule`](../../api/classes/ResolverFactoryGraphqlModule.md).[`resolvers`](../../api/classes/ResolverFactoryGraphqlModule.md#resolvers) - -*** - -### from() - -> `static` **from**\<`PrismaClient`\>(`resolvers`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\>\> - -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L52) - -#### Type Parameters - -• **PrismaClient** *extends* `BasePrismaClient` - -#### Parameters - -##### resolvers - -`NonEmptyArray`\<`Function`\> - -#### Returns - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ResolverFactoryGraphqlModule`](ResolverFactoryGraphqlModule.md)\<`PrismaClient`\>\> diff --git a/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md b/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md deleted file mode 100644 index aa66cee..0000000 --- a/src/pages/docs/reference/processor/classes/TimedProcessorTrigger.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -title: TimedProcessorTrigger ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / TimedProcessorTrigger - -# Class: TimedProcessorTrigger - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L15) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ProcessorModule`](ProcessorModule.md)\<[`TimedProcessorTriggerConfig`](../interfaces/TimedProcessorTriggerConfig.md)\> - -## Constructors - -### new TimedProcessorTrigger() - -> **new TimedProcessorTrigger**(`blockStorage`, `blockFetching`, `handlersExecutor`): [`TimedProcessorTrigger`](TimedProcessorTrigger.md) - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L18) - -#### Parameters - -##### blockStorage - -`BlockStorage` - -##### blockFetching - -[`BlockFetching`](BlockFetching.md) - -##### handlersExecutor - -[`HandlersExecutor`](HandlersExecutor.md)\<`BasePrismaClient`, [`HandlersRecord`](../interfaces/HandlersRecord.md)\<`BasePrismaClient`\>\> - -#### Returns - -[`TimedProcessorTrigger`](TimedProcessorTrigger.md) - -#### Overrides - -[`ProcessorModule`](ProcessorModule.md).[`constructor`](ProcessorModule.md#constructors) - -## Properties - -### blockFetching - -> **blockFetching**: [`BlockFetching`](BlockFetching.md) - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L20) - -*** - -### blockStorage - -> **blockStorage**: `BlockStorage` - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L19) - -*** - -### catchingUp - -> **catchingUp**: `boolean` = `false` - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L16) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`TimedProcessorTriggerConfig`](../interfaces/TimedProcessorTriggerConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`currentConfig`](ProcessorModule.md#currentconfig) - -*** - -### handlersExecutor - -> **handlersExecutor**: [`HandlersExecutor`](HandlersExecutor.md)\<`BasePrismaClient`, [`HandlersRecord`](../interfaces/HandlersRecord.md)\<`BasePrismaClient`\>\> - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L22) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`config`](ProcessorModule.md#config) - -## Methods - -### catchUp() - -> **catchUp**(): `Promise`\<`void`\> - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L61) - -#### Returns - -`Promise`\<`void`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProcessorModule`](ProcessorModule.md).[`create`](ProcessorModule.md#create) - -*** - -### processNextBlock() - -> **processNextBlock**(): `Promise`\<`boolean`\> - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L30) - -#### Returns - -`Promise`\<`boolean`\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L77) - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`ProcessorModule`](ProcessorModule.md).[`start`](ProcessorModule.md#start) diff --git a/src/pages/docs/reference/processor/functions/ValidateTakeArg.md b/src/pages/docs/reference/processor/functions/ValidateTakeArg.md deleted file mode 100644 index 91c2ad4..0000000 --- a/src/pages/docs/reference/processor/functions/ValidateTakeArg.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: ValidateTakeArg ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / ValidateTakeArg - -# Function: ValidateTakeArg() - -> **ValidateTakeArg**(): `MethodDecorator` - -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L34) - -## Returns - -`MethodDecorator` diff --git a/src/pages/docs/reference/processor/functions/cleanResolvers.md b/src/pages/docs/reference/processor/functions/cleanResolvers.md deleted file mode 100644 index fda776b..0000000 --- a/src/pages/docs/reference/processor/functions/cleanResolvers.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: cleanResolvers ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / cleanResolvers - -# Function: cleanResolvers() - -> **cleanResolvers**(`resolvers`): `NonEmptyArray`\<`Function`\> - -Defined in: [packages/processor/src/api/ResolverFactoryGraphqlModule.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/api/ResolverFactoryGraphqlModule.ts#L12) - -## Parameters - -### resolvers - -`NonEmptyArray`\<`Function`\> - -## Returns - -`NonEmptyArray`\<`Function`\> diff --git a/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md b/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md deleted file mode 100644 index 524cfe6..0000000 --- a/src/pages/docs/reference/processor/interfaces/BlockFetchingConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: BlockFetchingConfig ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / BlockFetchingConfig - -# Interface: BlockFetchingConfig - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L19) - -## Properties - -### url - -> **url**: `string` - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L20) diff --git a/src/pages/docs/reference/processor/interfaces/BlockResponse.md b/src/pages/docs/reference/processor/interfaces/BlockResponse.md deleted file mode 100644 index 629b908..0000000 --- a/src/pages/docs/reference/processor/interfaces/BlockResponse.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: BlockResponse ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / BlockResponse - -# Interface: BlockResponse - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L23) - -## Properties - -### data - -> **data**: `object` - -Defined in: [packages/processor/src/indexer/BlockFetching.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/indexer/BlockFetching.ts#L24) - -#### findFirstBlock - -> **findFirstBlock**: `object` & `object` & `object` - -##### Type declaration - -###### batchHeight - -> **batchHeight**: `null` \| `number` - -###### beforeNetworkState - -> **beforeNetworkState**: `JsonValue` - -###### duringNetworkState - -> **duringNetworkState**: `JsonValue` - -###### fromBlockHashRoot - -> **fromBlockHashRoot**: `string` - -###### fromEternalTransactionsHash - -> **fromEternalTransactionsHash**: `string` - -###### fromMessagesHash - -> **fromMessagesHash**: `string` - -###### hash - -> **hash**: `string` - -###### height - -> **height**: `number` - -###### parentHash - -> **parentHash**: `null` \| `string` - -###### toEternalTransactionsHash - -> **toEternalTransactionsHash**: `string` - -###### toMessagesHash - -> **toMessagesHash**: `string` - -###### transactionsHash - -> **transactionsHash**: `string` - -##### Type declaration - -###### result - -> **result**: `object` - -###### result.afterNetworkState - -> **result.afterNetworkState**: `JsonValue` - -###### result.blockHash - -> **result.blockHash**: `string` - -###### result.blockHashRoot - -> **result.blockHashRoot**: `string` - -###### result.blockHashWitness - -> **result.blockHashWitness**: `JsonValue` - -###### result.blockStateTransitions - -> **result.blockStateTransitions**: `JsonValue` - -###### result.stateRoot - -> **result.stateRoot**: `string` - -##### Type declaration - -###### transactions - -> **transactions**: `object` & `object`[] diff --git a/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md b/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md deleted file mode 100644 index cdac755..0000000 --- a/src/pages/docs/reference/processor/interfaces/DatabasePruneModuleConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: DatabasePruneModuleConfig ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / DatabasePruneModuleConfig - -# Interface: DatabasePruneModuleConfig - -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/DatabasePruneModule.ts#L9) - -## Properties - -### pruneOnStartup? - -> `optional` **pruneOnStartup**: `boolean` - -Defined in: [packages/processor/src/storage/DatabasePruneModule.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/storage/DatabasePruneModule.ts#L10) diff --git a/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md b/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md deleted file mode 100644 index 8e71ed6..0000000 --- a/src/pages/docs/reference/processor/interfaces/HandlersExecutorConfig.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: HandlersExecutorConfig ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / HandlersExecutorConfig - -# Interface: HandlersExecutorConfig - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L22) - -## Properties - -### maxWait? - -> `optional` **maxWait**: `number` - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L23) - -*** - -### timeout? - -> `optional` **timeout**: `number` - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L24) diff --git a/src/pages/docs/reference/processor/interfaces/HandlersRecord.md b/src/pages/docs/reference/processor/interfaces/HandlersRecord.md deleted file mode 100644 index 122b371..0000000 --- a/src/pages/docs/reference/processor/interfaces/HandlersRecord.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: HandlersRecord ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / HandlersRecord - -# Interface: HandlersRecord\ - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L18) - -## Type Parameters - -• **PrismaClient** *extends* `BasePrismaClient` - -## Properties - -### onBlock - -> **onBlock**: [`BlockHandler`](../type-aliases/BlockHandler.md)\<`PrismaClient`\>[] - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L19) diff --git a/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md b/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md deleted file mode 100644 index 516b64c..0000000 --- a/src/pages/docs/reference/processor/interfaces/TimedProcessorTriggerConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: TimedProcessorTriggerConfig ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / TimedProcessorTriggerConfig - -# Interface: TimedProcessorTriggerConfig - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L10) - -## Properties - -### interval? - -> `optional` **interval**: `number` - -Defined in: [packages/processor/src/triggers/TimedProcessorTrigger.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/triggers/TimedProcessorTrigger.ts#L11) diff --git a/src/pages/docs/reference/processor/type-aliases/BlockHandler.md b/src/pages/docs/reference/processor/type-aliases/BlockHandler.md deleted file mode 100644 index 36f3610..0000000 --- a/src/pages/docs/reference/processor/type-aliases/BlockHandler.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: BlockHandler ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / BlockHandler - -# Type Alias: BlockHandler()\ - -> **BlockHandler**\<`PrismaClient`\>: (`client`, `block`) => `Promise`\<`void`\> - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L13) - -## Type Parameters - -• **PrismaClient** *extends* `BasePrismaClient` - -## Parameters - -### client - -[`ClientTransaction`](ClientTransaction.md)\<`PrismaClient`\> - -### block - -[`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md) - -## Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md b/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md deleted file mode 100644 index 625e425..0000000 --- a/src/pages/docs/reference/processor/type-aliases/ClientTransaction.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: ClientTransaction ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / ClientTransaction - -# Type Alias: ClientTransaction\ - -> **ClientTransaction**\<`PrismaClient`\>: `Parameters`\<`Parameters`\<`PrismaClient`\[`"$transaction"`\]\>\[`0`\]\>\[`0`\] - -Defined in: [packages/processor/src/handlers/HandlersExecutor.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/handlers/HandlersExecutor.ts#L10) - -## Type Parameters - -• **PrismaClient** *extends* `BasePrismaClient` diff --git a/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md b/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md deleted file mode 100644 index 987b870..0000000 --- a/src/pages/docs/reference/processor/type-aliases/ProcessorModulesRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: ProcessorModulesRecord ---- - -[**@proto-kit/processor**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/processor](../README.md) / ProcessorModulesRecord - -# Type Alias: ProcessorModulesRecord - -> **ProcessorModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ProcessorModule`](../classes/ProcessorModule.md)\<`unknown`\>\>\> - -Defined in: [packages/processor/src/Processor.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/processor/src/Processor.ts#L11) diff --git a/src/pages/docs/reference/protocol/README.md b/src/pages/docs/reference/protocol/README.md deleted file mode 100644 index 10f39a7..0000000 --- a/src/pages/docs/reference/protocol/README.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "@proto-kit/protocol" ---- - -**@proto-kit/protocol** - -*** - -[Documentation](../../README.md) / @proto-kit/protocol - -# YAB: Protocol - -Protocol contains to all circuit-aware data types and provers - -### StateTransitionProver - -The StateTransitionProver takes a list of StateTransitions, checks and proves their precondition and update to the respective merkletree represented by the state root public input. - -In the public input, the prover transitions from two fields: - -- state root -- transitions hash - -The transitions hash is the commitment to a hash list where every state transition gets appended one-by-one. - -The StateTransitionsProver batches the application of multiple state transitions together. -If the amount of state transitions if greater than the batch size, the seperate proofs can be merged together. - -In the end, the publicInput of the StateTransitionProof should contain the following content: - -- `fromTransitionsHash: 0` To prove that all STs have been applied, the transitionsHash must start at zero (i.e. a empty hash list) -- `toTransitionsHash` This value must be the same as the transitionsHash in the AppChainProof to guarantee that all (and same) statetransitions that have been outputted by the AppChain have been applied -- `from- and toStateRoot` These values represent the root of the state tree and will later be stitched together to arrive at the final stateroot for a bundle - -### BlockProver - -The BlockProver's responsibility is to verify and put together the AppChainProof and StateTransitionProof. -It verifies that the transitionsHash is the same across both proofs and then takes the new state root proved by the STProof. - -In the end, the BlockProof proofs that: - -- the AppChain has been executed correctly -- the resulting state changes have been applied correctly and fully to the state root - -Multiple BlockProofs will then be merged together, signed by the sequencer and published to the base layer. - -### RollupMerkleTree - -The RollupMerkleTree is a custom merkle tree implementation that supports the injection of a storage adapter. -The interface for that adapter can be found as the interface `MerkleTreeStorage`. - -Adapters can implement any storage backend, like In-Memory and Database, and supports a process called "virtualization". -Virtualization is the process of layering different Adapters on top of each other. -For example if I want to simulate some transactions to a merkle tree, I can virtualize a database adapter into a MemoryAdapter. -If I am happy with the result, I can merge the results into the database or, if not, discard them without writing the changes to the database. diff --git a/src/pages/docs/reference/protocol/_meta.tsx b/src/pages/docs/reference/protocol/_meta.tsx deleted file mode 100644 index 4d63940..0000000 --- a/src/pages/docs/reference/protocol/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/protocol/classes/AccountState.md b/src/pages/docs/reference/protocol/classes/AccountState.md deleted file mode 100644 index 5796ac8..0000000 --- a/src/pages/docs/reference/protocol/classes/AccountState.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -title: AccountState ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / AccountState - -# Class: AccountState - -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/AccountStateHook.ts#L10) - -## Extends - -- `object` - -## Constructors - -### new AccountState() - -> **new AccountState**(`value`): [`AccountState`](AccountState.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### nonce - -`UInt64` = `UInt64` - -#### Returns - -[`AccountState`](AccountState.md) - -#### Inherited from - -`Struct({ nonce: UInt64, }).constructor` - -## Properties - -### nonce - -> **nonce**: `UInt64` = `UInt64` - -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/AccountStateHook.ts#L11) - -#### Inherited from - -`Struct({ nonce: UInt64, }).nonce` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ nonce: UInt64, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### nonce - -`UInt64` = `UInt64` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ nonce: UInt64, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### nonce - -> **nonce**: `UInt64` = `UInt64` - -#### Inherited from - -`Struct({ nonce: UInt64, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### nonce - -> **nonce**: `UInt64` = `UInt64` - -#### Inherited from - -`Struct({ nonce: UInt64, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### nonce - -`string` = `UInt64` - -#### Returns - -`object` - -##### nonce - -> **nonce**: `UInt64` = `UInt64` - -#### Inherited from - -`Struct({ nonce: UInt64, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ nonce: UInt64, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### nonce - -`UInt64` = `UInt64` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ nonce: UInt64, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### nonce - -`UInt64` = `UInt64` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ nonce: UInt64, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### nonce - -`UInt64` = `UInt64` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ nonce: UInt64, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### nonce - -`UInt64` = `UInt64` - -#### Returns - -`object` - -##### nonce - -> **nonce**: `string` = `UInt64` - -#### Inherited from - -`Struct({ nonce: UInt64, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### nonce - -`UInt64` = `UInt64` - -#### Returns - -`object` - -##### nonce - -> **nonce**: `bigint` = `UInt64` - -#### Inherited from - -`Struct({ nonce: UInt64, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ nonce: UInt64, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/AccountStateHook.md b/src/pages/docs/reference/protocol/classes/AccountStateHook.md deleted file mode 100644 index e206cab..0000000 --- a/src/pages/docs/reference/protocol/classes/AccountStateHook.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -title: AccountStateHook ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / AccountStateHook - -# Class: AccountStateHook - -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/AccountStateHook.ts#L15) - -## Extends - -- [`ProvableTransactionHook`](ProvableTransactionHook.md) - -## Constructors - -### new AccountStateHook() - -> **new AccountStateHook**(): [`AccountStateHook`](AccountStateHook.md) - -#### Returns - -[`AccountStateHook`](AccountStateHook.md) - -#### Inherited from - -[`ProvableTransactionHook`](ProvableTransactionHook.md).[`constructor`](ProvableTransactionHook.md#constructors) - -## Properties - -### accountState - -> **accountState**: [`StateMap`](StateMap.md)\<`PublicKey`, [`AccountState`](AccountState.md)\> - -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/AccountStateHook.ts#L16) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProvableTransactionHook`](ProvableTransactionHook.md).[`currentConfig`](ProvableTransactionHook.md#currentconfig) - -*** - -### name? - -> `optional` **name**: `string` - -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) - -#### Inherited from - -[`ProvableTransactionHook`](ProvableTransactionHook.md).[`name`](ProvableTransactionHook.md#name) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Inherited from - -[`ProvableTransactionHook`](ProvableTransactionHook.md).[`protocol`](ProvableTransactionHook.md#protocol) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -[`ProvableTransactionHook`](ProvableTransactionHook.md).[`areProofsEnabled`](ProvableTransactionHook.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProvableTransactionHook`](ProvableTransactionHook.md).[`config`](ProvableTransactionHook.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProvableTransactionHook`](ProvableTransactionHook.md).[`create`](ProvableTransactionHook.md#create) - -*** - -### onTransaction() - -> **onTransaction**(`__namedParameters`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/hooks/AccountStateHook.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/AccountStateHook.ts#L21) - -#### Parameters - -##### \_\_namedParameters - -[`BlockProverExecutionData`](BlockProverExecutionData.md) - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`ProvableTransactionHook`](ProvableTransactionHook.md).[`onTransaction`](ProvableTransactionHook.md#ontransaction) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ProvableTransactionHook`](ProvableTransactionHook.md).[`start`](ProvableTransactionHook.md#start) diff --git a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md deleted file mode 100644 index 1eab434..0000000 --- a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTree.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -title: BlockHashMerkleTree ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockHashMerkleTree - -# Class: BlockHashMerkleTree - -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L4) - -## Extends - -- [`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md) - -## Constructors - -### new BlockHashMerkleTree() - -> **new BlockHashMerkleTree**(`store`): [`BlockHashMerkleTree`](BlockHashMerkleTree.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:113 - -#### Parameters - -##### store - -[`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) - -#### Returns - -[`BlockHashMerkleTree`](BlockHashMerkleTree.md) - -#### Inherited from - -`createMerkleTree(40).constructor` - -## Properties - -### leafCount - -> `readonly` **leafCount**: `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:78 - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`leafCount`](../../common/interfaces/AbstractMerkleTree.md#leafcount) - -*** - -### store - -> **store**: [`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:77 - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`store`](../../common/interfaces/AbstractMerkleTree.md#store) - -*** - -### EMPTY\_ROOT - -> `static` **EMPTY\_ROOT**: `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:118 - -#### Inherited from - -`createMerkleTree(40).EMPTY_ROOT` - -*** - -### HEIGHT - -> `static` **HEIGHT**: `number` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:117 - -#### Inherited from - -`createMerkleTree(40).HEIGHT` - -*** - -### WITNESS - -> `static` **WITNESS**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:114 - -#### Type declaration - -##### dummy() - -> **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -###### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -#### Inherited from - -`createMerkleTree(40).WITNESS` - -## Accessors - -### leafCount - -#### Get Signature - -> **get** `static` **leafCount**(): `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:119 - -##### Returns - -`bigint` - -#### Inherited from - -`createMerkleTree(40).leafCount` - -## Methods - -### assertIndexRange() - -> **assertIndexRange**(`index`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:79 - -#### Parameters - -##### index - -`bigint` - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`assertIndexRange`](../../common/interfaces/AbstractMerkleTree.md#assertindexrange) - -*** - -### fill() - -> **fill**(`leaves`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:110 - -Fills all leaves of the tree. - -#### Parameters - -##### leaves - -`Field`[] - -Values to fill the leaves with. - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`fill`](../../common/interfaces/AbstractMerkleTree.md#fill) - -*** - -### getNode() - -> **getNode**(`level`, `index`): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:86 - -Returns a node which lives at a given index and level. - -#### Parameters - -##### level - -`number` - -Level of the node. - -##### index - -`bigint` - -Index of the node. - -#### Returns - -`Field` - -The data of the node. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getNode`](../../common/interfaces/AbstractMerkleTree.md#getnode) - -*** - -### getRoot() - -> **getRoot**(): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:91 - -Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). - -#### Returns - -`Field` - -The root of the Merkle Tree. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getRoot`](../../common/interfaces/AbstractMerkleTree.md#getroot) - -*** - -### getWitness() - -> **getWitness**(`index`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:105 - -Returns the witness (also known as -[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) -for the leaf at the given index. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -#### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -The witness that belongs to the leaf. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getWitness`](../../common/interfaces/AbstractMerkleTree.md#getwitness) - -*** - -### setLeaf() - -> **setLeaf**(`index`, `leaf`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:97 - -Sets the value of a leaf node at a given index to a given value. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -##### leaf - -`Field` - -New value. - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`setLeaf`](../../common/interfaces/AbstractMerkleTree.md#setleaf) diff --git a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md b/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md deleted file mode 100644 index bcec56a..0000000 --- a/src/pages/docs/reference/protocol/classes/BlockHashMerkleTreeWitness.md +++ /dev/null @@ -1,575 +0,0 @@ ---- -title: BlockHashMerkleTreeWitness ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockHashMerkleTreeWitness - -# Class: BlockHashMerkleTreeWitness - -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L5) - -## Extends - -- [`WITNESS`](VKTree.md#witness) - -## Constructors - -### new BlockHashMerkleTreeWitness() - -> **new BlockHashMerkleTreeWitness**(`value`): [`BlockHashMerkleTreeWitness`](BlockHashMerkleTreeWitness.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:4 - -#### Parameters - -##### value - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -[`BlockHashMerkleTreeWitness`](BlockHashMerkleTreeWitness.md) - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.constructor` - -## Properties - -### isLeft - -> **isLeft**: `Bool`[] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:9 - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.isLeft` - -*** - -### path - -> **path**: `Field`[] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:8 - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.path` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:11 - -#### Inherited from - -`BlockHashMerkleTree.WITNESS._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`void` - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.check` - -*** - -### dummy() - -> `static` **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:115 - -#### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.dummy` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:52 - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:19 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:45 - -#### Parameters - -##### x - -###### isLeft - -`boolean`[] - -###### path - -`string`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:31 - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:38 - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `boolean`[] - -##### path - -> **path**: `string`[] - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `boolean`[] - -##### path - -> **path**: `bigint`[] - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.toValue` - -## Methods - -### calculateIndex() - -> **calculateIndex**(): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:71 - -Calculates the index of the leaf node that belongs to this Witness. - -#### Returns - -`Field` - -Index of the leaf. - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.calculateIndex` - -*** - -### calculateRoot() - -> **calculateRoot**(`hash`): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:66 - -Calculates a root depending on the leaf value. - -#### Parameters - -##### hash - -`Field` - -#### Returns - -`Field` - -The calculated root. - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.calculateRoot` - -*** - -### checkMembership() - -> **checkMembership**(`root`, `key`, `value`): `Bool` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:72 - -#### Parameters - -##### root - -`Field` - -##### key - -`Field` - -##### value - -`Field` - -#### Returns - -`Bool` - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.checkMembership` - -*** - -### checkMembershipGetRoots() - -> **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:73 - -#### Parameters - -##### root - -`Field` - -##### key - -`Field` - -##### value - -`Field` - -#### Returns - -\[`Bool`, `Field`, `Field`\] - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.checkMembershipGetRoots` - -*** - -### height() - -> **height**(): `number` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:60 - -#### Returns - -`number` - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.height` - -*** - -### toShortenedEntries() - -> **toShortenedEntries**(): `string`[] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:74 - -#### Returns - -`string`[] - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.toShortenedEntries` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`BlockHashMerkleTree.WITNESS.sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md b/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md deleted file mode 100644 index 31fc41e..0000000 --- a/src/pages/docs/reference/protocol/classes/BlockHashTreeEntry.md +++ /dev/null @@ -1,433 +0,0 @@ ---- -title: BlockHashTreeEntry ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockHashTreeEntry - -# Class: BlockHashTreeEntry - -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L7) - -## Extends - -- `object` - -## Constructors - -### new BlockHashTreeEntry() - -> **new BlockHashTreeEntry**(`value`): [`BlockHashTreeEntry`](BlockHashTreeEntry.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### blockHash - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -#### Returns - -[`BlockHashTreeEntry`](BlockHashTreeEntry.md) - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).constructor` - -## Properties - -### blockHash - -> **blockHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L8) - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).blockHash` - -*** - -### closed - -> **closed**: `Bool` = `Bool` - -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L9) - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).closed` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### blockHash - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### blockHash - -> **blockHash**: `Field` = `Field` - -##### closed - -> **closed**: `Bool` = `Bool` - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### blockHash - -> **blockHash**: `Field` = `Field` - -##### closed - -> **closed**: `Bool` = `Bool` - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### blockHash - -`string` = `Field` - -###### closed - -`boolean` = `Bool` - -#### Returns - -`object` - -##### blockHash - -> **blockHash**: `Field` = `Field` - -##### closed - -> **closed**: `Bool` = `Bool` - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### blockHash - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### blockHash - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### blockHash - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### blockHash - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -#### Returns - -`object` - -##### blockHash - -> **blockHash**: `string` = `Field` - -##### closed - -> **closed**: `boolean` = `Bool` - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### blockHash - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -#### Returns - -`object` - -##### blockHash - -> **blockHash**: `bigint` = `Field` - -##### closed - -> **closed**: `boolean` = `Bool` - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).toValue` - -## Methods - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/BlockHashMerkleTree.ts#L13) - -#### Returns - -`Field` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ blockHash: Field, closed: Bool, // TODO We could add startingEternalTransactionsHash here to offer // a more trivial connection to the sequence state }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/BlockHeightHook.md b/src/pages/docs/reference/protocol/classes/BlockHeightHook.md deleted file mode 100644 index 69f1468..0000000 --- a/src/pages/docs/reference/protocol/classes/BlockHeightHook.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -title: BlockHeightHook ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockHeightHook - -# Class: BlockHeightHook - -Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/BlockHeightHook.ts#L4) - -## Extends - -- [`ProvableBlockHook`](ProvableBlockHook.md)\<`Record`\<`string`, `never`\>\> - -## Constructors - -### new BlockHeightHook() - -> **new BlockHeightHook**(): [`BlockHeightHook`](BlockHeightHook.md) - -#### Returns - -[`BlockHeightHook`](BlockHeightHook.md) - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`constructor`](ProvableBlockHook.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Record`\<`string`, `never`\> - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`currentConfig`](ProvableBlockHook.md#currentconfig) - -*** - -### name? - -> `optional` **name**: `string` - -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`name`](ProvableBlockHook.md#name) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`protocol`](ProvableBlockHook.md#protocol) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`areProofsEnabled`](ProvableBlockHook.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`config`](ProvableBlockHook.md#config) - -## Methods - -### afterBlock() - -> **afterBlock**(`networkState`): `Promise`\<[`NetworkState`](NetworkState.md)\> - -Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/BlockHeightHook.ts#L5) - -#### Parameters - -##### networkState - -[`NetworkState`](NetworkState.md) - -#### Returns - -`Promise`\<[`NetworkState`](NetworkState.md)\> - -#### Overrides - -[`ProvableBlockHook`](ProvableBlockHook.md).[`afterBlock`](ProvableBlockHook.md#afterblock) - -*** - -### beforeBlock() - -> **beforeBlock**(`networkState`): `Promise`\<[`NetworkState`](NetworkState.md)\> - -Defined in: [packages/protocol/src/hooks/BlockHeightHook.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/BlockHeightHook.ts#L14) - -#### Parameters - -##### networkState - -[`NetworkState`](NetworkState.md) - -#### Returns - -`Promise`\<[`NetworkState`](NetworkState.md)\> - -#### Overrides - -[`ProvableBlockHook`](ProvableBlockHook.md).[`beforeBlock`](ProvableBlockHook.md#beforeblock) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`create`](ProvableBlockHook.md#create) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`start`](ProvableBlockHook.md#start) diff --git a/src/pages/docs/reference/protocol/classes/BlockProver.md b/src/pages/docs/reference/protocol/classes/BlockProver.md deleted file mode 100644 index e31351e..0000000 --- a/src/pages/docs/reference/protocol/classes/BlockProver.md +++ /dev/null @@ -1,333 +0,0 @@ ---- -title: BlockProver ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProver - -# Class: BlockProver - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:907](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L907) - -BlockProver class, which aggregates a AppChainProof and -a StateTransitionProof into a single BlockProof, that can -then be merged to be committed to the base-layer contract - -## Extends - -- [`ProtocolModule`](ProtocolModule.md) - -## Implements - -- [`BlockProvable`](../interfaces/BlockProvable.md) -- [`CompilableModule`](../../common/interfaces/CompilableModule.md) - -## Constructors - -### new BlockProver() - -> **new BlockProver**(`stateTransitionProver`, `runtime`, `transactionHooks`, `blockHooks`, `verificationKeyService`): [`BlockProver`](BlockProver.md) - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:913](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L913) - -#### Parameters - -##### stateTransitionProver - -[`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> & [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) - -##### runtime - -[`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> & [`CompilableModule`](../../common/interfaces/CompilableModule.md) - -##### transactionHooks - -[`ProvableTransactionHook`](ProvableTransactionHook.md)\<`unknown`\>[] - -##### blockHooks - -[`ProvableBlockHook`](ProvableBlockHook.md)\<`unknown`\>[] - -##### verificationKeyService - -[`RuntimeVerificationKeyRootService`](RuntimeVerificationKeyRootService.md) - -#### Returns - -[`BlockProver`](BlockProver.md) - -#### Overrides - -[`ProtocolModule`](ProtocolModule.md).[`constructor`](ProtocolModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`currentConfig`](ProtocolModule.md#currentconfig) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`protocol`](ProtocolModule.md#protocol) - -*** - -### runtime - -> `readonly` **runtime**: [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> & [`CompilableModule`](../../common/interfaces/CompilableModule.md) - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:921](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L921) - -*** - -### stateTransitionProver - -> `readonly` **stateTransitionProver**: [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> & [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:915](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L915) - -*** - -### zkProgrammable - -> **zkProgrammable**: [`BlockProverProgrammable`](BlockProverProgrammable.md) - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:911](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L911) - -#### Implementation of - -[`BlockProvable`](../interfaces/BlockProvable.md).[`zkProgrammable`](../interfaces/BlockProvable.md#zkprogrammable) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`areProofsEnabled`](ProtocolModule.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`config`](ProtocolModule.md#config) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<`undefined` \| `Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:940](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L940) - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`undefined` \| `Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> - -#### Implementation of - -[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`create`](ProtocolModule.md#create) - -*** - -### merge() - -> **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:983](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L983) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](BlockProverPublicInput.md) - -##### proof1 - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -##### proof2 - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -#### Implementation of - -[`BlockProvable`](../interfaces/BlockProvable.md).[`merge`](../interfaces/BlockProvable.md#merge) - -*** - -### proveBlock() - -> **proveBlock**(`publicInput`, `networkState`, `blockWitness`, `transactionProof`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:967](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L967) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](BlockProverPublicInput.md) - -##### networkState - -[`NetworkState`](NetworkState.md) - -##### blockWitness - -[`BlockHashMerkleTreeWitness`](BlockHashMerkleTreeWitness.md) - -##### transactionProof - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -#### Implementation of - -[`BlockProvable`](../interfaces/BlockProvable.md).[`proveBlock`](../interfaces/BlockProvable.md#proveblock) - -*** - -### proveTransaction() - -> **proveTransaction**(`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:951](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L951) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](BlockProverPublicInput.md) - -##### stateProof - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -##### appProof - -[`DynamicRuntimeProof`](DynamicRuntimeProof.md) - -##### executionData - -[`BlockProverExecutionData`](BlockProverExecutionData.md) - -##### verificationKeyAttestation - -[`RuntimeVerificationKeyAttestation`](RuntimeVerificationKeyAttestation.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -#### Implementation of - -[`BlockProvable`](../interfaces/BlockProvable.md).[`proveTransaction`](../interfaces/BlockProvable.md#provetransaction) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`start`](ProtocolModule.md#start) diff --git a/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md b/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md deleted file mode 100644 index 840a338..0000000 --- a/src/pages/docs/reference/protocol/classes/BlockProverExecutionData.md +++ /dev/null @@ -1,643 +0,0 @@ ---- -title: BlockProverExecutionData ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverExecutionData - -# Class: BlockProverExecutionData - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L57) - -## Extends - -- `object` - -## Constructors - -### new BlockProverExecutionData() - -> **new BlockProverExecutionData**(`value`): [`BlockProverExecutionData`](BlockProverExecutionData.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -[`BlockProverExecutionData`](BlockProverExecutionData.md) - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).constructor` - -## Properties - -### networkState - -> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L60) - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).networkState` - -*** - -### signature - -> **signature**: `Signature` = `Signature` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L59) - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).signature` - -*** - -### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L58) - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).transaction` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### networkState - -> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` - -##### signature - -> **signature**: `Signature` = `Signature` - -##### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`, `aux`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 - -A function that returns an element of type `T` from the given provable and "auxiliary" data. - -This function is the reverse operation of calling [toFields](BlockProverExecutionData.md#tofields) and toAuxilary methods on an element of type `T`. - -#### Parameters - -##### fields - -`Field`[] - -an array of Field elements describing the provable data of the new `T` element. - -##### aux - -`any`[] - -an array of any type describing the "auxiliary" data of the new `T` element, optional. - -#### Returns - -`object` - -An element of type `T` generated from the given provable and "auxiliary" data. - -##### networkState - -> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` - -##### signature - -> **signature**: `Signature` = `Signature` - -##### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### networkState - -\{ `block`: \{ `height`: `string`; \}; `previous`: \{ `rootHash`: `string`; \}; \} = `NetworkState` - -###### networkState.block - -\{ `height`: `string`; \} = `CurrentBlock` - -###### networkState.block.height - -`string` = `UInt64` - -###### networkState.previous - -\{ `rootHash`: `string`; \} = `PreviousBlock` - -###### networkState.previous.rootHash - -`string` = `Field` - -###### signature - -`any` = `Signature` - -###### transaction - -\{ `argsHash`: `string`; `methodId`: `string`; `nonce`: \{ `isSome`: `boolean`; `value`: `any`; \}; `sender`: \{ `isSome`: `boolean`; `value`: `any`; \}; \} = `RuntimeTransaction` - -###### transaction.argsHash - -`string` = `Field` - -###### transaction.methodId - -`string` = `Field` - -###### transaction.nonce - -\{ `isSome`: `boolean`; `value`: `any`; \} = `UInt64Option` - -###### transaction.nonce.isSome - -`boolean` = `Bool` - -###### transaction.nonce.value - -`any` = `valueType` - -###### transaction.sender - -\{ `isSome`: `boolean`; `value`: `any`; \} = `PublicKeyOption` - -###### transaction.sender.isSome - -`boolean` = `Bool` - -###### transaction.sender.value - -`any` = `valueType` - -#### Returns - -`object` - -##### networkState - -> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` - -##### signature - -> **signature**: `Signature` = `Signature` - -##### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`object` - -##### networkState - -> **networkState**: `object` = `NetworkState` - -###### networkState.block - -> **networkState.block**: `object` = `CurrentBlock` - -###### networkState.block.height - -> **networkState.block.height**: `string` = `UInt64` - -###### networkState.previous - -> **networkState.previous**: `object` = `PreviousBlock` - -###### networkState.previous.rootHash - -> **networkState.previous.rootHash**: `string` = `Field` - -##### signature - -> **signature**: `any` = `Signature` - -##### transaction - -> **transaction**: `object` = `RuntimeTransaction` - -###### transaction.argsHash - -> **transaction.argsHash**: `string` = `Field` - -###### transaction.methodId - -> **transaction.methodId**: `string` = `Field` - -###### transaction.nonce - -> **transaction.nonce**: `object` = `UInt64Option` - -###### transaction.nonce.isSome - -> **transaction.nonce.isSome**: `boolean` = `Bool` - -###### transaction.nonce.value - -> **transaction.nonce.value**: `any` = `valueType` - -###### transaction.sender - -> **transaction.sender**: `object` = `PublicKeyOption` - -###### transaction.sender.isSome - -> **transaction.sender.isSome**: `boolean` = `Bool` - -###### transaction.sender.value - -> **transaction.sender.value**: `any` = `valueType` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`object` - -##### networkState - -> **networkState**: `object` = `NetworkState` - -###### networkState.block - -> **networkState.block**: `object` = `CurrentBlock` - -###### networkState.block.height - -> **networkState.block.height**: `bigint` = `UInt64` - -###### networkState.previous - -> **networkState.previous**: `object` = `PreviousBlock` - -###### networkState.previous.rootHash - -> **networkState.previous.rootHash**: `bigint` = `Field` - -##### signature - -> **signature**: `any` = `Signature` - -##### transaction - -> **transaction**: `object` = `RuntimeTransaction` - -###### transaction.argsHash - -> **transaction.argsHash**: `bigint` = `Field` - -###### transaction.methodId - -> **transaction.methodId**: `bigint` = `Field` - -###### transaction.nonce - -> **transaction.nonce**: `object` = `UInt64Option` - -###### transaction.nonce.isSome - -> **transaction.nonce.isSome**: `boolean` = `Bool` - -###### transaction.nonce.value - -> **transaction.nonce.value**: `any` = `valueType` - -###### transaction.sender - -> **transaction.sender**: `object` = `PublicKeyOption` - -###### transaction.sender.isSome - -> **transaction.sender.isSome**: `boolean` = `Bool` - -###### transaction.sender.value - -> **transaction.sender.value**: `any` = `valueType` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, networkState: NetworkState, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md b/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md deleted file mode 100644 index d1c004e..0000000 --- a/src/pages/docs/reference/protocol/classes/BlockProverProgrammable.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -title: BlockProverProgrammable ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverProgrammable - -# Class: BlockProverProgrammable - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:135](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L135) - -## Extends - -- [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`BlockProverPublicInput`](BlockProverPublicInput.md), [`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -## Constructors - -### new BlockProverProgrammable() - -> **new BlockProverProgrammable**(`prover`, `stateTransitionProver`, `runtime`, `transactionHooks`, `blockHooks`, `verificationKeyService`): [`BlockProverProgrammable`](BlockProverProgrammable.md) - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:139](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L139) - -#### Parameters - -##### prover - -[`BlockProver`](BlockProver.md) - -##### stateTransitionProver - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -##### runtime - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> - -##### transactionHooks - -[`ProvableTransactionHook`](ProvableTransactionHook.md)\<`unknown`\>[] - -##### blockHooks - -[`ProvableBlockHook`](ProvableBlockHook.md)\<`unknown`\>[] - -##### verificationKeyService - -[`MinimalVKTreeService`](../interfaces/MinimalVKTreeService.md) - -#### Returns - -[`BlockProverProgrammable`](BlockProverProgrammable.md) - -#### Overrides - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`constructor`](../../common/classes/ZkProgrammable.md#constructors) - -## Properties - -### name - -> **name**: `string` = `"BlockProver"` - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:153](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L153) - -*** - -### runtime - -> `readonly` **runtime**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`MethodPublicOutput`](MethodPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:145](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L145) - -*** - -### stateTransitionProver - -> `readonly` **stateTransitionProver**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:141](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L141) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:155](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L155) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Overrides - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`areProofsEnabled`](../../common/classes/ZkProgrammable.md#areproofsenabled) - -*** - -### zkProgram - -#### Get Signature - -> **get** **zkProgram**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] - -Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:34 - -##### Returns - -[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] - -#### Inherited from - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgram`](../../common/classes/ZkProgrammable.md#zkprogram) - -## Methods - -### applyTransaction() - -> **applyTransaction**(`state`, `stateTransitionProof`, `runtimeProof`, `executionData`, `verificationKey`): `Promise`\<[`BlockProverState`](../interfaces/BlockProverState.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:170](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L170) - -Applies and checks the two proofs and applies the corresponding state -changes to the given state - -#### Parameters - -##### state - -[`BlockProverState`](../interfaces/BlockProverState.md) - -The from-state of the BlockProver - -##### stateTransitionProof - -`Proof`\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -##### runtimeProof - -[`DynamicRuntimeProof`](DynamicRuntimeProof.md) - -##### executionData - -[`BlockProverExecutionData`](BlockProverExecutionData.md) - -##### verificationKey - -`VerificationKey` - -#### Returns - -`Promise`\<[`BlockProverState`](../interfaces/BlockProverState.md)\> - -The new BlockProver-state to be used as public output - -*** - -### assertProtocolTransitions() - -> **assertProtocolTransitions**(`stateTransitionProof`, `executionData`, `runtimeProof`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:264](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L264) - -#### Parameters - -##### stateTransitionProof - -`Proof`\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -##### executionData - -[`BlockProverExecutionData`](BlockProverExecutionData.md) - -##### runtimeProof - -`DynamicProof`\<`void`, [`MethodPublicOutput`](MethodPublicOutput.md)\> - -#### Returns - -`Promise`\<`void`\> - -*** - -### compile() - -> **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> - -Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:35 - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> - -#### Inherited from - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`compile`](../../common/classes/ZkProgrammable.md#compile) - -*** - -### merge() - -> **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:656](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L656) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](BlockProverPublicInput.md) - -##### proof1 - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -##### proof2 - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -*** - -### proveBlock() - -> **proveBlock**(`publicInput`, `networkState`, `blockWitness`, `transactionProof`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:482](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L482) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](BlockProverPublicInput.md) - -##### networkState - -[`NetworkState`](NetworkState.md) - -##### blockWitness - -[`BlockHashMerkleTreeWitness`](BlockHashMerkleTreeWitness.md) - -##### transactionProof - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -*** - -### proveTransaction() - -> **proveTransaction**(`publicInput`, `stateProof`, `runtimeProof`, `executionData`, `verificationKeyWitness`): `Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:406](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L406) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](BlockProverPublicInput.md) - -##### stateProof - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -##### runtimeProof - -[`DynamicRuntimeProof`](DynamicRuntimeProof.md) - -##### executionData - -[`BlockProverExecutionData`](BlockProverExecutionData.md) - -##### verificationKeyWitness - -[`RuntimeVerificationKeyAttestation`](RuntimeVerificationKeyAttestation.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -*** - -### zkProgramFactory() - -> **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`BlockProverPublicInput`](BlockProverPublicInput.md), [`BlockProverPublicOutput`](BlockProverPublicOutput.md)\>[] - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:798](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L798) - -Creates the BlockProver ZkProgram. -Recursive linking of proofs is done via the previously -injected StateTransitionProver and the required AppChainProof class - -#### Returns - -[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`BlockProverPublicInput`](BlockProverPublicInput.md), [`BlockProverPublicOutput`](BlockProverPublicOutput.md)\>[] - -#### Overrides - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgramFactory`](../../common/classes/ZkProgrammable.md#zkprogramfactory) diff --git a/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md b/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md deleted file mode 100644 index 4bcf8fa..0000000 --- a/src/pages/docs/reference/protocol/classes/BlockProverPublicInput.md +++ /dev/null @@ -1,741 +0,0 @@ ---- -title: BlockProverPublicInput ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverPublicInput - -# Class: BlockProverPublicInput - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L20) - -## Extends - -- `object` - -## Constructors - -### new BlockProverPublicInput() - -> **new BlockProverPublicInput**(`value`): [`BlockProverPublicInput`](BlockProverPublicInput.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -[`BlockProverPublicInput`](BlockProverPublicInput.md) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).constructor` - -## Properties - -### blockHashRoot - -> **blockHashRoot**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L24) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).blockHashRoot` - -*** - -### blockNumber - -> **blockNumber**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L27) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).blockNumber` - -*** - -### eternalTransactionsHash - -> **eternalTransactionsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L25) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).eternalTransactionsHash` - -*** - -### incomingMessagesHash - -> **incomingMessagesHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L26) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).incomingMessagesHash` - -*** - -### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L23) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).networkStateHash` - -*** - -### stateRoot - -> **stateRoot**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L22) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).stateRoot` - -*** - -### transactionsHash - -> **transactionsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L21) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).transactionsHash` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### blockHashRoot - -> **blockHashRoot**: `Field` = `Field` - -##### blockNumber - -> **blockNumber**: `Field` = `Field` - -##### eternalTransactionsHash - -> **eternalTransactionsHash**: `Field` = `Field` - -##### incomingMessagesHash - -> **incomingMessagesHash**: `Field` = `Field` - -##### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### transactionsHash - -> **transactionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### blockHashRoot - -> **blockHashRoot**: `Field` = `Field` - -##### blockNumber - -> **blockNumber**: `Field` = `Field` - -##### eternalTransactionsHash - -> **eternalTransactionsHash**: `Field` = `Field` - -##### incomingMessagesHash - -> **incomingMessagesHash**: `Field` = `Field` - -##### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### transactionsHash - -> **transactionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### blockHashRoot - -`string` = `Field` - -###### blockNumber - -`string` = `Field` - -###### eternalTransactionsHash - -`string` = `Field` - -###### incomingMessagesHash - -`string` = `Field` - -###### networkStateHash - -`string` = `Field` - -###### stateRoot - -`string` = `Field` - -###### transactionsHash - -`string` = `Field` - -#### Returns - -`object` - -##### blockHashRoot - -> **blockHashRoot**: `Field` = `Field` - -##### blockNumber - -> **blockNumber**: `Field` = `Field` - -##### eternalTransactionsHash - -> **eternalTransactionsHash**: `Field` = `Field` - -##### incomingMessagesHash - -> **incomingMessagesHash**: `Field` = `Field` - -##### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### transactionsHash - -> **transactionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### blockHashRoot - -> **blockHashRoot**: `string` = `Field` - -##### blockNumber - -> **blockNumber**: `string` = `Field` - -##### eternalTransactionsHash - -> **eternalTransactionsHash**: `string` = `Field` - -##### incomingMessagesHash - -> **incomingMessagesHash**: `string` = `Field` - -##### networkStateHash - -> **networkStateHash**: `string` = `Field` - -##### stateRoot - -> **stateRoot**: `string` = `Field` - -##### transactionsHash - -> **transactionsHash**: `string` = `Field` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### blockHashRoot - -> **blockHashRoot**: `bigint` = `Field` - -##### blockNumber - -> **blockNumber**: `bigint` = `Field` - -##### eternalTransactionsHash - -> **eternalTransactionsHash**: `bigint` = `Field` - -##### incomingMessagesHash - -> **incomingMessagesHash**: `bigint` = `Field` - -##### networkStateHash - -> **networkStateHash**: `bigint` = `Field` - -##### stateRoot - -> **stateRoot**: `bigint` = `Field` - -##### transactionsHash - -> **transactionsHash**: `bigint` = `Field` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, blockNumber: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md b/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md deleted file mode 100644 index fc6efe7..0000000 --- a/src/pages/docs/reference/protocol/classes/BlockProverPublicOutput.md +++ /dev/null @@ -1,827 +0,0 @@ ---- -title: BlockProverPublicOutput ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverPublicOutput - -# Class: BlockProverPublicOutput - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L30) - -## Extends - -- `object` - -## Constructors - -### new BlockProverPublicOutput() - -> **new BlockProverPublicOutput**(`value`): [`BlockProverPublicOutput`](BlockProverPublicOutput.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -[`BlockProverPublicOutput`](BlockProverPublicOutput.md) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).constructor` - -## Properties - -### blockHashRoot - -> **blockHashRoot**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L34) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).blockHashRoot` - -*** - -### blockNumber - -> **blockNumber**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L38) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).blockNumber` - -*** - -### closed - -> **closed**: `Bool` = `Bool` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L37) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).closed` - -*** - -### eternalTransactionsHash - -> **eternalTransactionsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L35) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).eternalTransactionsHash` - -*** - -### incomingMessagesHash - -> **incomingMessagesHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L36) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).incomingMessagesHash` - -*** - -### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L33) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).networkStateHash` - -*** - -### stateRoot - -> **stateRoot**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L32) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).stateRoot` - -*** - -### transactionsHash - -> **transactionsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L31) - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).transactionsHash` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### blockHashRoot - -> **blockHashRoot**: `Field` = `Field` - -##### blockNumber - -> **blockNumber**: `Field` = `Field` - -##### closed - -> **closed**: `Bool` = `Bool` - -##### eternalTransactionsHash - -> **eternalTransactionsHash**: `Field` = `Field` - -##### incomingMessagesHash - -> **incomingMessagesHash**: `Field` = `Field` - -##### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### transactionsHash - -> **transactionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### blockHashRoot - -> **blockHashRoot**: `Field` = `Field` - -##### blockNumber - -> **blockNumber**: `Field` = `Field` - -##### closed - -> **closed**: `Bool` = `Bool` - -##### eternalTransactionsHash - -> **eternalTransactionsHash**: `Field` = `Field` - -##### incomingMessagesHash - -> **incomingMessagesHash**: `Field` = `Field` - -##### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### transactionsHash - -> **transactionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### blockHashRoot - -`string` = `Field` - -###### blockNumber - -`string` = `Field` - -###### closed - -`boolean` = `Bool` - -###### eternalTransactionsHash - -`string` = `Field` - -###### incomingMessagesHash - -`string` = `Field` - -###### networkStateHash - -`string` = `Field` - -###### stateRoot - -`string` = `Field` - -###### transactionsHash - -`string` = `Field` - -#### Returns - -`object` - -##### blockHashRoot - -> **blockHashRoot**: `Field` = `Field` - -##### blockNumber - -> **blockNumber**: `Field` = `Field` - -##### closed - -> **closed**: `Bool` = `Bool` - -##### eternalTransactionsHash - -> **eternalTransactionsHash**: `Field` = `Field` - -##### incomingMessagesHash - -> **incomingMessagesHash**: `Field` = `Field` - -##### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### transactionsHash - -> **transactionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### blockHashRoot - -> **blockHashRoot**: `string` = `Field` - -##### blockNumber - -> **blockNumber**: `string` = `Field` - -##### closed - -> **closed**: `boolean` = `Bool` - -##### eternalTransactionsHash - -> **eternalTransactionsHash**: `string` = `Field` - -##### incomingMessagesHash - -> **incomingMessagesHash**: `string` = `Field` - -##### networkStateHash - -> **networkStateHash**: `string` = `Field` - -##### stateRoot - -> **stateRoot**: `string` = `Field` - -##### transactionsHash - -> **transactionsHash**: `string` = `Field` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### blockHashRoot - -`Field` = `Field` - -###### blockNumber - -`Field` = `Field` - -###### closed - -`Bool` = `Bool` - -###### eternalTransactionsHash - -`Field` = `Field` - -###### incomingMessagesHash - -`Field` = `Field` - -###### networkStateHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### transactionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### blockHashRoot - -> **blockHashRoot**: `bigint` = `Field` - -##### blockNumber - -> **blockNumber**: `bigint` = `Field` - -##### closed - -> **closed**: `boolean` = `Bool` - -##### eternalTransactionsHash - -> **eternalTransactionsHash**: `bigint` = `Field` - -##### incomingMessagesHash - -> **incomingMessagesHash**: `bigint` = `Field` - -##### networkStateHash - -> **networkStateHash**: `bigint` = `Field` - -##### stateRoot - -> **stateRoot**: `bigint` = `Field` - -##### transactionsHash - -> **transactionsHash**: `bigint` = `Field` - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).toValue` - -## Methods - -### equals() - -> **equals**(`input`, `closed`): `Bool` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L40) - -#### Parameters - -##### input - -[`BlockProverPublicInput`](BlockProverPublicInput.md) - -##### closed - -`Bool` - -#### Returns - -`Bool` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ transactionsHash: Field, stateRoot: Field, networkStateHash: Field, blockHashRoot: Field, eternalTransactionsHash: Field, incomingMessagesHash: Field, closed: Bool, blockNumber: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/BridgeContract.md b/src/pages/docs/reference/protocol/classes/BridgeContract.md deleted file mode 100644 index ae87938..0000000 --- a/src/pages/docs/reference/protocol/classes/BridgeContract.md +++ /dev/null @@ -1,1587 +0,0 @@ ---- -title: BridgeContract ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BridgeContract - -# Class: BridgeContract - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:211](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L211) - -## Extends - -- [`BridgeContractBase`](BridgeContractBase.md) - -## Implements - -- [`BridgeContractType`](../type-aliases/BridgeContractType.md) - -## Constructors - -### new BridgeContract() - -> **new BridgeContract**(`address`, `tokenId`?): [`BridgeContract`](BridgeContract.md) - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 - -#### Parameters - -##### address - -`PublicKey` - -##### tokenId? - -`Field` - -#### Returns - -[`BridgeContract`](BridgeContract.md) - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`constructor`](BridgeContractBase.md#constructors) - -## Properties - -### address - -> **address**: `PublicKey` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`address`](BridgeContractBase.md#address-1) - -*** - -### events - -> **events**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:315 - -A list of event types that can be emitted using this.emitEvent()`. - -#### Index Signature - -\[`key`: `string`\]: `FlexibleProvablePure`\<`any`\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`events`](BridgeContractBase.md#events) - -*** - -### outgoingMessageCursor - -> **outgoingMessageCursor**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:219](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L219) - -#### Implementation of - -`BridgeContractType.outgoingMessageCursor` - -#### Overrides - -[`BridgeContractBase`](BridgeContractBase.md).[`outgoingMessageCursor`](BridgeContractBase.md#outgoingmessagecursor) - -*** - -### sender - -> **sender**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 - -#### self - -> **self**: `SmartContract` - -#### ~~getAndRequireSignature()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key. - -#### getAndRequireSignatureV2() - -Return a public key that is forced to sign this transaction. - -Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created -the transaction controls the private key associated with the returned public key. - -##### Returns - -`PublicKey` - -#### ~~getUnconstrained()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getUnconstrainedV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key, -which would cause an account update with that public key to not be included. - -#### getUnconstrainedV2() - -The public key of the current transaction's sender account. - -Throws an error if not inside a transaction, or the sender wasn't passed in. - -**Warning**: The fact that this public key equals the current sender is not part of the proof. -A malicious prover could use any other public key without affecting the validity of the proof. - -Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. - -##### Returns - -`PublicKey` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`sender`](BridgeContractBase.md#sender) - -*** - -### settlementContractAddress - -> **settlementContractAddress**: `State`\<`PublicKey`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:215](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L215) - -#### Overrides - -[`BridgeContractBase`](BridgeContractBase.md).[`settlementContractAddress`](BridgeContractBase.md#settlementcontractaddress) - -*** - -### stateRoot - -> **stateRoot**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:217](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L217) - -#### Implementation of - -`BridgeContractType.stateRoot` - -#### Overrides - -[`BridgeContractBase`](BridgeContractBase.md).[`stateRoot`](BridgeContractBase.md#stateroot) - -*** - -### tokenId - -> **tokenId**: `Field` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`tokenId`](BridgeContractBase.md#tokenid-1) - -*** - -### \_maxProofsVerified? - -> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`_maxProofsVerified`](BridgeContractBase.md#_maxproofsverified) - -*** - -### \_methodMetadata? - -> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`_methodMetadata`](BridgeContractBase.md#_methodmetadata) - -*** - -### \_methods? - -> `static` `optional` **\_methods**: `MethodInterface`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`_methods`](BridgeContractBase.md#_methods) - -*** - -### \_provers? - -> `static` `optional` **\_provers**: `Prover`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`_provers`](BridgeContractBase.md#_provers) - -*** - -### \_verificationKey? - -> `static` `optional` **\_verificationKey**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 - -#### data - -> **data**: `string` - -#### hash - -> **hash**: `Field` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`_verificationKey`](BridgeContractBase.md#_verificationkey) - -*** - -### args - -> `static` **args**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) - -#### SettlementContract - -> **SettlementContract**: `undefined` \| [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> & *typeof* `SmartContract` - -#### withdrawalStatePath - -> **withdrawalStatePath**: \[`string`, `string`\] - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`args`](BridgeContractBase.md#args) - -*** - -### MAX\_ACCOUNT\_UPDATES - -> `static` **MAX\_ACCOUNT\_UPDATES**: `number` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:94 - -The maximum number of account updates using the token in a single -transaction that this contract supports. - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`MAX_ACCOUNT_UPDATES`](BridgeContractBase.md#max_account_updates) - -## Accessors - -### account - -#### Get Signature - -> **get** **account**(): `Account` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 - -Current account of the SmartContract. - -##### Returns - -`Account` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`account`](BridgeContractBase.md#account) - -*** - -### balance - -#### Get Signature - -> **get** **balance**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 - -Balance of this SmartContract. - -##### Returns - -`object` - -###### addInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -###### subInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`balance`](BridgeContractBase.md#balance) - -*** - -### currentSlot - -#### Get Signature - -> **get** **currentSlot**(): `CurrentSlot` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 - -Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value -at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) -or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) - -##### Returns - -`CurrentSlot` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`currentSlot`](BridgeContractBase.md#currentslot) - -*** - -### internal - -#### Get Signature - -> **get** **internal**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:47 - -Helper methods to use from within a token contract. - -##### Returns - -`object` - -###### burn() - -###### Parameters - -###### \_\_namedParameters - -###### address - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### Returns - -`AccountUpdate` - -###### mint() - -###### Parameters - -###### \_\_namedParameters - -###### address - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### Returns - -`AccountUpdate` - -###### send() - -###### Parameters - -###### \_\_namedParameters - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### from - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### to - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### Returns - -`AccountUpdate` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`internal`](BridgeContractBase.md#internal) - -*** - -### network - -#### Get Signature - -> **get** **network**(): `Network` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 - -Current network state of the SmartContract. - -##### Returns - -`Network` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`network`](BridgeContractBase.md#network) - -*** - -### self - -#### Get Signature - -> **get** **self**(): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 - -Returns the current AccountUpdate associated to this SmartContract. - -##### Returns - -`AccountUpdate` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`self`](BridgeContractBase.md#self) - -## Methods - -### approve() - -> **approve**(`update`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 - -Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, -which allows you to read and use its content in a proof, make assertions about it, and modify it. - -```ts -`@method` myApprovingMethod(update: AccountUpdate) { - this.approve(update); - - // read balance on the account (for example) - let balance = update.account.balance.getAndRequireEquals(); -} -``` - -Under the hood, "approving" just means that the account update is made a child of the zkApp in the -tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, -the entire tree will become a subtree of the zkApp's account update. - -Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update -at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally -excluding important information from the public input. - -#### Parameters - -##### update - -`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` - -#### Returns - -`void` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`approve`](BridgeContractBase.md#approve) - -*** - -### approveAccountUpdate() - -> **approveAccountUpdate**(`accountUpdate`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:78 - -Approve a single account update (with arbitrarily many children). - -#### Parameters - -##### accountUpdate - -`AccountUpdate` | `AccountUpdateTree` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`approveAccountUpdate`](BridgeContractBase.md#approveaccountupdate) - -*** - -### approveAccountUpdates() - -> **approveAccountUpdates**(`accountUpdates`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:82 - -Approve a list of account updates (with arbitrarily many children). - -#### Parameters - -##### accountUpdates - -(`AccountUpdate` \| `AccountUpdateTree`)[] - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`approveAccountUpdates`](BridgeContractBase.md#approveaccountupdates) - -*** - -### approveBase() - -> **approveBase**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`approveBase`](BridgeContractBase.md#approvebase) - -*** - -### checkZeroBalanceChange() - -> **checkZeroBalanceChange**(`updates`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:74 - -Use `forEachUpdate()` to prove that the total balance change of child account updates is zero. - -This is provided out of the box as it is both a good example, and probably the most common implementation, of `approveBase()`. - -#### Parameters - -##### updates - -`AccountUpdateForest` - -#### Returns - -`void` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`checkZeroBalanceChange`](BridgeContractBase.md#checkzerobalancechange) - -*** - -### deploy() - -> **deploy**(`args`?): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:39 - -Deploys a TokenContract. - -In addition to base smart contract deployment, this adds two steps: -- set the `access` permission to `proofOrSignature()`, to prevent against unauthorized token operations - - not doing this would imply that anyone can bypass token contract authorization and simply mint themselves tokens -- require the zkapp account to be new, using the `isNew` precondition. - this guarantees that the access permission is set from the very start of the existence of this account. - creating the zkapp account before deployment would otherwise be a security vulnerability that is too easy to introduce. - -Note that because of the `isNew` precondition, the zkapp account must not be created prior to calling `deploy()`. - -If the contract needs to be re-deployed, you can switch off this behaviour by overriding the `isNew` precondition: -```ts -async deploy() { - await super.deploy(); - // DON'T DO THIS ON THE INITIAL DEPLOYMENT! - this.account.isNew.requireNothing(); -} -``` - -#### Parameters - -##### args? - -`DeployArgs` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`deploy`](BridgeContractBase.md#deploy) - -*** - -### deployProvable() - -> **deployProvable**(`verificationKey`, `signedSettlement`, `permissions`, `settlementContractAddress`): `Promise`\<`AccountUpdate`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) - -Function to deploy the bridging contract in a provable way, so that it can be -a provable process initiated by the settlement contract with a baked-in vk - -#### Parameters - -##### verificationKey - -`undefined` | `VerificationKey` - -##### signedSettlement - -`boolean` - -##### permissions - -`Permissions` - -##### settlementContractAddress - -`PublicKey` - -#### Returns - -`Promise`\<`AccountUpdate`\> - -Creates and returns an account update deploying the bridge contract - -#### Implementation of - -`BridgeContractType.deployProvable` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`deployProvable`](BridgeContractBase.md#deployprovable) - -*** - -### deriveTokenId() - -> **deriveTokenId**(): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:43 - -Returns the `tokenId` of the token managed by this contract. - -#### Returns - -`Field` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`deriveTokenId`](BridgeContractBase.md#derivetokenid) - -*** - -### emitEvent() - -> **emitEvent**\<`K`\>(`type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 - -Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `string` \| `number` - -#### Parameters - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`emitEvent`](BridgeContractBase.md#emitevent) - -*** - -### emitEventIf() - -> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 - -Conditionally emits an event. - -Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `string` \| `number` - -#### Parameters - -##### condition - -`Bool` - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`emitEventIf`](BridgeContractBase.md#emiteventif) - -*** - -### fetchEvents() - -> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 - -Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. - -#### Parameters - -##### start? - -`UInt32` - -The start height of the events to fetch. - -##### end? - -`UInt32` - -The end height of the events to fetch. If not provided, fetches events up to the latest height. - -#### Returns - -`Promise`\<`object`[]\> - -A promise that resolves to an array of objects, each containing the event type and event data for the specified range. - -#### Async - -#### Throws - -If there is an error fetching events from the Mina network. - -#### Example - -```ts -const startHeight = UInt32.from(1000); -const endHeight = UInt32.from(2000); -const events = await myZkapp.fetchEvents(startHeight, endHeight); -console.log(events); -``` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`fetchEvents`](BridgeContractBase.md#fetchevents) - -*** - -### forEachUpdate() - -> **forEachUpdate**(`updates`, `callback`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:68 - -Iterate through the account updates in `updates` and apply `callback` to each. - -This method is provable and is suitable as a base for implementing `approveUpdates()`. - -#### Parameters - -##### updates - -`AccountUpdateForest` - -##### callback - -(`update`, `usesToken`) => `void` - -#### Returns - -`void` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`forEachUpdate`](BridgeContractBase.md#foreachupdate) - -*** - -### init() - -> **init**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 - -`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. -This method can be overridden as follows -``` -class MyContract extends SmartContract { - init() { - super.init(); - this.account.permissions.set(...); - this.x.set(Field(1)); - } -} -``` - -#### Returns - -`void` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`init`](BridgeContractBase.md#init) - -*** - -### newSelf() - -> **newSelf**(`methodName`?): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 - -Same as `SmartContract.self` but explicitly creates a new AccountUpdate. - -#### Parameters - -##### methodName? - -`string` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`newSelf`](BridgeContractBase.md#newself) - -*** - -### redeem() - -> **redeem**(`additionUpdate`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:234](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L234) - -#### Parameters - -##### additionUpdate - -`AccountUpdate` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -`BridgeContractType.redeem` - -*** - -### redeemBase() - -> `protected` **redeemBase**(`additionUpdate`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) - -#### Parameters - -##### additionUpdate - -`AccountUpdate` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`redeemBase`](BridgeContractBase.md#redeembase) - -*** - -### requireSignature() - -> **requireSignature**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 - -Use this command if the account update created by this SmartContract should be signed by the account owner, -instead of authorized with a proof. - -Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. - -If you only want to avoid creating proofs for quicker testing, we advise you to -use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting -`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, -with the only difference being that quick mock proofs are filled in instead of real proofs. - -#### Returns - -`void` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`requireSignature`](BridgeContractBase.md#requiresignature) - -*** - -### rollupOutgoingMessages() - -> **rollupOutgoingMessages**(`batch`): `Promise`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:227](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L227) - -#### Parameters - -##### batch - -[`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) - -#### Returns - -`Promise`\<`Field`\> - -#### Implementation of - -`BridgeContractType.rollupOutgoingMessages` - -*** - -### rollupOutgoingMessagesBase() - -> **rollupOutgoingMessagesBase**(`batch`): `Promise`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) - -#### Parameters - -##### batch - -[`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) - -#### Returns - -`Promise`\<`Field`\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`rollupOutgoingMessagesBase`](BridgeContractBase.md#rollupoutgoingmessagesbase) - -*** - -### send() - -> **send**(`args`): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 - -#### Parameters - -##### args - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### to - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`send`](BridgeContractBase.md#send-2) - -*** - -### skipAuthorization() - -> **skipAuthorization**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 - -Use this command if the account update created by this SmartContract should have no authorization on it, -instead of being authorized with a proof. - -WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look -at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the -authorization flow. - -#### Returns - -`void` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`skipAuthorization`](BridgeContractBase.md#skipauthorization) - -*** - -### transfer() - -> **transfer**(`from`, `to`, `amount`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:86 - -Transfer `amount` of tokens from `from` to `to`. - -#### Parameters - -##### from - -`PublicKey` | `AccountUpdate` - -##### to - -`PublicKey` | `AccountUpdate` - -##### amount - -`number` | `bigint` | `UInt64` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`transfer`](BridgeContractBase.md#transfer) - -*** - -### updateStateRoot() - -> **updateStateRoot**(`root`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:222](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L222) - -#### Parameters - -##### root - -`Field` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -`BridgeContractType.updateStateRoot` - -*** - -### updateStateRootBase() - -> **updateStateRootBase**(`root`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) - -#### Parameters - -##### root - -`Field` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`updateStateRootBase`](BridgeContractBase.md#updatestaterootbase) - -*** - -### analyzeMethods() - -> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 - -This function is run internally before compiling a smart contract, to collect metadata about what each of your -smart contract methods does. - -For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, -so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. - -`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), -which is a good indicator for circuit size and the time it will take to create proofs. -To inspect the created circuit in detail, you can look at the returned `gates`. - -Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. - -#### Parameters - -##### \_\_namedParameters? - -###### printSummary - -`boolean` - -#### Returns - -`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -an object, keyed by method name, each entry containing: - - `rows` the size of the constraint system created by this method - - `digest` a digest of the method circuit - - `actions` the number of actions the method dispatches - - `gates` the constraint system, represented as an array of gates - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`analyzeMethods`](BridgeContractBase.md#analyzemethods) - -*** - -### compile() - -> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 - -Compile your smart contract. - -This generates both the prover functions, needed to create proofs for running `@method`s, -and the verification key, needed to deploy your zkApp. - -Although provers and verification key are returned by this method, they are also cached internally and used when needed, -so you don't actually have to use the return value of this function. - -Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to -create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps -it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, -up to several minutes if your circuit is large or your hardware is not optimal for these operations. - -#### Parameters - -##### \_\_namedParameters? - -###### cache - -`Cache` - -###### forceRecompile - -`boolean` - -#### Returns - -`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`compile`](BridgeContractBase.md#compile) - -*** - -### digest() - -> `static` **digest**(): `Promise`\<`string`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 - -Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. -This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or -a cached verification key can be used. - -#### Returns - -`Promise`\<`string`\> - -the digest, as a hex string - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`digest`](BridgeContractBase.md#digest) - -*** - -### Proof() - -> `static` **Proof**(): (`__namedParameters`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 - -Returns a Proof type that belongs to this SmartContract. - -#### Returns - -`Function` - -##### Parameters - -###### \_\_namedParameters - -###### maxProofsVerified - -`0` \| `1` \| `2` - -###### proof - -`unknown` - -###### publicInput - -`ZkappPublicInput` - -###### publicOutput - -`undefined` - -##### Returns - -`object` - -###### maxProofsVerified - -> **maxProofsVerified**: `0` \| `1` \| `2` - -###### proof - -> **proof**: `unknown` - -###### publicInput - -> **publicInput**: `ZkappPublicInput` - -###### publicOutput - -> **publicOutput**: `undefined` - -###### shouldVerify - -> **shouldVerify**: `Bool` - -###### toJSON() - -###### Returns - -`JsonProof` - -###### verify() - -###### Returns - -`void` - -###### verifyIf() - -###### Parameters - -###### condition - -`Bool` - -###### Returns - -`void` - -##### publicInputType - -> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` - -###### Type declaration - -###### fromFields() - -> **fromFields**: (`fields`) => `object` - -###### Parameters - -###### fields - -`Field`[] - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### Type declaration - -###### empty() - -> **empty**: () => `object` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### fromJSON() - -> **fromJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`string` - -###### calls - -`string` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### toInput() - -> **toInput**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### fields? - -> `optional` **fields**: `Field`[] - -###### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -###### toJSON() - -> **toJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `string` - -###### calls - -> **calls**: `string` - -##### publicOutputType - -> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> - -##### tag() - -> **tag**: () => *typeof* `SmartContract` - -###### Returns - -*typeof* `SmartContract` - -##### dummy() - -###### Type Parameters - -• **Input** - -• **OutPut** - -###### Parameters - -###### publicInput - -`Input` - -###### publicOutput - -`OutPut` - -###### maxProofsVerified - -`0` | `1` | `2` - -###### domainLog2? - -`number` - -###### Returns - -`Promise`\<`Proof`\<`Input`, `OutPut`\>\> - -##### fromJSON() - -###### Type Parameters - -• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` - -###### Parameters - -###### this - -`S` - -###### \_\_namedParameters - -`JsonProof` - -###### Returns - -`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`Proof`](BridgeContractBase.md#proof) - -*** - -### runOutsideCircuit() - -> `static` **runOutsideCircuit**(`run`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 - -#### Parameters - -##### run - -() => `void` - -#### Returns - -`void` - -#### Inherited from - -[`BridgeContractBase`](BridgeContractBase.md).[`runOutsideCircuit`](BridgeContractBase.md#runoutsidecircuit) diff --git a/src/pages/docs/reference/protocol/classes/BridgeContractBase.md b/src/pages/docs/reference/protocol/classes/BridgeContractBase.md deleted file mode 100644 index c9b90e8..0000000 --- a/src/pages/docs/reference/protocol/classes/BridgeContractBase.md +++ /dev/null @@ -1,1477 +0,0 @@ ---- -title: BridgeContractBase ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BridgeContractBase - -# Class: `abstract` BridgeContractBase - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L54) - -## Extends - -- `TokenContractV2` - -## Extended by - -- [`BridgeContract`](BridgeContract.md) - -## Constructors - -### new BridgeContractBase() - -> **new BridgeContractBase**(`address`, `tokenId`?): [`BridgeContractBase`](BridgeContractBase.md) - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 - -#### Parameters - -##### address - -`PublicKey` - -##### tokenId? - -`Field` - -#### Returns - -[`BridgeContractBase`](BridgeContractBase.md) - -#### Inherited from - -`TokenContractV2.constructor` - -## Properties - -### address - -> **address**: `PublicKey` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 - -#### Inherited from - -`TokenContractV2.address` - -*** - -### events - -> **events**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:315 - -A list of event types that can be emitted using this.emitEvent()`. - -#### Index Signature - -\[`key`: `string`\]: `FlexibleProvablePure`\<`any`\> - -#### Inherited from - -`TokenContractV2.events` - -*** - -### outgoingMessageCursor - -> `abstract` **outgoingMessageCursor**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L66) - -*** - -### sender - -> **sender**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 - -#### self - -> **self**: `SmartContract` - -#### ~~getAndRequireSignature()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key. - -#### getAndRequireSignatureV2() - -Return a public key that is forced to sign this transaction. - -Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created -the transaction controls the private key associated with the returned public key. - -##### Returns - -`PublicKey` - -#### ~~getUnconstrained()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getUnconstrainedV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key, -which would cause an account update with that public key to not be included. - -#### getUnconstrainedV2() - -The public key of the current transaction's sender account. - -Throws an error if not inside a transaction, or the sender wasn't passed in. - -**Warning**: The fact that this public key equals the current sender is not part of the proof. -A malicious prover could use any other public key without affecting the validity of the proof. - -Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. - -##### Returns - -`PublicKey` - -#### Inherited from - -`TokenContractV2.sender` - -*** - -### settlementContractAddress - -> `abstract` **settlementContractAddress**: `State`\<`PublicKey`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L62) - -*** - -### stateRoot - -> `abstract` **stateRoot**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L64) - -*** - -### tokenId - -> **tokenId**: `Field` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 - -#### Inherited from - -`TokenContractV2.tokenId` - -*** - -### \_maxProofsVerified? - -> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 - -#### Inherited from - -`TokenContractV2._maxProofsVerified` - -*** - -### \_methodMetadata? - -> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 - -#### Inherited from - -`TokenContractV2._methodMetadata` - -*** - -### \_methods? - -> `static` `optional` **\_methods**: `MethodInterface`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 - -#### Inherited from - -`TokenContractV2._methods` - -*** - -### \_provers? - -> `static` `optional` **\_provers**: `Prover`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 - -#### Inherited from - -`TokenContractV2._provers` - -*** - -### \_verificationKey? - -> `static` `optional` **\_verificationKey**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 - -#### data - -> **data**: `string` - -#### hash - -> **hash**: `Field` - -#### Inherited from - -`TokenContractV2._verificationKey` - -*** - -### args - -> `static` **args**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L55) - -#### SettlementContract - -> **SettlementContract**: `undefined` \| [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> & *typeof* `SmartContract` - -#### withdrawalStatePath - -> **withdrawalStatePath**: \[`string`, `string`\] - -*** - -### MAX\_ACCOUNT\_UPDATES - -> `static` **MAX\_ACCOUNT\_UPDATES**: `number` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:94 - -The maximum number of account updates using the token in a single -transaction that this contract supports. - -#### Inherited from - -`TokenContractV2.MAX_ACCOUNT_UPDATES` - -## Accessors - -### account - -#### Get Signature - -> **get** **account**(): `Account` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 - -Current account of the SmartContract. - -##### Returns - -`Account` - -#### Inherited from - -`TokenContractV2.account` - -*** - -### balance - -#### Get Signature - -> **get** **balance**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 - -Balance of this SmartContract. - -##### Returns - -`object` - -###### addInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -###### subInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -#### Inherited from - -`TokenContractV2.balance` - -*** - -### currentSlot - -#### Get Signature - -> **get** **currentSlot**(): `CurrentSlot` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 - -Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value -at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) -or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) - -##### Returns - -`CurrentSlot` - -#### Inherited from - -`TokenContractV2.currentSlot` - -*** - -### internal - -#### Get Signature - -> **get** **internal**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:47 - -Helper methods to use from within a token contract. - -##### Returns - -`object` - -###### burn() - -###### Parameters - -###### \_\_namedParameters - -###### address - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### Returns - -`AccountUpdate` - -###### mint() - -###### Parameters - -###### \_\_namedParameters - -###### address - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### Returns - -`AccountUpdate` - -###### send() - -###### Parameters - -###### \_\_namedParameters - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### from - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### to - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### Returns - -`AccountUpdate` - -#### Inherited from - -`TokenContractV2.internal` - -*** - -### network - -#### Get Signature - -> **get** **network**(): `Network` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 - -Current network state of the SmartContract. - -##### Returns - -`Network` - -#### Inherited from - -`TokenContractV2.network` - -*** - -### self - -#### Get Signature - -> **get** **self**(): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 - -Returns the current AccountUpdate associated to this SmartContract. - -##### Returns - -`AccountUpdate` - -#### Inherited from - -`TokenContractV2.self` - -## Methods - -### approve() - -> **approve**(`update`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 - -Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, -which allows you to read and use its content in a proof, make assertions about it, and modify it. - -```ts -`@method` myApprovingMethod(update: AccountUpdate) { - this.approve(update); - - // read balance on the account (for example) - let balance = update.account.balance.getAndRequireEquals(); -} -``` - -Under the hood, "approving" just means that the account update is made a child of the zkApp in the -tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, -the entire tree will become a subtree of the zkApp's account update. - -Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update -at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally -excluding important information from the public input. - -#### Parameters - -##### update - -`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.approve` - -*** - -### approveAccountUpdate() - -> **approveAccountUpdate**(`accountUpdate`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:78 - -Approve a single account update (with arbitrarily many children). - -#### Parameters - -##### accountUpdate - -`AccountUpdate` | `AccountUpdateTree` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TokenContractV2.approveAccountUpdate` - -*** - -### approveAccountUpdates() - -> **approveAccountUpdates**(`accountUpdates`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:82 - -Approve a list of account updates (with arbitrarily many children). - -#### Parameters - -##### accountUpdates - -(`AccountUpdate` \| `AccountUpdateTree`)[] - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TokenContractV2.approveAccountUpdates` - -*** - -### approveBase() - -> **approveBase**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:110](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L110) - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -`TokenContractV2.approveBase` - -*** - -### checkZeroBalanceChange() - -> **checkZeroBalanceChange**(`updates`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:74 - -Use `forEachUpdate()` to prove that the total balance change of child account updates is zero. - -This is provided out of the box as it is both a good example, and probably the most common implementation, of `approveBase()`. - -#### Parameters - -##### updates - -`AccountUpdateForest` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.checkZeroBalanceChange` - -*** - -### deploy() - -> **deploy**(`args`?): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:39 - -Deploys a TokenContract. - -In addition to base smart contract deployment, this adds two steps: -- set the `access` permission to `proofOrSignature()`, to prevent against unauthorized token operations - - not doing this would imply that anyone can bypass token contract authorization and simply mint themselves tokens -- require the zkapp account to be new, using the `isNew` precondition. - this guarantees that the access permission is set from the very start of the existence of this account. - creating the zkapp account before deployment would otherwise be a security vulnerability that is too easy to introduce. - -Note that because of the `isNew` precondition, the zkapp account must not be created prior to calling `deploy()`. - -If the contract needs to be re-deployed, you can switch off this behaviour by overriding the `isNew` precondition: -```ts -async deploy() { - await super.deploy(); - // DON'T DO THIS ON THE INITIAL DEPLOYMENT! - this.account.isNew.requireNothing(); -} -``` - -#### Parameters - -##### args? - -`DeployArgs` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TokenContractV2.deploy` - -*** - -### deployProvable() - -> **deployProvable**(`verificationKey`, `signedSettlement`, `permissions`, `settlementContractAddress`): `Promise`\<`AccountUpdate`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L74) - -Function to deploy the bridging contract in a provable way, so that it can be -a provable process initiated by the settlement contract with a baked-in vk - -#### Parameters - -##### verificationKey - -`undefined` | `VerificationKey` - -##### signedSettlement - -`boolean` - -##### permissions - -`Permissions` - -##### settlementContractAddress - -`PublicKey` - -#### Returns - -`Promise`\<`AccountUpdate`\> - -Creates and returns an account update deploying the bridge contract - -*** - -### deriveTokenId() - -> **deriveTokenId**(): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:43 - -Returns the `tokenId` of the token managed by this contract. - -#### Returns - -`Field` - -#### Inherited from - -`TokenContractV2.deriveTokenId` - -*** - -### emitEvent() - -> **emitEvent**\<`K`\>(`type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 - -Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `string` \| `number` - -#### Parameters - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.emitEvent` - -*** - -### emitEventIf() - -> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 - -Conditionally emits an event. - -Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `string` \| `number` - -#### Parameters - -##### condition - -`Bool` - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.emitEventIf` - -*** - -### fetchEvents() - -> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 - -Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. - -#### Parameters - -##### start? - -`UInt32` - -The start height of the events to fetch. - -##### end? - -`UInt32` - -The end height of the events to fetch. If not provided, fetches events up to the latest height. - -#### Returns - -`Promise`\<`object`[]\> - -A promise that resolves to an array of objects, each containing the event type and event data for the specified range. - -#### Async - -#### Throws - -If there is an error fetching events from the Mina network. - -#### Example - -```ts -const startHeight = UInt32.from(1000); -const endHeight = UInt32.from(2000); -const events = await myZkapp.fetchEvents(startHeight, endHeight); -console.log(events); -``` - -#### Inherited from - -`TokenContractV2.fetchEvents` - -*** - -### forEachUpdate() - -> **forEachUpdate**(`updates`, `callback`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:68 - -Iterate through the account updates in `updates` and apply `callback` to each. - -This method is provable and is suitable as a base for implementing `approveUpdates()`. - -#### Parameters - -##### updates - -`AccountUpdateForest` - -##### callback - -(`update`, `usesToken`) => `void` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.forEachUpdate` - -*** - -### init() - -> **init**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 - -`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. -This method can be overridden as follows -``` -class MyContract extends SmartContract { - init() { - super.init(); - this.account.permissions.set(...); - this.x.set(Field(1)); - } -} -``` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.init` - -*** - -### newSelf() - -> **newSelf**(`methodName`?): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 - -Same as `SmartContract.self` but explicitly creates a new AccountUpdate. - -#### Parameters - -##### methodName? - -`string` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -`TokenContractV2.newSelf` - -*** - -### redeemBase() - -> `protected` **redeemBase**(`additionUpdate`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L183) - -#### Parameters - -##### additionUpdate - -`AccountUpdate` - -#### Returns - -`Promise`\<`void`\> - -*** - -### requireSignature() - -> **requireSignature**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 - -Use this command if the account update created by this SmartContract should be signed by the account owner, -instead of authorized with a proof. - -Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. - -If you only want to avoid creating proofs for quicker testing, we advise you to -use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting -`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, -with the only difference being that quick mock proofs are filled in instead of real proofs. - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.requireSignature` - -*** - -### rollupOutgoingMessagesBase() - -> **rollupOutgoingMessagesBase**(`batch`): `Promise`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L132) - -#### Parameters - -##### batch - -[`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) - -#### Returns - -`Promise`\<`Field`\> - -*** - -### send() - -> **send**(`args`): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 - -#### Parameters - -##### args - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### to - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -`TokenContractV2.send` - -*** - -### skipAuthorization() - -> **skipAuthorization**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 - -Use this command if the account update created by this SmartContract should have no authorization on it, -instead of being authorized with a proof. - -WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look -at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the -authorization flow. - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.skipAuthorization` - -*** - -### transfer() - -> **transfer**(`from`, `to`, `amount`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:86 - -Transfer `amount` of tokens from `from` to `to`. - -#### Parameters - -##### from - -`PublicKey` | `AccountUpdate` - -##### to - -`PublicKey` | `AccountUpdate` - -##### amount - -`number` | `bigint` | `UInt64` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TokenContractV2.transfer` - -*** - -### updateStateRootBase() - -> **updateStateRootBase**(`root`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L114) - -#### Parameters - -##### root - -`Field` - -#### Returns - -`Promise`\<`void`\> - -*** - -### analyzeMethods() - -> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 - -This function is run internally before compiling a smart contract, to collect metadata about what each of your -smart contract methods does. - -For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, -so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. - -`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), -which is a good indicator for circuit size and the time it will take to create proofs. -To inspect the created circuit in detail, you can look at the returned `gates`. - -Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. - -#### Parameters - -##### \_\_namedParameters? - -###### printSummary - -`boolean` - -#### Returns - -`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -an object, keyed by method name, each entry containing: - - `rows` the size of the constraint system created by this method - - `digest` a digest of the method circuit - - `actions` the number of actions the method dispatches - - `gates` the constraint system, represented as an array of gates - -#### Inherited from - -`TokenContractV2.analyzeMethods` - -*** - -### compile() - -> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 - -Compile your smart contract. - -This generates both the prover functions, needed to create proofs for running `@method`s, -and the verification key, needed to deploy your zkApp. - -Although provers and verification key are returned by this method, they are also cached internally and used when needed, -so you don't actually have to use the return value of this function. - -Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to -create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps -it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, -up to several minutes if your circuit is large or your hardware is not optimal for these operations. - -#### Parameters - -##### \_\_namedParameters? - -###### cache - -`Cache` - -###### forceRecompile - -`boolean` - -#### Returns - -`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -#### Inherited from - -`TokenContractV2.compile` - -*** - -### digest() - -> `static` **digest**(): `Promise`\<`string`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 - -Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. -This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or -a cached verification key can be used. - -#### Returns - -`Promise`\<`string`\> - -the digest, as a hex string - -#### Inherited from - -`TokenContractV2.digest` - -*** - -### Proof() - -> `static` **Proof**(): (`__namedParameters`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 - -Returns a Proof type that belongs to this SmartContract. - -#### Returns - -`Function` - -##### Parameters - -###### \_\_namedParameters - -###### maxProofsVerified - -`0` \| `1` \| `2` - -###### proof - -`unknown` - -###### publicInput - -`ZkappPublicInput` - -###### publicOutput - -`undefined` - -##### Returns - -`object` - -###### maxProofsVerified - -> **maxProofsVerified**: `0` \| `1` \| `2` - -###### proof - -> **proof**: `unknown` - -###### publicInput - -> **publicInput**: `ZkappPublicInput` - -###### publicOutput - -> **publicOutput**: `undefined` - -###### shouldVerify - -> **shouldVerify**: `Bool` - -###### toJSON() - -###### Returns - -`JsonProof` - -###### verify() - -###### Returns - -`void` - -###### verifyIf() - -###### Parameters - -###### condition - -`Bool` - -###### Returns - -`void` - -##### publicInputType - -> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` - -###### Type declaration - -###### fromFields() - -> **fromFields**: (`fields`) => `object` - -###### Parameters - -###### fields - -`Field`[] - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### Type declaration - -###### empty() - -> **empty**: () => `object` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### fromJSON() - -> **fromJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`string` - -###### calls - -`string` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### toInput() - -> **toInput**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### fields? - -> `optional` **fields**: `Field`[] - -###### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -###### toJSON() - -> **toJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `string` - -###### calls - -> **calls**: `string` - -##### publicOutputType - -> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> - -##### tag() - -> **tag**: () => *typeof* `SmartContract` - -###### Returns - -*typeof* `SmartContract` - -##### dummy() - -###### Type Parameters - -• **Input** - -• **OutPut** - -###### Parameters - -###### publicInput - -`Input` - -###### publicOutput - -`OutPut` - -###### maxProofsVerified - -`0` | `1` | `2` - -###### domainLog2? - -`number` - -###### Returns - -`Promise`\<`Proof`\<`Input`, `OutPut`\>\> - -##### fromJSON() - -###### Type Parameters - -• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` - -###### Parameters - -###### this - -`S` - -###### \_\_namedParameters - -`JsonProof` - -###### Returns - -`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -#### Inherited from - -`TokenContractV2.Proof` - -*** - -### runOutsideCircuit() - -> `static` **runOutsideCircuit**(`run`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 - -#### Parameters - -##### run - -() => `void` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.runOutsideCircuit` diff --git a/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md deleted file mode 100644 index 2a81f56..0000000 --- a/src/pages/docs/reference/protocol/classes/BridgeContractProtocolModule.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: BridgeContractProtocolModule ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BridgeContractProtocolModule - -# Class: BridgeContractProtocolModule - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L18) - -This module type is used to define a contract module that can be used to -construct and inject smart contract instances. -It defines a method contractFactory, whose arguments can be configured via -the Argument generic. It returns a smart contract class that is a subclass -of SmartContract and implements a certain interface as specified by the -ContractType generic. - -## Extends - -- [`ContractModule`](ContractModule.md)\<[`BridgeContractType`](../type-aliases/BridgeContractType.md), [`BridgeContractConfig`](../type-aliases/BridgeContractConfig.md)\> - -## Constructors - -### new BridgeContractProtocolModule() - -> **new BridgeContractProtocolModule**(): [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md) - -#### Returns - -[`BridgeContractProtocolModule`](BridgeContractProtocolModule.md) - -#### Inherited from - -[`ContractModule`](ContractModule.md).[`constructor`](ContractModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`BridgeContractConfig`](../type-aliases/BridgeContractConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ContractModule`](ContractModule.md).[`currentConfig`](ContractModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ContractModule`](ContractModule.md).[`config`](ContractModule.md#config) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<\{ `BridgeContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L38) - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<\{ `BridgeContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> - -#### Overrides - -[`ContractModule`](ContractModule.md).[`compile`](ContractModule.md#compile) - -*** - -### contractFactory() - -> **contractFactory**(): *typeof* [`BridgeContract`](BridgeContract.md) - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L22) - -#### Returns - -*typeof* [`BridgeContract`](BridgeContract.md) - -#### Overrides - -[`ContractModule`](ContractModule.md).[`contractFactory`](ContractModule.md#contractfactory) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ContractModule`](ContractModule.md).[`create`](ContractModule.md#create) diff --git a/src/pages/docs/reference/protocol/classes/ContractModule.md b/src/pages/docs/reference/protocol/classes/ContractModule.md deleted file mode 100644 index f81fe40..0000000 --- a/src/pages/docs/reference/protocol/classes/ContractModule.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: ContractModule ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ContractModule - -# Class: `abstract` ContractModule\ - -Defined in: [packages/protocol/src/settlement/ContractModule.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/ContractModule.ts#L22) - -This module type is used to define a contract module that can be used to -construct and inject smart contract instances. -It defines a method contractFactory, whose arguments can be configured via -the Argument generic. It returns a smart contract class that is a subclass -of SmartContract and implements a certain interface as specified by the -ContractType generic. - -## Extends - -- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> - -## Extended by - -- [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md) -- [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) -- [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md) - -## Type Parameters - -• **ContractType** - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -## Implements - -- [`CompilableModule`](../../common/interfaces/CompilableModule.md) - -## Constructors - -### new ContractModule() - -> **new ContractModule**\<`ContractType`, `Config`\>(): [`ContractModule`](ContractModule.md)\<`ContractType`, `Config`\> - -#### Returns - -[`ContractModule`](ContractModule.md)\<`ContractType`, `Config`\> - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) - -## Methods - -### compile() - -> `abstract` **compile**(`registry`): `Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -Defined in: [packages/protocol/src/settlement/ContractModule.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/ContractModule.ts#L28) - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -#### Implementation of - -[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) - -*** - -### contractFactory() - -> `abstract` **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<`ContractType`\> - -Defined in: [packages/protocol/src/settlement/ContractModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/ContractModule.ts#L26) - -#### Returns - -[`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<`ContractType`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) diff --git a/src/pages/docs/reference/protocol/classes/CurrentBlock.md b/src/pages/docs/reference/protocol/classes/CurrentBlock.md deleted file mode 100644 index 905db84..0000000 --- a/src/pages/docs/reference/protocol/classes/CurrentBlock.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -title: CurrentBlock ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / CurrentBlock - -# Class: CurrentBlock - -Defined in: [packages/protocol/src/model/network/NetworkState.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L4) - -## Extends - -- `object` - -## Constructors - -### new CurrentBlock() - -> **new CurrentBlock**(`value`): [`CurrentBlock`](CurrentBlock.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### height - -`UInt64` = `UInt64` - -#### Returns - -[`CurrentBlock`](CurrentBlock.md) - -#### Inherited from - -`Struct({ height: UInt64, }).constructor` - -## Properties - -### height - -> **height**: `UInt64` = `UInt64` - -Defined in: [packages/protocol/src/model/network/NetworkState.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L5) - -#### Inherited from - -`Struct({ height: UInt64, }).height` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ height: UInt64, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### height - -`UInt64` = `UInt64` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ height: UInt64, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### height - -> **height**: `UInt64` = `UInt64` - -#### Inherited from - -`Struct({ height: UInt64, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### height - -> **height**: `UInt64` = `UInt64` - -#### Inherited from - -`Struct({ height: UInt64, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### height - -`string` = `UInt64` - -#### Returns - -`object` - -##### height - -> **height**: `UInt64` = `UInt64` - -#### Inherited from - -`Struct({ height: UInt64, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ height: UInt64, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### height - -`UInt64` = `UInt64` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ height: UInt64, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### height - -`UInt64` = `UInt64` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ height: UInt64, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### height - -`UInt64` = `UInt64` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ height: UInt64, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### height - -`UInt64` = `UInt64` - -#### Returns - -`object` - -##### height - -> **height**: `string` = `UInt64` - -#### Inherited from - -`Struct({ height: UInt64, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### height - -`UInt64` = `UInt64` - -#### Returns - -`object` - -##### height - -> **height**: `bigint` = `UInt64` - -#### Inherited from - -`Struct({ height: UInt64, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ height: UInt64, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md b/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md deleted file mode 100644 index bf79c6a..0000000 --- a/src/pages/docs/reference/protocol/classes/DefaultProvableHashList.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: DefaultProvableHashList ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DefaultProvableHashList - -# Class: DefaultProvableHashList\ - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L46) - -Utilities for creating a hash list from a given value type. - -## Extends - -- [`ProvableHashList`](ProvableHashList.md)\<`Value`\> - -## Type Parameters - -• **Value** - -## Constructors - -### new DefaultProvableHashList() - -> **new DefaultProvableHashList**\<`Value`\>(`valueType`, `commitment`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L7) - -#### Parameters - -##### valueType - -`ProvablePure`\<`Value`\> - -##### commitment - -`Field` = `...` - -#### Returns - -[`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`constructor`](ProvableHashList.md#constructors) - -## Properties - -### commitment - -> **commitment**: `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`commitment`](ProvableHashList.md#commitment-1) - -*** - -### valueType - -> `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`valueType`](ProvableHashList.md#valuetype-1) - -## Methods - -### hash() - -> **hash**(`elements`): `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L47) - -#### Parameters - -##### elements - -`Field`[] - -#### Returns - -`Field` - -#### Overrides - -[`ProvableHashList`](ProvableHashList.md).[`hash`](ProvableHashList.md#hash) - -*** - -### push() - -> **push**(`value`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) - -Converts the provided value to Field[] and appends it to -the current hashlist. - -#### Parameters - -##### value - -`Value` - -Value to be appended to the hash list - -#### Returns - -[`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> - -Current hash list. - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`push`](ProvableHashList.md#push) - -*** - -### pushIf() - -> **pushIf**(`value`, `condition`): [`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L29) - -#### Parameters - -##### value - -`Value` - -##### condition - -`Bool` - -#### Returns - -[`DefaultProvableHashList`](DefaultProvableHashList.md)\<`Value`\> - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`pushIf`](ProvableHashList.md#pushif) - -*** - -### toField() - -> **toField**(): `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) - -#### Returns - -`Field` - -Traling hash of the current hashlist. - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`toField`](ProvableHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/Deposit.md b/src/pages/docs/reference/protocol/classes/Deposit.md deleted file mode 100644 index 2eb5185..0000000 --- a/src/pages/docs/reference/protocol/classes/Deposit.md +++ /dev/null @@ -1,493 +0,0 @@ ---- -title: Deposit ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Deposit - -# Class: Deposit - -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Deposit.ts#L3) - -## Extends - -- `object` - -## Constructors - -### new Deposit() - -> **new Deposit**(`value`): [`Deposit`](Deposit.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -[`Deposit`](Deposit.md) - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).constructor` - -## Properties - -### address - -> **address**: `PublicKey` = `PublicKey` - -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Deposit.ts#L5) - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).address` - -*** - -### amount - -> **amount**: `UInt64` = `UInt64` - -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Deposit.ts#L6) - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).amount` - -*** - -### tokenId - -> **tokenId**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/messages/Deposit.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Deposit.ts#L4) - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).tokenId` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### amount - -> **amount**: `UInt64` = `UInt64` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### amount - -> **amount**: `UInt64` = `UInt64` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### address - -`string` = `PublicKey` - -###### amount - -`string` = `UInt64` - -###### tokenId - -`string` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### amount - -> **amount**: `UInt64` = `UInt64` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `string` = `PublicKey` - -##### amount - -> **amount**: `string` = `UInt64` - -##### tokenId - -> **tokenId**: `string` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `object` = `PublicKey` - -###### address.isOdd - -> **address.isOdd**: `boolean` - -###### address.x - -> **address.x**: `bigint` - -##### amount - -> **amount**: `bigint` = `UInt64` - -##### tokenId - -> **tokenId**: `bigint` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md deleted file mode 100644 index 673016c..0000000 --- a/src/pages/docs/reference/protocol/classes/DispatchContractProtocolModule.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -title: DispatchContractProtocolModule ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DispatchContractProtocolModule - -# Class: DispatchContractProtocolModule - -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L22) - -This module type is used to define a contract module that can be used to -construct and inject smart contract instances. -It defines a method contractFactory, whose arguments can be configured via -the Argument generic. It returns a smart contract class that is a subclass -of SmartContract and implements a certain interface as specified by the -ContractType generic. - -## Extends - -- [`ContractModule`](ContractModule.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md), [`DispatchContractConfig`](../type-aliases/DispatchContractConfig.md)\> - -## Constructors - -### new DispatchContractProtocolModule() - -> **new DispatchContractProtocolModule**(`runtime`): [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) - -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L26) - -#### Parameters - -##### runtime - -[`RuntimeLike`](../interfaces/RuntimeLike.md) - -#### Returns - -[`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) - -#### Overrides - -[`ContractModule`](ContractModule.md).[`constructor`](ContractModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`DispatchContractConfig`](../type-aliases/DispatchContractConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ContractModule`](ContractModule.md).[`currentConfig`](ContractModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ContractModule`](ContractModule.md).[`config`](ContractModule.md#config) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<\{ `DispatchSmartContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L65) - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<\{ `DispatchSmartContract`: [`CompileArtifact`](../../common/interfaces/CompileArtifact.md); \}\> - -#### Overrides - -[`ContractModule`](ContractModule.md).[`compile`](ContractModule.md#compile) - -*** - -### contractFactory() - -> **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md)\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L49) - -#### Returns - -[`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md)\> - -#### Overrides - -[`ContractModule`](ContractModule.md).[`contractFactory`](ContractModule.md#contractfactory) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ContractModule`](ContractModule.md).[`create`](ContractModule.md#create) - -*** - -### eventsDefinition() - -> **eventsDefinition**(): `object` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L30) - -#### Returns - -`object` - -##### incoming-message-placeholder - -> **incoming-message-placeholder**: *typeof* `Field` & (`x`) => `Field` = `Field` - -##### token-bridge-added - -> **token-bridge-added**: *typeof* [`TokenBridgeTreeAddition`](TokenBridgeTreeAddition.md) = `TokenBridgeTreeAddition` diff --git a/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md b/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md deleted file mode 100644 index ae118ae..0000000 --- a/src/pages/docs/reference/protocol/classes/DispatchSmartContract.md +++ /dev/null @@ -1,1401 +0,0 @@ ---- -title: DispatchSmartContract ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DispatchSmartContract - -# Class: DispatchSmartContract - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:229](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L229) - -## Extends - -- [`DispatchSmartContractBase`](DispatchSmartContractBase.md) - -## Implements - -- [`DispatchContractType`](../interfaces/DispatchContractType.md) - -## Constructors - -### new DispatchSmartContract() - -> **new DispatchSmartContract**(`address`, `tokenId`?): [`DispatchSmartContract`](DispatchSmartContract.md) - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 - -#### Parameters - -##### address - -`PublicKey` - -##### tokenId? - -`Field` - -#### Returns - -[`DispatchSmartContract`](DispatchSmartContract.md) - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`constructor`](DispatchSmartContractBase.md#constructors) - -## Properties - -### address - -> **address**: `PublicKey` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`address`](DispatchSmartContractBase.md#address-1) - -*** - -### events - -> **events**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) - -A list of event types that can be emitted using this.emitEvent()`. - -#### incoming-message-placeholder - -> **incoming-message-placeholder**: *typeof* `Field` & (`x`) => `Field` = `Field` - -#### token-bridge-added - -> **token-bridge-added**: *typeof* [`TokenBridgeTreeAddition`](TokenBridgeTreeAddition.md) = `TokenBridgeTreeAddition` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`events`](DispatchSmartContractBase.md#events) - -*** - -### honoredMessagesHash - -> **honoredMessagesHash**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:235](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L235) - -#### Overrides - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`honoredMessagesHash`](DispatchSmartContractBase.md#honoredmessageshash) - -*** - -### promisedMessagesHash - -> **promisedMessagesHash**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:233](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L233) - -#### Implementation of - -[`DispatchContractType`](../interfaces/DispatchContractType.md).[`promisedMessagesHash`](../interfaces/DispatchContractType.md#promisedmessageshash) - -#### Overrides - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`promisedMessagesHash`](DispatchSmartContractBase.md#promisedmessageshash) - -*** - -### sender - -> **sender**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 - -#### self - -> **self**: `SmartContract` - -#### ~~getAndRequireSignature()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key. - -#### getAndRequireSignatureV2() - -Return a public key that is forced to sign this transaction. - -Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created -the transaction controls the private key associated with the returned public key. - -##### Returns - -`PublicKey` - -#### ~~getUnconstrained()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getUnconstrainedV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key, -which would cause an account update with that public key to not be included. - -#### getUnconstrainedV2() - -The public key of the current transaction's sender account. - -Throws an error if not inside a transaction, or the sender wasn't passed in. - -**Warning**: The fact that this public key equals the current sender is not part of the proof. -A malicious prover could use any other public key without affecting the validity of the proof. - -Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. - -##### Returns - -`PublicKey` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`sender`](DispatchSmartContractBase.md#sender) - -*** - -### settlementContract - -> **settlementContract**: `State`\<`PublicKey`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:237](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L237) - -#### Overrides - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`settlementContract`](DispatchSmartContractBase.md#settlementcontract) - -*** - -### tokenBridgeCount - -> **tokenBridgeCount**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:241](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L241) - -#### Overrides - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`tokenBridgeCount`](DispatchSmartContractBase.md#tokenbridgecount) - -*** - -### tokenBridgeRoot - -> **tokenBridgeRoot**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:239](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L239) - -#### Overrides - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`tokenBridgeRoot`](DispatchSmartContractBase.md#tokenbridgeroot) - -*** - -### tokenId - -> **tokenId**: `Field` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`tokenId`](DispatchSmartContractBase.md#tokenid-1) - -*** - -### \_maxProofsVerified? - -> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`_maxProofsVerified`](DispatchSmartContractBase.md#_maxproofsverified) - -*** - -### \_methodMetadata? - -> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`_methodMetadata`](DispatchSmartContractBase.md#_methodmetadata) - -*** - -### \_methods? - -> `static` `optional` **\_methods**: `MethodInterface`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`_methods`](DispatchSmartContractBase.md#_methods) - -*** - -### \_provers? - -> `static` `optional` **\_provers**: `Prover`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`_provers`](DispatchSmartContractBase.md#_provers) - -*** - -### \_verificationKey? - -> `static` `optional` **\_verificationKey**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 - -#### data - -> **data**: `string` - -#### hash - -> **hash**: `Field` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`_verificationKey`](DispatchSmartContractBase.md#_verificationkey) - -*** - -### args - -> `static` **args**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) - -#### incomingMessagesPaths - -> **incomingMessagesPaths**: `Record`\<`string`, `` `${string}.${string}` ``\> - -#### methodIdMappings - -> **methodIdMappings**: [`RuntimeMethodIdMapping`](../type-aliases/RuntimeMethodIdMapping.md) - -#### settlementContractClass? - -> `optional` **settlementContractClass**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> & *typeof* `SmartContract` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`args`](DispatchSmartContractBase.md#args) - -## Accessors - -### account - -#### Get Signature - -> **get** **account**(): `Account` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 - -Current account of the SmartContract. - -##### Returns - -`Account` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`account`](DispatchSmartContractBase.md#account) - -*** - -### balance - -#### Get Signature - -> **get** **balance**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 - -Balance of this SmartContract. - -##### Returns - -`object` - -###### addInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -###### subInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`balance`](DispatchSmartContractBase.md#balance) - -*** - -### currentSlot - -#### Get Signature - -> **get** **currentSlot**(): `CurrentSlot` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 - -Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value -at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) -or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) - -##### Returns - -`CurrentSlot` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`currentSlot`](DispatchSmartContractBase.md#currentslot) - -*** - -### network - -#### Get Signature - -> **get** **network**(): `Network` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 - -Current network state of the SmartContract. - -##### Returns - -`Network` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`network`](DispatchSmartContractBase.md#network) - -*** - -### self - -#### Get Signature - -> **get** **self**(): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 - -Returns the current AccountUpdate associated to this SmartContract. - -##### Returns - -`AccountUpdate` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`self`](DispatchSmartContractBase.md#self) - -## Methods - -### approve() - -> **approve**(`update`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 - -Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, -which allows you to read and use its content in a proof, make assertions about it, and modify it. - -```ts -`@method` myApprovingMethod(update: AccountUpdate) { - this.approve(update); - - // read balance on the account (for example) - let balance = update.account.balance.getAndRequireEquals(); -} -``` - -Under the hood, "approving" just means that the account update is made a child of the zkApp in the -tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, -the entire tree will become a subtree of the zkApp's account update. - -Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update -at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally -excluding important information from the public input. - -#### Parameters - -##### update - -`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` - -#### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`approve`](DispatchSmartContractBase.md#approve) - -*** - -### deploy() - -> **deploy**(`__namedParameters`?): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:182 - -Deploys a SmartContract. - -```ts -let tx = await Mina.transaction(sender, async () => { - AccountUpdate.fundNewAccount(sender); - await zkapp.deploy(); -}); -tx.sign([senderKey, zkAppKey]); -``` - -#### Parameters - -##### \_\_namedParameters? - -###### verificationKey - -\{ `data`: `string`; `hash`: `string` \| `Field`; \} - -###### verificationKey.data - -`string` - -###### verificationKey.hash - -`string` \| `Field` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`deploy`](DispatchSmartContractBase.md#deploy) - -*** - -### deposit() - -> **deposit**(`amount`, `tokenId`, `bridgingContract`, `bridgingContractAttestation`, `l2Receiver`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:273](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L273) - -#### Parameters - -##### amount - -`UInt64` - -##### tokenId - -`Field` - -##### bridgingContract - -`PublicKey` - -##### bridgingContractAttestation - -[`TokenBridgeAttestation`](TokenBridgeAttestation.md) - -##### l2Receiver - -`PublicKey` - -#### Returns - -`Promise`\<`void`\> - -*** - -### dispatchMessage() - -> `protected` **dispatchMessage**\<`Type`\>(`methodId`, `value`, `valueType`): `void` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) - -#### Type Parameters - -• **Type** - -#### Parameters - -##### methodId - -`Field` - -##### value - -`Type` - -##### valueType - -`ProvableExtended`\<`Type`\> - -#### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`dispatchMessage`](DispatchSmartContractBase.md#dispatchmessage) - -*** - -### emitEvent() - -> **emitEvent**\<`K`\>(`type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 - -Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `"token-bridge-added"` \| `"incoming-message-placeholder"` - -#### Parameters - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`emitEvent`](DispatchSmartContractBase.md#emitevent) - -*** - -### emitEventIf() - -> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 - -Conditionally emits an event. - -Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `"token-bridge-added"` \| `"incoming-message-placeholder"` - -#### Parameters - -##### condition - -`Bool` - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`emitEventIf`](DispatchSmartContractBase.md#emiteventif) - -*** - -### enableTokenDeposits() - -> **enableTokenDeposits**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:244](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L244) - -#### Parameters - -##### tokenId - -`Field` - -##### bridgeContractAddress - -`PublicKey` - -##### settlementContractAddress - -`PublicKey` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`DispatchContractType`](../interfaces/DispatchContractType.md).[`enableTokenDeposits`](../interfaces/DispatchContractType.md#enabletokendeposits) - -*** - -### enableTokenDepositsBase() - -> `protected` **enableTokenDepositsBase**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) - -#### Parameters - -##### tokenId - -`Field` - -##### bridgeContractAddress - -`PublicKey` - -##### settlementContractAddress - -`PublicKey` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`enableTokenDepositsBase`](DispatchSmartContractBase.md#enabletokendepositsbase) - -*** - -### fetchEvents() - -> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 - -Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. - -#### Parameters - -##### start? - -`UInt32` - -The start height of the events to fetch. - -##### end? - -`UInt32` - -The end height of the events to fetch. If not provided, fetches events up to the latest height. - -#### Returns - -`Promise`\<`object`[]\> - -A promise that resolves to an array of objects, each containing the event type and event data for the specified range. - -#### Async - -#### Throws - -If there is an error fetching events from the Mina network. - -#### Example - -```ts -const startHeight = UInt32.from(1000); -const endHeight = UInt32.from(2000); -const events = await myZkapp.fetchEvents(startHeight, endHeight); -console.log(events); -``` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`fetchEvents`](DispatchSmartContractBase.md#fetchevents) - -*** - -### init() - -> **init**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 - -`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. -This method can be overridden as follows -``` -class MyContract extends SmartContract { - init() { - super.init(); - this.account.permissions.set(...); - this.x.set(Field(1)); - } -} -``` - -#### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`init`](DispatchSmartContractBase.md#init) - -*** - -### initialize() - -> **initialize**(`settlementContract`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:268](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L268) - -#### Parameters - -##### settlementContract - -`PublicKey` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`DispatchContractType`](../interfaces/DispatchContractType.md).[`initialize`](../interfaces/DispatchContractType.md#initialize) - -*** - -### initializeBase() - -> `protected` **initializeBase**(`settlementContract`): `void` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) - -#### Parameters - -##### settlementContract - -`PublicKey` - -#### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`initializeBase`](DispatchSmartContractBase.md#initializebase) - -*** - -### newSelf() - -> **newSelf**(`methodName`?): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 - -Same as `SmartContract.self` but explicitly creates a new AccountUpdate. - -#### Parameters - -##### methodName? - -`string` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`newSelf`](DispatchSmartContractBase.md#newself) - -*** - -### requireSignature() - -> **requireSignature**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 - -Use this command if the account update created by this SmartContract should be signed by the account owner, -instead of authorized with a proof. - -Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. - -If you only want to avoid creating proofs for quicker testing, we advise you to -use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting -`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, -with the only difference being that quick mock proofs are filled in instead of real proofs. - -#### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`requireSignature`](DispatchSmartContractBase.md#requiresignature) - -*** - -### send() - -> **send**(`args`): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 - -#### Parameters - -##### args - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### to - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`send`](DispatchSmartContractBase.md#send) - -*** - -### skipAuthorization() - -> **skipAuthorization**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 - -Use this command if the account update created by this SmartContract should have no authorization on it, -instead of being authorized with a proof. - -WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look -at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the -authorization flow. - -#### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`skipAuthorization`](DispatchSmartContractBase.md#skipauthorization) - -*** - -### updateMessagesHash() - -> **updateMessagesHash**(`executedMessagesHash`, `newPromisedMessagesHash`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:257](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L257) - -#### Parameters - -##### executedMessagesHash - -`Field` - -##### newPromisedMessagesHash - -`Field` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`DispatchContractType`](../interfaces/DispatchContractType.md).[`updateMessagesHash`](../interfaces/DispatchContractType.md#updatemessageshash) - -*** - -### updateMessagesHashBase() - -> `protected` **updateMessagesHashBase**(`executedMessagesHash`, `newPromisedMessagesHash`): `void` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) - -#### Parameters - -##### executedMessagesHash - -`Field` - -##### newPromisedMessagesHash - -`Field` - -#### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`updateMessagesHashBase`](DispatchSmartContractBase.md#updatemessageshashbase) - -*** - -### analyzeMethods() - -> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 - -This function is run internally before compiling a smart contract, to collect metadata about what each of your -smart contract methods does. - -For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, -so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. - -`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), -which is a good indicator for circuit size and the time it will take to create proofs. -To inspect the created circuit in detail, you can look at the returned `gates`. - -Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. - -#### Parameters - -##### \_\_namedParameters? - -###### printSummary - -`boolean` - -#### Returns - -`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -an object, keyed by method name, each entry containing: - - `rows` the size of the constraint system created by this method - - `digest` a digest of the method circuit - - `actions` the number of actions the method dispatches - - `gates` the constraint system, represented as an array of gates - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`analyzeMethods`](DispatchSmartContractBase.md#analyzemethods) - -*** - -### compile() - -> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 - -Compile your smart contract. - -This generates both the prover functions, needed to create proofs for running `@method`s, -and the verification key, needed to deploy your zkApp. - -Although provers and verification key are returned by this method, they are also cached internally and used when needed, -so you don't actually have to use the return value of this function. - -Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to -create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps -it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, -up to several minutes if your circuit is large or your hardware is not optimal for these operations. - -#### Parameters - -##### \_\_namedParameters? - -###### cache - -`Cache` - -###### forceRecompile - -`boolean` - -#### Returns - -`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`compile`](DispatchSmartContractBase.md#compile) - -*** - -### digest() - -> `static` **digest**(): `Promise`\<`string`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 - -Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. -This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or -a cached verification key can be used. - -#### Returns - -`Promise`\<`string`\> - -the digest, as a hex string - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`digest`](DispatchSmartContractBase.md#digest) - -*** - -### Proof() - -> `static` **Proof**(): (`__namedParameters`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 - -Returns a Proof type that belongs to this SmartContract. - -#### Returns - -`Function` - -##### Parameters - -###### \_\_namedParameters - -###### maxProofsVerified - -`0` \| `1` \| `2` - -###### proof - -`unknown` - -###### publicInput - -`ZkappPublicInput` - -###### publicOutput - -`undefined` - -##### Returns - -`object` - -###### maxProofsVerified - -> **maxProofsVerified**: `0` \| `1` \| `2` - -###### proof - -> **proof**: `unknown` - -###### publicInput - -> **publicInput**: `ZkappPublicInput` - -###### publicOutput - -> **publicOutput**: `undefined` - -###### shouldVerify - -> **shouldVerify**: `Bool` - -###### toJSON() - -###### Returns - -`JsonProof` - -###### verify() - -###### Returns - -`void` - -###### verifyIf() - -###### Parameters - -###### condition - -`Bool` - -###### Returns - -`void` - -##### publicInputType - -> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` - -###### Type declaration - -###### fromFields() - -> **fromFields**: (`fields`) => `object` - -###### Parameters - -###### fields - -`Field`[] - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### Type declaration - -###### empty() - -> **empty**: () => `object` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### fromJSON() - -> **fromJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`string` - -###### calls - -`string` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### toInput() - -> **toInput**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### fields? - -> `optional` **fields**: `Field`[] - -###### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -###### toJSON() - -> **toJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `string` - -###### calls - -> **calls**: `string` - -##### publicOutputType - -> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> - -##### tag() - -> **tag**: () => *typeof* `SmartContract` - -###### Returns - -*typeof* `SmartContract` - -##### dummy() - -###### Type Parameters - -• **Input** - -• **OutPut** - -###### Parameters - -###### publicInput - -`Input` - -###### publicOutput - -`OutPut` - -###### maxProofsVerified - -`0` | `1` | `2` - -###### domainLog2? - -`number` - -###### Returns - -`Promise`\<`Proof`\<`Input`, `OutPut`\>\> - -##### fromJSON() - -###### Type Parameters - -• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` - -###### Parameters - -###### this - -`S` - -###### \_\_namedParameters - -`JsonProof` - -###### Returns - -`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`Proof`](DispatchSmartContractBase.md#proof) - -*** - -### runOutsideCircuit() - -> `static` **runOutsideCircuit**(`run`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 - -#### Parameters - -##### run - -() => `void` - -#### Returns - -`void` - -#### Inherited from - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md).[`runOutsideCircuit`](DispatchSmartContractBase.md#runoutsidecircuit) diff --git a/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md b/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md deleted file mode 100644 index ee89f04..0000000 --- a/src/pages/docs/reference/protocol/classes/DispatchSmartContractBase.md +++ /dev/null @@ -1,1245 +0,0 @@ ---- -title: DispatchSmartContractBase ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DispatchSmartContractBase - -# Class: `abstract` DispatchSmartContractBase - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L59) - -## Extends - -- `SmartContract` - -## Extended by - -- [`DispatchSmartContract`](DispatchSmartContract.md) - -## Constructors - -### new DispatchSmartContractBase() - -> **new DispatchSmartContractBase**(`address`, `tokenId`?): [`DispatchSmartContractBase`](DispatchSmartContractBase.md) - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 - -#### Parameters - -##### address - -`PublicKey` - -##### tokenId? - -`Field` - -#### Returns - -[`DispatchSmartContractBase`](DispatchSmartContractBase.md) - -#### Inherited from - -`SmartContract.constructor` - -## Properties - -### address - -> **address**: `PublicKey` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 - -#### Inherited from - -`SmartContract.address` - -*** - -### events - -> **events**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L67) - -A list of event types that can be emitted using this.emitEvent()`. - -#### incoming-message-placeholder - -> **incoming-message-placeholder**: *typeof* `Field` & (`x`) => `Field` = `Field` - -#### token-bridge-added - -> **token-bridge-added**: *typeof* [`TokenBridgeTreeAddition`](TokenBridgeTreeAddition.md) = `TokenBridgeTreeAddition` - -#### Overrides - -`SmartContract.events` - -*** - -### honoredMessagesHash - -> `abstract` **honoredMessagesHash**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L77) - -*** - -### promisedMessagesHash - -> `abstract` **promisedMessagesHash**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L75) - -*** - -### sender - -> **sender**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 - -#### self - -> **self**: `SmartContract` - -#### ~~getAndRequireSignature()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key. - -#### getAndRequireSignatureV2() - -Return a public key that is forced to sign this transaction. - -Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created -the transaction controls the private key associated with the returned public key. - -##### Returns - -`PublicKey` - -#### ~~getUnconstrained()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getUnconstrainedV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key, -which would cause an account update with that public key to not be included. - -#### getUnconstrainedV2() - -The public key of the current transaction's sender account. - -Throws an error if not inside a transaction, or the sender wasn't passed in. - -**Warning**: The fact that this public key equals the current sender is not part of the proof. -A malicious prover could use any other public key without affecting the validity of the proof. - -Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. - -##### Returns - -`PublicKey` - -#### Inherited from - -`SmartContract.sender` - -*** - -### settlementContract - -> `abstract` **settlementContract**: `State`\<`PublicKey`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L79) - -*** - -### tokenBridgeCount - -> `abstract` **tokenBridgeCount**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L83) - -*** - -### tokenBridgeRoot - -> `abstract` **tokenBridgeRoot**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L81) - -*** - -### tokenId - -> **tokenId**: `Field` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 - -#### Inherited from - -`SmartContract.tokenId` - -*** - -### \_maxProofsVerified? - -> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 - -#### Inherited from - -`SmartContract._maxProofsVerified` - -*** - -### \_methodMetadata? - -> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 - -#### Inherited from - -`SmartContract._methodMetadata` - -*** - -### \_methods? - -> `static` `optional` **\_methods**: `MethodInterface`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 - -#### Inherited from - -`SmartContract._methods` - -*** - -### \_provers? - -> `static` `optional` **\_provers**: `Prover`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 - -#### Inherited from - -`SmartContract._provers` - -*** - -### \_verificationKey? - -> `static` `optional` **\_verificationKey**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 - -#### data - -> **data**: `string` - -#### hash - -> **hash**: `Field` - -#### Inherited from - -`SmartContract._verificationKey` - -*** - -### args - -> `static` **args**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L60) - -#### incomingMessagesPaths - -> **incomingMessagesPaths**: `Record`\<`string`, `` `${string}.${string}` ``\> - -#### methodIdMappings - -> **methodIdMappings**: [`RuntimeMethodIdMapping`](../type-aliases/RuntimeMethodIdMapping.md) - -#### settlementContractClass? - -> `optional` **settlementContractClass**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> & *typeof* `SmartContract` - -## Accessors - -### account - -#### Get Signature - -> **get** **account**(): `Account` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 - -Current account of the SmartContract. - -##### Returns - -`Account` - -#### Inherited from - -`SmartContract.account` - -*** - -### balance - -#### Get Signature - -> **get** **balance**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 - -Balance of this SmartContract. - -##### Returns - -`object` - -###### addInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -###### subInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -#### Inherited from - -`SmartContract.balance` - -*** - -### currentSlot - -#### Get Signature - -> **get** **currentSlot**(): `CurrentSlot` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 - -Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value -at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) -or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) - -##### Returns - -`CurrentSlot` - -#### Inherited from - -`SmartContract.currentSlot` - -*** - -### network - -#### Get Signature - -> **get** **network**(): `Network` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 - -Current network state of the SmartContract. - -##### Returns - -`Network` - -#### Inherited from - -`SmartContract.network` - -*** - -### self - -#### Get Signature - -> **get** **self**(): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 - -Returns the current AccountUpdate associated to this SmartContract. - -##### Returns - -`AccountUpdate` - -#### Inherited from - -`SmartContract.self` - -## Methods - -### approve() - -> **approve**(`update`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 - -Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, -which allows you to read and use its content in a proof, make assertions about it, and modify it. - -```ts -`@method` myApprovingMethod(update: AccountUpdate) { - this.approve(update); - - // read balance on the account (for example) - let balance = update.account.balance.getAndRequireEquals(); -} -``` - -Under the hood, "approving" just means that the account update is made a child of the zkApp in the -tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, -the entire tree will become a subtree of the zkApp's account update. - -Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update -at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally -excluding important information from the public input. - -#### Parameters - -##### update - -`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` - -#### Returns - -`void` - -#### Inherited from - -`SmartContract.approve` - -*** - -### deploy() - -> **deploy**(`__namedParameters`?): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:182 - -Deploys a SmartContract. - -```ts -let tx = await Mina.transaction(sender, async () => { - AccountUpdate.fundNewAccount(sender); - await zkapp.deploy(); -}); -tx.sign([senderKey, zkAppKey]); -``` - -#### Parameters - -##### \_\_namedParameters? - -###### verificationKey - -\{ `data`: `string`; `hash`: `string` \| `Field`; \} - -###### verificationKey.data - -`string` - -###### verificationKey.hash - -`string` \| `Field` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`SmartContract.deploy` - -*** - -### dispatchMessage() - -> `protected` **dispatchMessage**\<`Type`\>(`methodId`, `value`, `valueType`): `void` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L130) - -#### Type Parameters - -• **Type** - -#### Parameters - -##### methodId - -`Field` - -##### value - -`Type` - -##### valueType - -`ProvableExtended`\<`Type`\> - -#### Returns - -`void` - -*** - -### emitEvent() - -> **emitEvent**\<`K`\>(`type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 - -Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `"token-bridge-added"` \| `"incoming-message-placeholder"` - -#### Parameters - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -`SmartContract.emitEvent` - -*** - -### emitEventIf() - -> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 - -Conditionally emits an event. - -Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `"token-bridge-added"` \| `"incoming-message-placeholder"` - -#### Parameters - -##### condition - -`Bool` - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -`SmartContract.emitEventIf` - -*** - -### enableTokenDepositsBase() - -> `protected` **enableTokenDepositsBase**(`tokenId`, `bridgeContractAddress`, `settlementContractAddress`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:168](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L168) - -#### Parameters - -##### tokenId - -`Field` - -##### bridgeContractAddress - -`PublicKey` - -##### settlementContractAddress - -`PublicKey` - -#### Returns - -`Promise`\<`void`\> - -*** - -### fetchEvents() - -> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 - -Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. - -#### Parameters - -##### start? - -`UInt32` - -The start height of the events to fetch. - -##### end? - -`UInt32` - -The end height of the events to fetch. If not provided, fetches events up to the latest height. - -#### Returns - -`Promise`\<`object`[]\> - -A promise that resolves to an array of objects, each containing the event type and event data for the specified range. - -#### Async - -#### Throws - -If there is an error fetching events from the Mina network. - -#### Example - -```ts -const startHeight = UInt32.from(1000); -const endHeight = UInt32.from(2000); -const events = await myZkapp.fetchEvents(startHeight, endHeight); -console.log(events); -``` - -#### Inherited from - -`SmartContract.fetchEvents` - -*** - -### init() - -> **init**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 - -`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. -This method can be overridden as follows -``` -class MyContract extends SmartContract { - init() { - super.init(); - this.account.permissions.set(...); - this.x.set(Field(1)); - } -} -``` - -#### Returns - -`void` - -#### Inherited from - -`SmartContract.init` - -*** - -### initializeBase() - -> `protected` **initializeBase**(`settlementContract`): `void` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:118](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L118) - -#### Parameters - -##### settlementContract - -`PublicKey` - -#### Returns - -`void` - -*** - -### newSelf() - -> **newSelf**(`methodName`?): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 - -Same as `SmartContract.self` but explicitly creates a new AccountUpdate. - -#### Parameters - -##### methodName? - -`string` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -`SmartContract.newSelf` - -*** - -### requireSignature() - -> **requireSignature**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 - -Use this command if the account update created by this SmartContract should be signed by the account owner, -instead of authorized with a proof. - -Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. - -If you only want to avoid creating proofs for quicker testing, we advise you to -use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting -`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, -with the only difference being that quick mock proofs are filled in instead of real proofs. - -#### Returns - -`void` - -#### Inherited from - -`SmartContract.requireSignature` - -*** - -### send() - -> **send**(`args`): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 - -#### Parameters - -##### args - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### to - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -`SmartContract.send` - -*** - -### skipAuthorization() - -> **skipAuthorization**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 - -Use this command if the account update created by this SmartContract should have no authorization on it, -instead of being authorized with a proof. - -WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look -at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the -authorization flow. - -#### Returns - -`void` - -#### Inherited from - -`SmartContract.skipAuthorization` - -*** - -### updateMessagesHashBase() - -> `protected` **updateMessagesHashBase**(`executedMessagesHash`, `newPromisedMessagesHash`): `void` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L85) - -#### Parameters - -##### executedMessagesHash - -`Field` - -##### newPromisedMessagesHash - -`Field` - -#### Returns - -`void` - -*** - -### analyzeMethods() - -> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 - -This function is run internally before compiling a smart contract, to collect metadata about what each of your -smart contract methods does. - -For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, -so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. - -`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), -which is a good indicator for circuit size and the time it will take to create proofs. -To inspect the created circuit in detail, you can look at the returned `gates`. - -Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. - -#### Parameters - -##### \_\_namedParameters? - -###### printSummary - -`boolean` - -#### Returns - -`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -an object, keyed by method name, each entry containing: - - `rows` the size of the constraint system created by this method - - `digest` a digest of the method circuit - - `actions` the number of actions the method dispatches - - `gates` the constraint system, represented as an array of gates - -#### Inherited from - -`SmartContract.analyzeMethods` - -*** - -### compile() - -> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 - -Compile your smart contract. - -This generates both the prover functions, needed to create proofs for running `@method`s, -and the verification key, needed to deploy your zkApp. - -Although provers and verification key are returned by this method, they are also cached internally and used when needed, -so you don't actually have to use the return value of this function. - -Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to -create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps -it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, -up to several minutes if your circuit is large or your hardware is not optimal for these operations. - -#### Parameters - -##### \_\_namedParameters? - -###### cache - -`Cache` - -###### forceRecompile - -`boolean` - -#### Returns - -`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -#### Inherited from - -`SmartContract.compile` - -*** - -### digest() - -> `static` **digest**(): `Promise`\<`string`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 - -Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. -This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or -a cached verification key can be used. - -#### Returns - -`Promise`\<`string`\> - -the digest, as a hex string - -#### Inherited from - -`SmartContract.digest` - -*** - -### Proof() - -> `static` **Proof**(): (`__namedParameters`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 - -Returns a Proof type that belongs to this SmartContract. - -#### Returns - -`Function` - -##### Parameters - -###### \_\_namedParameters - -###### maxProofsVerified - -`0` \| `1` \| `2` - -###### proof - -`unknown` - -###### publicInput - -`ZkappPublicInput` - -###### publicOutput - -`undefined` - -##### Returns - -`object` - -###### maxProofsVerified - -> **maxProofsVerified**: `0` \| `1` \| `2` - -###### proof - -> **proof**: `unknown` - -###### publicInput - -> **publicInput**: `ZkappPublicInput` - -###### publicOutput - -> **publicOutput**: `undefined` - -###### shouldVerify - -> **shouldVerify**: `Bool` - -###### toJSON() - -###### Returns - -`JsonProof` - -###### verify() - -###### Returns - -`void` - -###### verifyIf() - -###### Parameters - -###### condition - -`Bool` - -###### Returns - -`void` - -##### publicInputType - -> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` - -###### Type declaration - -###### fromFields() - -> **fromFields**: (`fields`) => `object` - -###### Parameters - -###### fields - -`Field`[] - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### Type declaration - -###### empty() - -> **empty**: () => `object` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### fromJSON() - -> **fromJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`string` - -###### calls - -`string` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### toInput() - -> **toInput**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### fields? - -> `optional` **fields**: `Field`[] - -###### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -###### toJSON() - -> **toJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `string` - -###### calls - -> **calls**: `string` - -##### publicOutputType - -> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> - -##### tag() - -> **tag**: () => *typeof* `SmartContract` - -###### Returns - -*typeof* `SmartContract` - -##### dummy() - -###### Type Parameters - -• **Input** - -• **OutPut** - -###### Parameters - -###### publicInput - -`Input` - -###### publicOutput - -`OutPut` - -###### maxProofsVerified - -`0` | `1` | `2` - -###### domainLog2? - -`number` - -###### Returns - -`Promise`\<`Proof`\<`Input`, `OutPut`\>\> - -##### fromJSON() - -###### Type Parameters - -• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` - -###### Parameters - -###### this - -`S` - -###### \_\_namedParameters - -`JsonProof` - -###### Returns - -`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -#### Inherited from - -`SmartContract.Proof` - -*** - -### runOutsideCircuit() - -> `static` **runOutsideCircuit**(`run`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 - -#### Parameters - -##### run - -() => `void` - -#### Returns - -`void` - -#### Inherited from - -`SmartContract.runOutsideCircuit` diff --git a/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md b/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md deleted file mode 100644 index 95b68a9..0000000 --- a/src/pages/docs/reference/protocol/classes/DynamicBlockProof.md +++ /dev/null @@ -1,380 +0,0 @@ ---- -title: DynamicBlockProof ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DynamicBlockProof - -# Class: DynamicBlockProof - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L49) - -## Extends - -- `DynamicProof`\<[`BlockProverPublicInput`](BlockProverPublicInput.md), [`BlockProverPublicOutput`](BlockProverPublicOutput.md)\> - -## Constructors - -### new DynamicBlockProof() - -> **new DynamicBlockProof**(`__namedParameters`): [`DynamicBlockProof`](DynamicBlockProof.md) - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:94 - -#### Parameters - -##### \_\_namedParameters - -###### maxProofsVerified - -`0` \| `1` \| `2` - -###### proof - -`unknown` - -###### publicInput - -[`BlockProverPublicInput`](BlockProverPublicInput.md) - -###### publicOutput - -[`BlockProverPublicOutput`](BlockProverPublicOutput.md) - -#### Returns - -[`DynamicBlockProof`](DynamicBlockProof.md) - -#### Inherited from - -`DynamicProof< BlockProverPublicInput, BlockProverPublicOutput >.constructor` - -## Properties - -### maxProofsVerified - -> **maxProofsVerified**: `0` \| `1` \| `2` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:91 - -#### Inherited from - -`DynamicProof.maxProofsVerified` - -*** - -### proof - -> **proof**: `unknown` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:90 - -#### Inherited from - -`DynamicProof.proof` - -*** - -### publicInput - -> **publicInput**: [`BlockProverPublicInput`](BlockProverPublicInput.md) - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:88 - -#### Inherited from - -`DynamicProof.publicInput` - -*** - -### publicOutput - -> **publicOutput**: [`BlockProverPublicOutput`](BlockProverPublicOutput.md) - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:89 - -#### Inherited from - -`DynamicProof.publicOutput` - -*** - -### shouldVerify - -> **shouldVerify**: `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:92 - -#### Inherited from - -`DynamicProof.shouldVerify` - -*** - -### usedVerificationKey? - -> `optional` **usedVerificationKey**: `VerificationKey` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:180 - -#### Inherited from - -`DynamicProof.usedVerificationKey` - -*** - -### featureFlags - -> `static` **featureFlags**: `FeatureFlags` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:176 - -As the name indicates, feature flags are features of the proof system. - -If we want to side load proofs and verification keys, we first have to tell Pickles what _shape_ of proofs it should expect. - -For example, if we want to side load proofs that use foreign field arithmetic custom gates, we have to make Pickles aware of that by defining -these custom gates. - -_Note:_ Only proofs that use the exact same composition of custom gates which were expected by Pickles can be verified using side loading. -If you want to verify _any_ proof, no matter what custom gates it uses, you can use FeatureFlags.allMaybe. Please note that this might incur a significant overhead. - -You can also toggle specific feature flags manually by specifying them here. -Alternatively, you can use {@FeatureFlags.fromZkProgram} to compute the set of feature flags that are compatible with a given program. - -#### Inherited from - -`DynamicProof.featureFlags` - -*** - -### maxProofsVerified - -> `static` **maxProofsVerified**: `2` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L57) - -#### Overrides - -`DynamicProof.maxProofsVerified` - -*** - -### publicInputType - -> `static` **publicInputType**: *typeof* [`BlockProverPublicInput`](BlockProverPublicInput.md) = `BlockProverPublicInput` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L53) - -#### Overrides - -`DynamicProof.publicInputType` - -*** - -### publicOutputType - -> `static` **publicOutputType**: *typeof* [`BlockProverPublicOutput`](BlockProverPublicOutput.md) = `BlockProverPublicOutput` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L55) - -#### Overrides - -`DynamicProof.publicOutputType` - -## Methods - -### toJSON() - -> **toJSON**(): `JsonProof` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:93 - -#### Returns - -`JsonProof` - -#### Inherited from - -`DynamicProof.toJSON` - -*** - -### verify() - -> **verify**(`vk`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:185 - -Verifies this DynamicProof using a given verification key - -#### Parameters - -##### vk - -`VerificationKey` - -The verification key this proof will be verified against - -#### Returns - -`void` - -#### Inherited from - -`DynamicProof.verify` - -*** - -### verifyIf() - -> **verifyIf**(`vk`, `condition`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:186 - -#### Parameters - -##### vk - -`VerificationKey` - -##### condition - -`Bool` - -#### Returns - -`void` - -#### Inherited from - -`DynamicProof.verifyIf` - -*** - -### dummy() - -> `static` **dummy**\<`S`\>(`this`, `publicInput`, `publicOutput`, `maxProofsVerified`, `domainLog2`?): `Promise`\<`InstanceType`\<`S`\>\> - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:188 - -#### Type Parameters - -• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> - -#### Parameters - -##### this - -`S` - -##### publicInput - -`InferProvable`\<`S`\[`"publicInputType"`\]\> - -##### publicOutput - -`InferProvable`\<`S`\[`"publicOutputType"`\]\> - -##### maxProofsVerified - -`0` | `1` | `2` - -##### domainLog2? - -`number` - -#### Returns - -`Promise`\<`InstanceType`\<`S`\>\> - -#### Inherited from - -`DynamicProof.dummy` - -*** - -### fromJSON() - -> `static` **fromJSON**\<`S`\>(`this`, `__namedParameters`): `Promise`\<`DynamicProof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:187 - -#### Type Parameters - -• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> - -#### Parameters - -##### this - -`S` - -##### \_\_namedParameters - -`JsonProof` - -#### Returns - -`Promise`\<`DynamicProof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -#### Inherited from - -`DynamicProof.fromJSON` - -*** - -### fromProof() - -> `static` **fromProof**\<`S`\>(`this`, `proof`): `InstanceType`\<`S`\> - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:194 - -Converts a Proof into a DynamicProof carrying over all relevant data. -This method can be used to convert a Proof computed by a ZkProgram -into a DynamicProof that is accepted in a circuit that accepts DynamicProofs - -#### Type Parameters - -• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> - -#### Parameters - -##### this - -`S` - -##### proof - -`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\> - -#### Returns - -`InstanceType`\<`S`\> - -#### Inherited from - -`DynamicProof.fromProof` - -*** - -### tag() - -> `static` **tag**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:177 - -#### Returns - -`object` - -##### name - -> **name**: `string` - -#### Inherited from - -`DynamicProof.tag` diff --git a/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md b/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md deleted file mode 100644 index f2090fb..0000000 --- a/src/pages/docs/reference/protocol/classes/DynamicRuntimeProof.md +++ /dev/null @@ -1,380 +0,0 @@ ---- -title: DynamicRuntimeProof ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DynamicRuntimeProof - -# Class: DynamicRuntimeProof - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L63) - -## Extends - -- `DynamicProof`\<`Void`, [`MethodPublicOutput`](MethodPublicOutput.md)\> - -## Constructors - -### new DynamicRuntimeProof() - -> **new DynamicRuntimeProof**(`__namedParameters`): [`DynamicRuntimeProof`](DynamicRuntimeProof.md) - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:94 - -#### Parameters - -##### \_\_namedParameters - -###### maxProofsVerified - -`0` \| `1` \| `2` - -###### proof - -`unknown` - -###### publicInput - -`undefined` - -###### publicOutput - -[`MethodPublicOutput`](MethodPublicOutput.md) - -#### Returns - -[`DynamicRuntimeProof`](DynamicRuntimeProof.md) - -#### Inherited from - -`DynamicProof< Void, MethodPublicOutput >.constructor` - -## Properties - -### maxProofsVerified - -> **maxProofsVerified**: `0` \| `1` \| `2` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:91 - -#### Inherited from - -`DynamicProof.maxProofsVerified` - -*** - -### proof - -> **proof**: `unknown` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:90 - -#### Inherited from - -`DynamicProof.proof` - -*** - -### publicInput - -> **publicInput**: `undefined` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:88 - -#### Inherited from - -`DynamicProof.publicInput` - -*** - -### publicOutput - -> **publicOutput**: [`MethodPublicOutput`](MethodPublicOutput.md) - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:89 - -#### Inherited from - -`DynamicProof.publicOutput` - -*** - -### shouldVerify - -> **shouldVerify**: `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:92 - -#### Inherited from - -`DynamicProof.shouldVerify` - -*** - -### usedVerificationKey? - -> `optional` **usedVerificationKey**: `VerificationKey` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:180 - -#### Inherited from - -`DynamicProof.usedVerificationKey` - -*** - -### featureFlags - -> `static` **featureFlags**: `FeatureFlags` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:176 - -As the name indicates, feature flags are features of the proof system. - -If we want to side load proofs and verification keys, we first have to tell Pickles what _shape_ of proofs it should expect. - -For example, if we want to side load proofs that use foreign field arithmetic custom gates, we have to make Pickles aware of that by defining -these custom gates. - -_Note:_ Only proofs that use the exact same composition of custom gates which were expected by Pickles can be verified using side loading. -If you want to verify _any_ proof, no matter what custom gates it uses, you can use FeatureFlags.allMaybe. Please note that this might incur a significant overhead. - -You can also toggle specific feature flags manually by specifying them here. -Alternatively, you can use {@FeatureFlags.fromZkProgram} to compute the set of feature flags that are compatible with a given program. - -#### Inherited from - -`DynamicProof.featureFlags` - -*** - -### maxProofsVerified - -> `static` **maxProofsVerified**: `0` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L72) - -#### Overrides - -`DynamicProof.maxProofsVerified` - -*** - -### publicInputType - -> `static` **publicInputType**: `ProvablePureExtended`\<`void`, `void`, `null`\> = `Void` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L67) - -#### Overrides - -`DynamicProof.publicInputType` - -*** - -### publicOutputType - -> `static` **publicOutputType**: *typeof* [`MethodPublicOutput`](MethodPublicOutput.md) = `MethodPublicOutput` - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L69) - -#### Overrides - -`DynamicProof.publicOutputType` - -## Methods - -### toJSON() - -> **toJSON**(): `JsonProof` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:93 - -#### Returns - -`JsonProof` - -#### Inherited from - -`DynamicProof.toJSON` - -*** - -### verify() - -> **verify**(`vk`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:185 - -Verifies this DynamicProof using a given verification key - -#### Parameters - -##### vk - -`VerificationKey` - -The verification key this proof will be verified against - -#### Returns - -`void` - -#### Inherited from - -`DynamicProof.verify` - -*** - -### verifyIf() - -> **verifyIf**(`vk`, `condition`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:186 - -#### Parameters - -##### vk - -`VerificationKey` - -##### condition - -`Bool` - -#### Returns - -`void` - -#### Inherited from - -`DynamicProof.verifyIf` - -*** - -### dummy() - -> `static` **dummy**\<`S`\>(`this`, `publicInput`, `publicOutput`, `maxProofsVerified`, `domainLog2`?): `Promise`\<`InstanceType`\<`S`\>\> - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:188 - -#### Type Parameters - -• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> - -#### Parameters - -##### this - -`S` - -##### publicInput - -`InferProvable`\<`S`\[`"publicInputType"`\]\> - -##### publicOutput - -`InferProvable`\<`S`\[`"publicOutputType"`\]\> - -##### maxProofsVerified - -`0` | `1` | `2` - -##### domainLog2? - -`number` - -#### Returns - -`Promise`\<`InstanceType`\<`S`\>\> - -#### Inherited from - -`DynamicProof.dummy` - -*** - -### fromJSON() - -> `static` **fromJSON**\<`S`\>(`this`, `__namedParameters`): `Promise`\<`DynamicProof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:187 - -#### Type Parameters - -• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> - -#### Parameters - -##### this - -`S` - -##### \_\_namedParameters - -`JsonProof` - -#### Returns - -`Promise`\<`DynamicProof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -#### Inherited from - -`DynamicProof.fromJSON` - -*** - -### fromProof() - -> `static` **fromProof**\<`S`\>(`this`, `proof`): `InstanceType`\<`S`\> - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:194 - -Converts a Proof into a DynamicProof carrying over all relevant data. -This method can be used to convert a Proof computed by a ZkProgram -into a DynamicProof that is accepted in a circuit that accepts DynamicProofs - -#### Type Parameters - -• **S** *extends* `Subclass`\<*typeof* `DynamicProof`\> - -#### Parameters - -##### this - -`S` - -##### proof - -`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\> - -#### Returns - -`InstanceType`\<`S`\> - -#### Inherited from - -`DynamicProof.fromProof` - -*** - -### tag() - -> `static` **tag**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:177 - -#### Returns - -`object` - -##### name - -> **name**: `string` - -#### Inherited from - -`DynamicProof.tag` diff --git a/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md b/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md deleted file mode 100644 index e9d428d..0000000 --- a/src/pages/docs/reference/protocol/classes/LastStateRootBlockHook.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -title: LastStateRootBlockHook ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / LastStateRootBlockHook - -# Class: LastStateRootBlockHook - -Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L5) - -## Extends - -- [`ProvableBlockHook`](ProvableBlockHook.md)\<`Record`\<`string`, `never`\>\> - -## Constructors - -### new LastStateRootBlockHook() - -> **new LastStateRootBlockHook**(): [`LastStateRootBlockHook`](LastStateRootBlockHook.md) - -#### Returns - -[`LastStateRootBlockHook`](LastStateRootBlockHook.md) - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`constructor`](ProvableBlockHook.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Record`\<`string`, `never`\> - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`currentConfig`](ProvableBlockHook.md#currentconfig) - -*** - -### name? - -> `optional` **name**: `string` - -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`name`](ProvableBlockHook.md#name) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`protocol`](ProvableBlockHook.md#protocol) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`areProofsEnabled`](ProvableBlockHook.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`config`](ProvableBlockHook.md#config) - -## Methods - -### afterBlock() - -> **afterBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> - -Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L8) - -#### Parameters - -##### networkState - -[`NetworkState`](NetworkState.md) - -##### state - -[`BlockProverState`](../interfaces/BlockProverState.md) - -#### Returns - -`Promise`\<[`NetworkState`](NetworkState.md)\> - -#### Overrides - -[`ProvableBlockHook`](ProvableBlockHook.md).[`afterBlock`](ProvableBlockHook.md#afterblock) - -*** - -### beforeBlock() - -> **beforeBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> - -Defined in: [packages/protocol/src/hooks/LastStateRootBlockHook.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/hooks/LastStateRootBlockHook.ts#L20) - -#### Parameters - -##### networkState - -[`NetworkState`](NetworkState.md) - -##### state - -[`BlockProverState`](../interfaces/BlockProverState.md) - -#### Returns - -`Promise`\<[`NetworkState`](NetworkState.md)\> - -#### Overrides - -[`ProvableBlockHook`](ProvableBlockHook.md).[`beforeBlock`](ProvableBlockHook.md#beforeblock) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`create`](ProvableBlockHook.md#create) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ProvableBlockHook`](ProvableBlockHook.md).[`start`](ProvableBlockHook.md#start) diff --git a/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md b/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md deleted file mode 100644 index f19b36d..0000000 --- a/src/pages/docs/reference/protocol/classes/MethodPublicOutput.md +++ /dev/null @@ -1,680 +0,0 @@ ---- -title: MethodPublicOutput ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MethodPublicOutput - -# Class: MethodPublicOutput - -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L7) - -Public input used to link in-circuit execution with -the proof's public input. - -## Extends - -- `object` - -## Constructors - -### new MethodPublicOutput() - -> **new MethodPublicOutput**(`value`): [`MethodPublicOutput`](MethodPublicOutput.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### eventsHash - -`Field` = `Field` - -###### isMessage - -`Bool` = `Bool` - -###### networkStateHash - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -###### status - -`Bool` = `Bool` - -###### transactionHash - -`Field` = `Field` - -#### Returns - -[`MethodPublicOutput`](MethodPublicOutput.md) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).constructor` - -## Properties - -### eventsHash - -> **eventsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L13) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).eventsHash` - -*** - -### isMessage - -> **isMessage**: `Bool` = `Bool` - -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L12) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).isMessage` - -*** - -### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L11) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).networkStateHash` - -*** - -### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L8) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).stateTransitionsHash` - -*** - -### status - -> **status**: `Bool` = `Bool` - -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L9) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).status` - -*** - -### transactionHash - -> **transactionHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/model/MethodPublicOutput.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/MethodPublicOutput.ts#L10) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).transactionHash` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### eventsHash - -`Field` = `Field` - -###### isMessage - -`Bool` = `Bool` - -###### networkStateHash - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -###### status - -`Bool` = `Bool` - -###### transactionHash - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### eventsHash - -> **eventsHash**: `Field` = `Field` - -##### isMessage - -> **isMessage**: `Bool` = `Bool` - -##### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -##### status - -> **status**: `Bool` = `Bool` - -##### transactionHash - -> **transactionHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### eventsHash - -> **eventsHash**: `Field` = `Field` - -##### isMessage - -> **isMessage**: `Bool` = `Bool` - -##### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -##### status - -> **status**: `Bool` = `Bool` - -##### transactionHash - -> **transactionHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### eventsHash - -`string` = `Field` - -###### isMessage - -`boolean` = `Bool` - -###### networkStateHash - -`string` = `Field` - -###### stateTransitionsHash - -`string` = `Field` - -###### status - -`boolean` = `Bool` - -###### transactionHash - -`string` = `Field` - -#### Returns - -`object` - -##### eventsHash - -> **eventsHash**: `Field` = `Field` - -##### isMessage - -> **isMessage**: `Bool` = `Bool` - -##### networkStateHash - -> **networkStateHash**: `Field` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -##### status - -> **status**: `Bool` = `Bool` - -##### transactionHash - -> **transactionHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### eventsHash - -`Field` = `Field` - -###### isMessage - -`Bool` = `Bool` - -###### networkStateHash - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -###### status - -`Bool` = `Bool` - -###### transactionHash - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### eventsHash - -`Field` = `Field` - -###### isMessage - -`Bool` = `Bool` - -###### networkStateHash - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -###### status - -`Bool` = `Bool` - -###### transactionHash - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### eventsHash - -`Field` = `Field` - -###### isMessage - -`Bool` = `Bool` - -###### networkStateHash - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -###### status - -`Bool` = `Bool` - -###### transactionHash - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### eventsHash - -`Field` = `Field` - -###### isMessage - -`Bool` = `Bool` - -###### networkStateHash - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -###### status - -`Bool` = `Bool` - -###### transactionHash - -`Field` = `Field` - -#### Returns - -`object` - -##### eventsHash - -> **eventsHash**: `string` = `Field` - -##### isMessage - -> **isMessage**: `boolean` = `Bool` - -##### networkStateHash - -> **networkStateHash**: `string` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `string` = `Field` - -##### status - -> **status**: `boolean` = `Bool` - -##### transactionHash - -> **transactionHash**: `string` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### eventsHash - -`Field` = `Field` - -###### isMessage - -`Bool` = `Bool` - -###### networkStateHash - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -###### status - -`Bool` = `Bool` - -###### transactionHash - -`Field` = `Field` - -#### Returns - -`object` - -##### eventsHash - -> **eventsHash**: `bigint` = `Field` - -##### isMessage - -> **isMessage**: `boolean` = `Bool` - -##### networkStateHash - -> **networkStateHash**: `bigint` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `bigint` = `Field` - -##### status - -> **status**: `boolean` = `Bool` - -##### transactionHash - -> **transactionHash**: `bigint` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, status: Bool, transactionHash: Field, networkStateHash: Field, isMessage: Bool, eventsHash: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md b/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md deleted file mode 100644 index f96153d..0000000 --- a/src/pages/docs/reference/protocol/classes/MethodVKConfigData.md +++ /dev/null @@ -1,433 +0,0 @@ ---- -title: MethodVKConfigData ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MethodVKConfigData - -# Class: MethodVKConfigData - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L13) - -## Extends - -- `object` - -## Constructors - -### new MethodVKConfigData() - -> **new MethodVKConfigData**(`value`): [`MethodVKConfigData`](MethodVKConfigData.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### methodId - -`Field` = `Field` - -###### vkHash - -`Field` = `Field` - -#### Returns - -[`MethodVKConfigData`](MethodVKConfigData.md) - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).constructor` - -## Properties - -### methodId - -> **methodId**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L14) - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).methodId` - -*** - -### vkHash - -> **vkHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L15) - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).vkHash` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### methodId - -`Field` = `Field` - -###### vkHash - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### methodId - -> **methodId**: `Field` = `Field` - -##### vkHash - -> **vkHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### methodId - -> **methodId**: `Field` = `Field` - -##### vkHash - -> **vkHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### methodId - -`string` = `Field` - -###### vkHash - -`string` = `Field` - -#### Returns - -`object` - -##### methodId - -> **methodId**: `Field` = `Field` - -##### vkHash - -> **vkHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### methodId - -`Field` = `Field` - -###### vkHash - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### methodId - -`Field` = `Field` - -###### vkHash - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### methodId - -`Field` = `Field` - -###### vkHash - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### methodId - -`Field` = `Field` - -###### vkHash - -`Field` = `Field` - -#### Returns - -`object` - -##### methodId - -> **methodId**: `string` = `Field` - -##### vkHash - -> **vkHash**: `string` = `Field` - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### methodId - -`Field` = `Field` - -###### vkHash - -`Field` = `Field` - -#### Returns - -`object` - -##### methodId - -> **methodId**: `bigint` = `Field` - -##### vkHash - -> **vkHash**: `bigint` = `Field` - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).toValue` - -## Methods - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L17) - -#### Returns - -`Field` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ methodId: Field, vkHash: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/MinaActions.md b/src/pages/docs/reference/protocol/classes/MinaActions.md deleted file mode 100644 index dfba8e8..0000000 --- a/src/pages/docs/reference/protocol/classes/MinaActions.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: MinaActions ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MinaActions - -# Class: MinaActions - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L28) - -## Constructors - -### new MinaActions() - -> **new MinaActions**(): [`MinaActions`](MinaActions.md) - -#### Returns - -[`MinaActions`](MinaActions.md) - -## Methods - -### actionHash() - -> `static` **actionHash**(`action`, `previousHash`): `Field` - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L29) - -#### Parameters - -##### action - -`Field`[] - -##### previousHash - -`Field` = `...` - -#### Returns - -`Field` diff --git a/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md b/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md deleted file mode 100644 index 6495778..0000000 --- a/src/pages/docs/reference/protocol/classes/MinaActionsHashList.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -title: MinaActionsHashList ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MinaActionsHashList - -# Class: MinaActionsHashList - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L69) - -Utilities for creating a hash list from a given value type. - -## Extends - -- [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Field`\> - -## Constructors - -### new MinaActionsHashList() - -> **new MinaActionsHashList**(`internalCommitment`): [`MinaActionsHashList`](MinaActionsHashList.md) - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L70) - -#### Parameters - -##### internalCommitment - -`Field` = `...` - -#### Returns - -[`MinaActionsHashList`](MinaActionsHashList.md) - -#### Overrides - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`constructor`](MinaPrefixedProvableHashList.md#constructors) - -## Properties - -### commitment - -> **commitment**: `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) - -#### Inherited from - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`commitment`](MinaPrefixedProvableHashList.md#commitment) - -*** - -### prefix - -> `readonly` **prefix**: `string` - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) - -#### Inherited from - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`prefix`](MinaPrefixedProvableHashList.md#prefix-1) - -*** - -### valueType - -> `protected` `readonly` **valueType**: `ProvablePure`\<`Field`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) - -#### Inherited from - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`valueType`](MinaPrefixedProvableHashList.md#valuetype-1) - -## Methods - -### hash() - -> `protected` **hash**(`elements`): `Field` - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) - -#### Parameters - -##### elements - -`Field`[] - -#### Returns - -`Field` - -#### Inherited from - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`hash`](MinaPrefixedProvableHashList.md#hash) - -*** - -### push() - -> **push**(`value`): [`MinaActionsHashList`](MinaActionsHashList.md) - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) - -Converts the provided value to Field[] and appends it to -the current hashlist. - -#### Parameters - -##### value - -`Field` - -Value to be appended to the hash list - -#### Returns - -[`MinaActionsHashList`](MinaActionsHashList.md) - -Current hash list. - -#### Inherited from - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`push`](MinaPrefixedProvableHashList.md#push) - -*** - -### pushIf() - -> **pushIf**(`value`, `condition`): [`MinaActionsHashList`](MinaActionsHashList.md) - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L29) - -#### Parameters - -##### value - -`Field` - -##### condition - -`Bool` - -#### Returns - -[`MinaActionsHashList`](MinaActionsHashList.md) - -#### Inherited from - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`pushIf`](MinaPrefixedProvableHashList.md#pushif) - -*** - -### toField() - -> **toField**(): `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) - -#### Returns - -`Field` - -Traling hash of the current hashlist. - -#### Inherited from - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md).[`toField`](MinaPrefixedProvableHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/MinaEvents.md b/src/pages/docs/reference/protocol/classes/MinaEvents.md deleted file mode 100644 index e03a8d5..0000000 --- a/src/pages/docs/reference/protocol/classes/MinaEvents.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: MinaEvents ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MinaEvents - -# Class: MinaEvents - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L41) - -## Constructors - -### new MinaEvents() - -> **new MinaEvents**(): [`MinaEvents`](MinaEvents.md) - -#### Returns - -[`MinaEvents`](MinaEvents.md) - -## Methods - -### eventHash() - -> `static` **eventHash**(`event`, `previousHash`): `Field` - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L42) - -#### Parameters - -##### event - -`Field`[] - -##### previousHash - -`Field` = `...` - -#### Returns - -`Field` diff --git a/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md b/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md deleted file mode 100644 index 3ddc274..0000000 --- a/src/pages/docs/reference/protocol/classes/MinaPrefixedProvableHashList.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -title: MinaPrefixedProvableHashList ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MinaPrefixedProvableHashList - -# Class: MinaPrefixedProvableHashList\ - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L51) - -Utilities for creating a hash list from a given value type. - -## Extends - -- [`ProvableHashList`](ProvableHashList.md)\<`Value`\> - -## Extended by - -- [`MinaActionsHashList`](MinaActionsHashList.md) - -## Type Parameters - -• **Value** - -## Constructors - -### new MinaPrefixedProvableHashList() - -> **new MinaPrefixedProvableHashList**\<`Value`\>(`valueType`, `prefix`, `internalCommitment`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L54) - -#### Parameters - -##### valueType - -`ProvablePure`\<`Value`\> - -##### prefix - -`string` - -##### internalCommitment - -`Field` = `...` - -#### Returns - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> - -#### Overrides - -[`ProvableHashList`](ProvableHashList.md).[`constructor`](ProvableHashList.md#constructors) - -## Properties - -### commitment - -> **commitment**: `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`commitment`](ProvableHashList.md#commitment-1) - -*** - -### prefix - -> `readonly` **prefix**: `string` - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L56) - -*** - -### valueType - -> `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`valueType`](ProvableHashList.md#valuetype-1) - -## Methods - -### hash() - -> `protected` **hash**(`elements`): `Field` - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L62) - -#### Parameters - -##### elements - -`Field`[] - -#### Returns - -`Field` - -#### Overrides - -[`ProvableHashList`](ProvableHashList.md).[`hash`](ProvableHashList.md#hash) - -*** - -### push() - -> **push**(`value`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) - -Converts the provided value to Field[] and appends it to -the current hashlist. - -#### Parameters - -##### value - -`Value` - -Value to be appended to the hash list - -#### Returns - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> - -Current hash list. - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`push`](ProvableHashList.md#push) - -*** - -### pushIf() - -> **pushIf**(`value`, `condition`): [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L29) - -#### Parameters - -##### value - -`Value` - -##### condition - -`Bool` - -#### Returns - -[`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md)\<`Value`\> - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`pushIf`](ProvableHashList.md#pushif) - -*** - -### toField() - -> **toField**(): `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) - -#### Returns - -`Field` - -Traling hash of the current hashlist. - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`toField`](ProvableHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/NetworkState.md b/src/pages/docs/reference/protocol/classes/NetworkState.md deleted file mode 100644 index 1623e7b..0000000 --- a/src/pages/docs/reference/protocol/classes/NetworkState.md +++ /dev/null @@ -1,449 +0,0 @@ ---- -title: NetworkState ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / NetworkState - -# Class: NetworkState - -Defined in: [packages/protocol/src/model/network/NetworkState.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L12) - -## Extends - -- `object` - -## Constructors - -### new NetworkState() - -> **new NetworkState**(`value`): [`NetworkState`](NetworkState.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### block - -[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` - -###### previous - -[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` - -#### Returns - -[`NetworkState`](NetworkState.md) - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).constructor` - -## Properties - -### block - -> **block**: [`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` - -Defined in: [packages/protocol/src/model/network/NetworkState.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L13) - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).block` - -*** - -### previous - -> **previous**: [`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` - -Defined in: [packages/protocol/src/model/network/NetworkState.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L14) - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).previous` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### block - -[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` - -###### previous - -[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).check` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### block - -> **block**: [`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` - -##### previous - -> **previous**: [`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### block - -\{ `height`: `string`; \} = `CurrentBlock` - -###### block.height - -`string` = `UInt64` - -###### previous - -\{ `rootHash`: `string`; \} = `PreviousBlock` - -###### previous.rootHash - -`string` = `Field` - -#### Returns - -`object` - -##### block - -> **block**: [`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` - -##### previous - -> **previous**: [`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### block - -[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` - -###### previous - -[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### block - -[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` - -###### previous - -[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### block - -[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` - -###### previous - -[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### block - -[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` - -###### previous - -[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` - -#### Returns - -`object` - -##### block - -> **block**: `object` = `CurrentBlock` - -###### block.height - -> **block.height**: `string` = `UInt64` - -##### previous - -> **previous**: `object` = `PreviousBlock` - -###### previous.rootHash - -> **previous.rootHash**: `string` = `Field` - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### block - -[`CurrentBlock`](CurrentBlock.md) = `CurrentBlock` - -###### previous - -[`PreviousBlock`](PreviousBlock.md) = `PreviousBlock` - -#### Returns - -`object` - -##### block - -> **block**: `object` = `CurrentBlock` - -###### block.height - -> **block.height**: `bigint` = `UInt64` - -##### previous - -> **previous**: `object` = `PreviousBlock` - -###### previous.rootHash - -> **previous.rootHash**: `bigint` = `Field` - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).toValue` - -## Methods - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/protocol/src/model/network/NetworkState.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L16) - -#### Returns - -`Field` - -*** - -### empty() - -> `static` **empty**(): [`NetworkState`](NetworkState.md) - -Defined in: [packages/protocol/src/model/network/NetworkState.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L23) - -#### Returns - -[`NetworkState`](NetworkState.md) - -#### Overrides - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).empty` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ block: CurrentBlock, previous: PreviousBlock, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md b/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md deleted file mode 100644 index b300815..0000000 --- a/src/pages/docs/reference/protocol/classes/NetworkStateSettlementModule.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -title: NetworkStateSettlementModule ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / NetworkStateSettlementModule - -# Class: NetworkStateSettlementModule - -Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L14) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ProvableSettlementHook`](ProvableSettlementHook.md)\<`NetworkStateSettlementModuleConfig`\> - -## Constructors - -### new NetworkStateSettlementModule() - -> **new NetworkStateSettlementModule**(): [`NetworkStateSettlementModule`](NetworkStateSettlementModule.md) - -#### Returns - -[`NetworkStateSettlementModule`](NetworkStateSettlementModule.md) - -#### Inherited from - -[`ProvableSettlementHook`](ProvableSettlementHook.md).[`constructor`](ProvableSettlementHook.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `NetworkStateSettlementModuleConfig` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProvableSettlementHook`](ProvableSettlementHook.md).[`currentConfig`](ProvableSettlementHook.md#currentconfig) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Inherited from - -[`ProvableSettlementHook`](ProvableSettlementHook.md).[`protocol`](ProvableSettlementHook.md#protocol) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -[`ProvableSettlementHook`](ProvableSettlementHook.md).[`areProofsEnabled`](ProvableSettlementHook.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProvableSettlementHook`](ProvableSettlementHook.md).[`config`](ProvableSettlementHook.md#config) - -## Methods - -### beforeSettlement() - -> **beforeSettlement**(`smartContract`, `__namedParameters`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts#L15) - -#### Parameters - -##### smartContract - -[`SettlementSmartContract`](SettlementSmartContract.md) - -##### \_\_namedParameters - -[`SettlementHookInputs`](../type-aliases/SettlementHookInputs.md) - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`ProvableSettlementHook`](ProvableSettlementHook.md).[`beforeSettlement`](ProvableSettlementHook.md#beforesettlement) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProvableSettlementHook`](ProvableSettlementHook.md).[`create`](ProvableSettlementHook.md#create) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ProvableSettlementHook`](ProvableSettlementHook.md).[`start`](ProvableSettlementHook.md#start) diff --git a/src/pages/docs/reference/protocol/classes/Option.md b/src/pages/docs/reference/protocol/classes/Option.md deleted file mode 100644 index 87998cb..0000000 --- a/src/pages/docs/reference/protocol/classes/Option.md +++ /dev/null @@ -1,341 +0,0 @@ ---- -title: Option ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Option - -# Class: Option\ - -Defined in: [packages/protocol/src/model/Option.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L84) - -Option facilitating in-circuit values that may or may not exist. - -## Extends - -- [`OptionBase`](OptionBase.md) - -## Type Parameters - -• **Value** - -## Constructors - -### new Option() - -> **new Option**\<`Value`\>(`isSome`, `value`, `valueType`, `isForcedSome`): [`Option`](Option.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/Option.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L122) - -#### Parameters - -##### isSome - -`Bool` - -##### value - -`Value` - -##### valueType - -`FlexibleProvablePure`\<`Value`\> - -##### isForcedSome - -`Bool` = `...` - -#### Returns - -[`Option`](Option.md)\<`Value`\> - -#### Overrides - -[`OptionBase`](OptionBase.md).[`constructor`](OptionBase.md#constructors) - -## Properties - -### isForcedSome - -> **isForcedSome**: `Bool` - -Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L24) - -#### Inherited from - -[`OptionBase`](OptionBase.md).[`isForcedSome`](OptionBase.md#isforcedsome-1) - -*** - -### isSome - -> **isSome**: `Bool` - -Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L23) - -#### Inherited from - -[`OptionBase`](OptionBase.md).[`isSome`](OptionBase.md#issome-1) - -*** - -### value - -> **value**: `Value` - -Defined in: [packages/protocol/src/model/Option.ts:124](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L124) - -*** - -### valueType - -> **valueType**: `FlexibleProvablePure`\<`Value`\> - -Defined in: [packages/protocol/src/model/Option.ts:125](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L125) - -## Accessors - -### treeValue - -#### Get Signature - -> **get** **treeValue**(): `Field` - -Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L34) - -##### Returns - -`Field` - -Tree representation of the current value - -#### Inherited from - -[`OptionBase`](OptionBase.md).[`treeValue`](OptionBase.md#treevalue) - -## Methods - -### clone() - -> **clone**(): [`Option`](Option.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/Option.ts:135](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L135) - -#### Returns - -[`Option`](Option.md)\<`Value`\> - -#### Overrides - -[`OptionBase`](OptionBase.md).[`clone`](OptionBase.md#clone) - -*** - -### encodeValueToFields() - -> **encodeValueToFields**(): `Field`[] - -Defined in: [packages/protocol/src/model/Option.ts:131](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L131) - -#### Returns - -`Field`[] - -#### Overrides - -[`OptionBase`](OptionBase.md).[`encodeValueToFields`](OptionBase.md#encodevaluetofields) - -*** - -### forceSome() - -> **forceSome**(): `void` - -Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L44) - -#### Returns - -`void` - -#### Inherited from - -[`OptionBase`](OptionBase.md).[`forceSome`](OptionBase.md#forcesome) - -*** - -### orElse() - -> **orElse**(`defaultValue`): `Value` - -Defined in: [packages/protocol/src/model/Option.ts:148](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L148) - -#### Parameters - -##### defaultValue - -`Value` - -#### Returns - -`Value` - -Returns the value of this option if it isSome, -otherwise returns the given defaultValue - -*** - -### toConstant() - -> **toConstant**(): [`Option`](Option.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/Option.ts:157](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L157) - -#### Returns - -[`Option`](Option.md)\<`Value`\> - -*** - -### toFields() - -> **toFields**(): `Field`[] - -Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L53) - -Returns the `to`-value as decoded as a list of fields -Not in circuit - -#### Returns - -`Field`[] - -#### Inherited from - -[`OptionBase`](OptionBase.md).[`toFields`](OptionBase.md#tofields) - -*** - -### toJSON() - -> **toJSON**(): `object` - -Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L70) - -#### Returns - -`object` - -##### isForcedSome - -> **isForcedSome**: `boolean` - -##### isSome - -> **isSome**: `boolean` - -##### value - -> **value**: `string`[] - -#### Inherited from - -[`OptionBase`](OptionBase.md).[`toJSON`](OptionBase.md#tojson) - -*** - -### toProvable() - -> **toProvable**(): [`ProvableOption`](ProvableOption.md) - -Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L63) - -#### Returns - -[`ProvableOption`](ProvableOption.md) - -Provable representation of the current option. - -#### Inherited from - -[`OptionBase`](OptionBase.md).[`toProvable`](OptionBase.md#toprovable) - -*** - -### from() - -> `static` **from**\<`Value`\>(`isSome`, `value`, `valueType`): [`Option`](Option.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/Option.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L93) - -Creates a new Option from the provided parameters - -#### Type Parameters - -• **Value** - -#### Parameters - -##### isSome - -`Bool` - -##### value - -`Value` - -##### valueType - -`FlexibleProvablePure`\<`Value`\> - -#### Returns - -[`Option`](Option.md)\<`Value`\> - -New option from the provided parameters. - -*** - -### fromValue() - -> `static` **fromValue**\<`Value`\>(`value`, `valueType`): [`Option`](Option.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/Option.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L108) - -Creates a new Option from the provided parameters - -#### Type Parameters - -• **Value** - -#### Parameters - -##### value - -`Value` - -##### valueType - -`FlexibleProvablePure`\<`Value`\> - -#### Returns - -[`Option`](Option.md)\<`Value`\> - -New option from the provided parameters. - -*** - -### none() - -> `static` **none**(): [`Option`](Option.md)\<`Field`\> - -Defined in: [packages/protocol/src/model/Option.ts:118](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L118) - -#### Returns - -[`Option`](Option.md)\<`Field`\> - -Empty / none option diff --git a/src/pages/docs/reference/protocol/classes/OptionBase.md b/src/pages/docs/reference/protocol/classes/OptionBase.md deleted file mode 100644 index 2f47fd0..0000000 --- a/src/pages/docs/reference/protocol/classes/OptionBase.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -title: OptionBase ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / OptionBase - -# Class: `abstract` OptionBase - -Defined in: [packages/protocol/src/model/Option.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L21) - -## Extended by - -- [`Option`](Option.md) -- [`UntypedOption`](../../sequencer/classes/UntypedOption.md) - -## Constructors - -### new OptionBase() - -> `protected` **new OptionBase**(`isSome`, `isForcedSome`): [`OptionBase`](OptionBase.md) - -Defined in: [packages/protocol/src/model/Option.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L22) - -#### Parameters - -##### isSome - -`Bool` - -##### isForcedSome - -`Bool` - -#### Returns - -[`OptionBase`](OptionBase.md) - -## Properties - -### isForcedSome - -> **isForcedSome**: `Bool` - -Defined in: [packages/protocol/src/model/Option.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L24) - -*** - -### isSome - -> **isSome**: `Bool` - -Defined in: [packages/protocol/src/model/Option.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L23) - -## Accessors - -### treeValue - -#### Get Signature - -> **get** **treeValue**(): `Field` - -Defined in: [packages/protocol/src/model/Option.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L34) - -##### Returns - -`Field` - -Tree representation of the current value - -## Methods - -### clone() - -> `abstract` `protected` **clone**(): [`OptionBase`](OptionBase.md) - -Defined in: [packages/protocol/src/model/Option.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L29) - -#### Returns - -[`OptionBase`](OptionBase.md) - -*** - -### encodeValueToFields() - -> `abstract` `protected` **encodeValueToFields**(): `Field`[] - -Defined in: [packages/protocol/src/model/Option.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L27) - -#### Returns - -`Field`[] - -*** - -### forceSome() - -> **forceSome**(): `void` - -Defined in: [packages/protocol/src/model/Option.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L44) - -#### Returns - -`void` - -*** - -### toFields() - -> **toFields**(): `Field`[] - -Defined in: [packages/protocol/src/model/Option.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L53) - -Returns the `to`-value as decoded as a list of fields -Not in circuit - -#### Returns - -`Field`[] - -*** - -### toJSON() - -> **toJSON**(): `object` - -Defined in: [packages/protocol/src/model/Option.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L70) - -#### Returns - -`object` - -##### isForcedSome - -> **isForcedSome**: `boolean` - -##### isSome - -> **isSome**: `boolean` - -##### value - -> **value**: `string`[] - -*** - -### toProvable() - -> **toProvable**(): [`ProvableOption`](ProvableOption.md) - -Defined in: [packages/protocol/src/model/Option.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L63) - -#### Returns - -[`ProvableOption`](ProvableOption.md) - -Provable representation of the current option. diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md deleted file mode 100644 index 85832da..0000000 --- a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgument.md +++ /dev/null @@ -1,501 +0,0 @@ ---- -title: OutgoingMessageArgument ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / OutgoingMessageArgument - -# Class: OutgoingMessageArgument - -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L8) - -## Extends - -- `object` - -## Constructors - -### new OutgoingMessageArgument() - -> **new OutgoingMessageArgument**(`value`): [`OutgoingMessageArgument`](OutgoingMessageArgument.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### value - -[`Withdrawal`](Withdrawal.md) = `Withdrawal` - -###### witness - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -#### Returns - -[`OutgoingMessageArgument`](OutgoingMessageArgument.md) - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).constructor` - -## Properties - -### value - -> **value**: [`Withdrawal`](Withdrawal.md) = `Withdrawal` - -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L10) - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).value` - -*** - -### witness - -> **witness**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L9) - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).witness` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### value - -[`Withdrawal`](Withdrawal.md) = `Withdrawal` - -###### witness - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### value - -> **value**: [`Withdrawal`](Withdrawal.md) = `Withdrawal` - -##### witness - -> **witness**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### value - -> **value**: [`Withdrawal`](Withdrawal.md) = `Withdrawal` - -##### witness - -> **witness**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### value - -\{ `address`: `string`; `amount`: `string`; `tokenId`: `string`; \} = `Withdrawal` - -###### value.address - -`string` = `PublicKey` - -###### value.amount - -`string` = `UInt64` - -###### value.tokenId - -`string` = `Field` - -###### witness - -\{ `isLeft`: `boolean`[]; `path`: `string`[]; \} = `RollupMerkleTreeWitness` - -###### witness.isLeft - -`boolean`[] - -###### witness.path - -`string`[] - -#### Returns - -`object` - -##### value - -> **value**: [`Withdrawal`](Withdrawal.md) = `Withdrawal` - -##### witness - -> **witness**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### value - -[`Withdrawal`](Withdrawal.md) = `Withdrawal` - -###### witness - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### value - -[`Withdrawal`](Withdrawal.md) = `Withdrawal` - -###### witness - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### value - -[`Withdrawal`](Withdrawal.md) = `Withdrawal` - -###### witness - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### value - -[`Withdrawal`](Withdrawal.md) = `Withdrawal` - -###### witness - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -#### Returns - -`object` - -##### value - -> **value**: `object` = `Withdrawal` - -###### value.address - -> **value.address**: `string` = `PublicKey` - -###### value.amount - -> **value.amount**: `string` = `UInt64` - -###### value.tokenId - -> **value.tokenId**: `string` = `Field` - -##### witness - -> **witness**: `object` = `RollupMerkleTreeWitness` - -###### witness.isLeft - -> **witness.isLeft**: `boolean`[] - -###### witness.path - -> **witness.path**: `string`[] - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### value - -[`Withdrawal`](Withdrawal.md) = `Withdrawal` - -###### witness - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) = `RollupMerkleTreeWitness` - -#### Returns - -`object` - -##### value - -> **value**: `object` = `Withdrawal` - -###### value.address - -> **value.address**: `object` = `PublicKey` - -###### value.address.isOdd - -> **value.address.isOdd**: `boolean` - -###### value.address.x - -> **value.address.x**: `bigint` - -###### value.amount - -> **value.amount**: `bigint` = `UInt64` - -###### value.tokenId - -> **value.tokenId**: `bigint` = `Field` - -##### witness - -> **witness**: `object` = `RollupMerkleTreeWitness` - -###### witness.isLeft - -> **witness.isLeft**: `boolean`[] - -###### witness.path - -> **witness.path**: `bigint`[] - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).toValue` - -## Methods - -### dummy() - -> `static` **dummy**(): [`OutgoingMessageArgument`](OutgoingMessageArgument.md) - -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L12) - -#### Returns - -[`OutgoingMessageArgument`](OutgoingMessageArgument.md) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ witness: RollupMerkleTreeWitness, value: Withdrawal, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md deleted file mode 100644 index d9f9ccf..0000000 --- a/src/pages/docs/reference/protocol/classes/OutgoingMessageArgumentBatch.md +++ /dev/null @@ -1,439 +0,0 @@ ---- -title: OutgoingMessageArgumentBatch ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / OutgoingMessageArgumentBatch - -# Class: OutgoingMessageArgumentBatch - -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L20) - -## Extends - -- `object` - -## Constructors - -### new OutgoingMessageArgumentBatch() - -> **new OutgoingMessageArgumentBatch**(`value`): [`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### arguments - -[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` - -###### isDummys - -`Bool`[] = `...` - -#### Returns - -[`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).constructor` - -## Properties - -### arguments - -> **arguments**: [`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] - -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L21) - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).arguments` - -*** - -### isDummys - -> **isDummys**: `Bool`[] - -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L26) - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).isDummys` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### arguments - -[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` - -###### isDummys - -`Bool`[] = `...` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### arguments - -> **arguments**: [`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] - -##### isDummys - -> **isDummys**: `Bool`[] - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### arguments - -> **arguments**: [`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] - -##### isDummys - -> **isDummys**: `Bool`[] - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### arguments - -`object`[] = `...` - -###### isDummys - -`boolean`[] = `...` - -#### Returns - -`object` - -##### arguments - -> **arguments**: [`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] - -##### isDummys - -> **isDummys**: `Bool`[] - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### arguments - -[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` - -###### isDummys - -`Bool`[] = `...` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### arguments - -[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` - -###### isDummys - -`Bool`[] = `...` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### arguments - -[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` - -###### isDummys - -`Bool`[] = `...` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### arguments - -[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` - -###### isDummys - -`Bool`[] = `...` - -#### Returns - -`object` - -##### arguments - -> **arguments**: `object`[] - -##### isDummys - -> **isDummys**: `boolean`[] - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### arguments - -[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] = `...` - -###### isDummys - -`Bool`[] = `...` - -#### Returns - -`object` - -##### arguments - -> **arguments**: `object`[] - -##### isDummys - -> **isDummys**: `boolean`[] - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).toValue` - -## Methods - -### fromMessages() - -> `static` **fromMessages**(`providedArguments`): [`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) - -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L28) - -#### Parameters - -##### providedArguments - -[`OutgoingMessageArgument`](OutgoingMessageArgument.md)[] - -#### Returns - -[`OutgoingMessageArgumentBatch`](OutgoingMessageArgumentBatch.md) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ arguments: Provable.Array( OutgoingMessageArgument, OUTGOING_MESSAGE_BATCH_SIZE ), isDummys: Provable.Array(Bool, OUTGOING_MESSAGE_BATCH_SIZE), }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md b/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md deleted file mode 100644 index 510b7b4..0000000 --- a/src/pages/docs/reference/protocol/classes/OutgoingMessageKey.md +++ /dev/null @@ -1,421 +0,0 @@ ---- -title: OutgoingMessageKey ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / OutgoingMessageKey - -# Class: OutgoingMessageKey - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L49) - -## Extends - -- `object` - -## Constructors - -### new OutgoingMessageKey() - -> **new OutgoingMessageKey**(`value`): [`OutgoingMessageKey`](OutgoingMessageKey.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -[`OutgoingMessageKey`](OutgoingMessageKey.md) - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).constructor` - -## Properties - -### index - -> **index**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L50) - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).index` - -*** - -### tokenId - -> **tokenId**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L51) - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).tokenId` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### index - -`string` = `Field` - -###### tokenId - -`string` = `Field` - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### index - -> **index**: `string` = `Field` - -##### tokenId - -> **tokenId**: `string` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### index - -> **index**: `bigint` = `Field` - -##### tokenId - -> **tokenId**: `bigint` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/Path.md b/src/pages/docs/reference/protocol/classes/Path.md deleted file mode 100644 index 563cea8..0000000 --- a/src/pages/docs/reference/protocol/classes/Path.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: Path ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Path - -# Class: Path - -Defined in: [packages/protocol/src/model/Path.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Path.ts#L8) - -Helps manage path (key) identifiers for key-values in trees. - -## Constructors - -### new Path() - -> **new Path**(): [`Path`](Path.md) - -#### Returns - -[`Path`](Path.md) - -## Methods - -### fromKey() - -> `static` **fromKey**\<`KeyType`\>(`path`, `keyType`, `key`): `Field` - -Defined in: [packages/protocol/src/model/Path.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Path.ts#L42) - -Encodes an existing path with the provided key into a single Field. - -#### Type Parameters - -• **KeyType** - -#### Parameters - -##### path - -`Field` - -##### keyType - -`FlexibleProvablePure`\<`KeyType`\> - -##### key - -`KeyType` - -#### Returns - -`Field` - -Field representation of the leading path + the provided key. - -*** - -### fromProperty() - -> `static` **fromProperty**(`className`, `propertyKey`): `Field` - -Defined in: [packages/protocol/src/model/Path.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Path.ts#L26) - -Encodes a class name and its property name into a Field - -#### Parameters - -##### className - -`string` - -##### propertyKey - -`string` - -#### Returns - -`Field` - -Field representation of class name + property name - -*** - -### toField() - -> `static` **toField**(`value`): `Field` - -Defined in: [packages/protocol/src/model/Path.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Path.ts#L15) - -Encodes a JS string as a Field - -#### Parameters - -##### value - -`string` - -#### Returns - -`Field` - -Field representation of the provided value diff --git a/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md b/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md deleted file mode 100644 index 48c5969..0000000 --- a/src/pages/docs/reference/protocol/classes/PrefixedProvableHashList.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -title: PrefixedProvableHashList ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / PrefixedProvableHashList - -# Class: PrefixedProvableHashList\ - -Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/PrefixedProvableHashList.ts#L6) - -Utilities for creating a hash list from a given value type. - -## Extends - -- [`ProvableHashList`](ProvableHashList.md)\<`Value`\> - -## Type Parameters - -• **Value** - -## Constructors - -### new PrefixedProvableHashList() - -> **new PrefixedProvableHashList**\<`Value`\>(`valueType`, `prefix`, `internalCommitment`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/PrefixedProvableHashList.ts#L9) - -#### Parameters - -##### valueType - -`ProvablePure`\<`Value`\> - -##### prefix - -`string` - -##### internalCommitment - -`Field` = `...` - -#### Returns - -[`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> - -#### Overrides - -[`ProvableHashList`](ProvableHashList.md).[`constructor`](ProvableHashList.md#constructors) - -## Properties - -### commitment - -> **commitment**: `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`commitment`](ProvableHashList.md#commitment-1) - -*** - -### valueType - -> `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`valueType`](ProvableHashList.md#valuetype-1) - -## Methods - -### hash() - -> `protected` **hash**(`elements`): `Field` - -Defined in: [packages/protocol/src/utils/PrefixedProvableHashList.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/PrefixedProvableHashList.ts#L18) - -#### Parameters - -##### elements - -`Field`[] - -#### Returns - -`Field` - -#### Overrides - -[`ProvableHashList`](ProvableHashList.md).[`hash`](ProvableHashList.md#hash) - -*** - -### push() - -> **push**(`value`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) - -Converts the provided value to Field[] and appends it to -the current hashlist. - -#### Parameters - -##### value - -`Value` - -Value to be appended to the hash list - -#### Returns - -[`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> - -Current hash list. - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`push`](ProvableHashList.md#push) - -*** - -### pushIf() - -> **pushIf**(`value`, `condition`): [`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L29) - -#### Parameters - -##### value - -`Value` - -##### condition - -`Bool` - -#### Returns - -[`PrefixedProvableHashList`](PrefixedProvableHashList.md)\<`Value`\> - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`pushIf`](ProvableHashList.md#pushif) - -*** - -### toField() - -> **toField**(): `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) - -#### Returns - -`Field` - -Traling hash of the current hashlist. - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`toField`](ProvableHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/PreviousBlock.md b/src/pages/docs/reference/protocol/classes/PreviousBlock.md deleted file mode 100644 index e150047..0000000 --- a/src/pages/docs/reference/protocol/classes/PreviousBlock.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -title: PreviousBlock ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / PreviousBlock - -# Class: PreviousBlock - -Defined in: [packages/protocol/src/model/network/NetworkState.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L8) - -## Extends - -- `object` - -## Constructors - -### new PreviousBlock() - -> **new PreviousBlock**(`value`): [`PreviousBlock`](PreviousBlock.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### rootHash - -`Field` = `Field` - -#### Returns - -[`PreviousBlock`](PreviousBlock.md) - -#### Inherited from - -`Struct({ rootHash: Field, }).constructor` - -## Properties - -### rootHash - -> **rootHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/model/network/NetworkState.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/network/NetworkState.ts#L9) - -#### Inherited from - -`Struct({ rootHash: Field, }).rootHash` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ rootHash: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### rootHash - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ rootHash: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### rootHash - -> **rootHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ rootHash: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### rootHash - -> **rootHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ rootHash: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### rootHash - -`string` = `Field` - -#### Returns - -`object` - -##### rootHash - -> **rootHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ rootHash: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ rootHash: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### rootHash - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ rootHash: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### rootHash - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ rootHash: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### rootHash - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ rootHash: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### rootHash - -`Field` = `Field` - -#### Returns - -`object` - -##### rootHash - -> **rootHash**: `string` = `Field` - -#### Inherited from - -`Struct({ rootHash: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### rootHash - -`Field` = `Field` - -#### Returns - -`object` - -##### rootHash - -> **rootHash**: `bigint` = `Field` - -#### Inherited from - -`Struct({ rootHash: Field, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ rootHash: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/Protocol.md b/src/pages/docs/reference/protocol/classes/Protocol.md deleted file mode 100644 index 2282b50..0000000 --- a/src/pages/docs/reference/protocol/classes/Protocol.md +++ /dev/null @@ -1,716 +0,0 @@ ---- -title: Protocol ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Protocol - -# Class: Protocol\ - -Defined in: [packages/protocol/src/protocol/Protocol.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L66) - -Reusable module container facilitating registration, resolution -configuration, decoration and validation of modules - -## Extends - -- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Modules`\> - -## Type Parameters - -• **Modules** *extends* [`ProtocolModulesRecord`](../type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../type-aliases/MandatoryProtocolModulesRecord.md) - -## Implements - -- [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -## Constructors - -### new Protocol() - -> **new Protocol**\<`Modules`\>(`definition`): [`Protocol`](Protocol.md)\<`Modules`\> - -Defined in: [packages/protocol/src/protocol/Protocol.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L84) - -#### Parameters - -##### definition - -[`ProtocolDefinition`](../interfaces/ProtocolDefinition.md)\<`Modules`\> - -#### Returns - -[`Protocol`](Protocol.md)\<`Modules`\> - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) - -*** - -### definition - -> **definition**: [`ProtocolDefinition`](../interfaces/ProtocolDefinition.md)\<`Modules`\> - -Defined in: [packages/protocol/src/protocol/Protocol.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L82) - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) - -## Accessors - -### blockProver - -#### Get Signature - -> **get** **blockProver**(): [`BlockProvable`](../interfaces/BlockProvable.md) - -Defined in: [packages/protocol/src/protocol/Protocol.ts:121](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L121) - -##### Returns - -[`BlockProvable`](../interfaces/BlockProvable.md) - -*** - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) - -*** - -### dependencyContainer - -#### Get Signature - -> **get** **dependencyContainer**(): `DependencyContainer` - -Defined in: [packages/protocol/src/protocol/Protocol.ts:111](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L111) - -##### Returns - -`DependencyContainer` - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) - -*** - -### stateService - -#### Get Signature - -> **get** **stateService**(): [`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) - -Defined in: [packages/protocol/src/protocol/Protocol.ts:89](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L89) - -##### Returns - -[`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) - -#### Implementation of - -[`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md).[`stateService`](../interfaces/ProtocolEnvironment.md#stateservice) - -*** - -### stateServiceProvider - -#### Get Signature - -> **get** **stateServiceProvider**(): [`StateServiceProvider`](StateServiceProvider.md) - -Defined in: [packages/protocol/src/protocol/Protocol.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L93) - -##### Returns - -[`StateServiceProvider`](StateServiceProvider.md) - -#### Implementation of - -[`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md).[`stateServiceProvider`](../interfaces/ProtocolEnvironment.md#stateserviceprovider) - -*** - -### stateTransitionProver - -#### Get Signature - -> **get** **stateTransitionProver**(): [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) - -Defined in: [packages/protocol/src/protocol/Protocol.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L129) - -##### Returns - -[`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/Protocol.ts:139](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L139) - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) - -*** - -### decorateModule() - -> **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: [packages/protocol/src/protocol/Protocol.ts:97](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L97) - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -`InstanceType`\<`Modules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>\]\> - -#### Returns - -`void` - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) - -*** - -### getAreProofsEnabled() - -> **getAreProofsEnabled**(): [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/Protocol.ts:135](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L135) - -#### Returns - -[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Implementation of - -[`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md).[`getAreProofsEnabled`](../interfaces/ProtocolEnvironment.md#getareproofsenabled) - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>[] - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -`Modules` - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -`Modules` - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/Protocol.ts:214](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L214) - -#### Returns - -`Promise`\<`void`\> - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`Modules`\>(`modules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](Protocol.md)\<`Modules`\>\> - -Defined in: [packages/protocol/src/protocol/Protocol.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L72) - -#### Type Parameters - -• **Modules** *extends* [`ProtocolModulesRecord`](../type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../type-aliases/MandatoryProtocolModulesRecord.md) - -#### Parameters - -##### modules - -[`ProtocolDefinition`](../interfaces/ProtocolDefinition.md)\<`Modules`\> - -#### Returns - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](Protocol.md)\<`Modules`\>\> diff --git a/src/pages/docs/reference/protocol/classes/ProtocolModule.md b/src/pages/docs/reference/protocol/classes/ProtocolModule.md deleted file mode 100644 index bd02047..0000000 --- a/src/pages/docs/reference/protocol/classes/ProtocolModule.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: ProtocolModule ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProtocolModule - -# Class: `abstract` ProtocolModule\ - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L11) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> - -## Extended by - -- [`BlockProver`](BlockProver.md) -- [`StateTransitionProver`](StateTransitionProver.md) -- [`BlockProverType`](../interfaces/BlockProverType.md) -- [`StateTransitionProverType`](../interfaces/StateTransitionProverType.md) -- [`ProvableSettlementHook`](ProvableSettlementHook.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -## Constructors - -### new ProtocolModule() - -> **new ProtocolModule**\<`Config`\>(): [`ProtocolModule`](ProtocolModule.md)\<`Config`\> - -#### Returns - -[`ProtocolModule`](ProtocolModule.md)\<`Config`\> - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Overrides - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md b/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md deleted file mode 100644 index 6dfedc3..0000000 --- a/src/pages/docs/reference/protocol/classes/ProvableBlockHook.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -title: ProvableBlockHook ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableBlockHook - -# Class: `abstract` ProvableBlockHook\ - -Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProvableBlockHook.ts#L7) - -## Extends - -- `TransitioningProtocolModule`\<`Config`\> - -## Extended by - -- [`BlockHeightHook`](BlockHeightHook.md) -- [`LastStateRootBlockHook`](LastStateRootBlockHook.md) - -## Type Parameters - -• **Config** - -## Constructors - -### new ProvableBlockHook() - -> **new ProvableBlockHook**\<`Config`\>(): [`ProvableBlockHook`](ProvableBlockHook.md)\<`Config`\> - -#### Returns - -[`ProvableBlockHook`](ProvableBlockHook.md)\<`Config`\> - -#### Inherited from - -`TransitioningProtocolModule.constructor` - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -`TransitioningProtocolModule.currentConfig` - -*** - -### name? - -> `optional` **name**: `string` - -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) - -#### Inherited from - -`TransitioningProtocolModule.name` - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Inherited from - -`TransitioningProtocolModule.protocol` - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -`TransitioningProtocolModule.areProofsEnabled` - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -`TransitioningProtocolModule.config` - -## Methods - -### afterBlock() - -> `abstract` **afterBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> - -Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProvableBlockHook.ts#L15) - -#### Parameters - -##### networkState - -[`NetworkState`](NetworkState.md) - -##### state - -[`BlockProverState`](../interfaces/BlockProverState.md) - -#### Returns - -`Promise`\<[`NetworkState`](NetworkState.md)\> - -*** - -### beforeBlock() - -> `abstract` **beforeBlock**(`networkState`, `state`): `Promise`\<[`NetworkState`](NetworkState.md)\> - -Defined in: [packages/protocol/src/protocol/ProvableBlockHook.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProvableBlockHook.ts#L10) - -#### Parameters - -##### networkState - -[`NetworkState`](NetworkState.md) - -##### state - -[`BlockProverState`](../interfaces/BlockProverState.md) - -#### Returns - -`Promise`\<[`NetworkState`](NetworkState.md)\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -`TransitioningProtocolModule.create` - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TransitioningProtocolModule.start` diff --git a/src/pages/docs/reference/protocol/classes/ProvableHashList.md b/src/pages/docs/reference/protocol/classes/ProvableHashList.md deleted file mode 100644 index 74b7dad..0000000 --- a/src/pages/docs/reference/protocol/classes/ProvableHashList.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: ProvableHashList ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableHashList - -# Class: `abstract` ProvableHashList\ - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L6) - -Utilities for creating a hash list from a given value type. - -## Extended by - -- [`DefaultProvableHashList`](DefaultProvableHashList.md) -- [`PrefixedProvableHashList`](PrefixedProvableHashList.md) -- [`MinaPrefixedProvableHashList`](MinaPrefixedProvableHashList.md) -- [`ProvableReductionHashList`](ProvableReductionHashList.md) - -## Type Parameters - -• **Value** - -## Constructors - -### new ProvableHashList() - -> **new ProvableHashList**\<`Value`\>(`valueType`, `commitment`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L7) - -#### Parameters - -##### valueType - -`ProvablePure`\<`Value`\> - -##### commitment - -`Field` = `...` - -#### Returns - -[`ProvableHashList`](ProvableHashList.md)\<`Value`\> - -## Properties - -### commitment - -> **commitment**: `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) - -*** - -### valueType - -> `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) - -## Methods - -### hash() - -> `abstract` `protected` **hash**(`elements`): `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L12) - -#### Parameters - -##### elements - -`Field`[] - -#### Returns - -`Field` - -*** - -### push() - -> **push**(`value`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) - -Converts the provided value to Field[] and appends it to -the current hashlist. - -#### Parameters - -##### value - -`Value` - -Value to be appended to the hash list - -#### Returns - -[`ProvableHashList`](ProvableHashList.md)\<`Value`\> - -Current hash list. - -*** - -### pushIf() - -> **pushIf**(`value`, `condition`): [`ProvableHashList`](ProvableHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L29) - -#### Parameters - -##### value - -`Value` - -##### condition - -`Bool` - -#### Returns - -[`ProvableHashList`](ProvableHashList.md)\<`Value`\> - -*** - -### toField() - -> **toField**(): `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) - -#### Returns - -`Field` - -Traling hash of the current hashlist. diff --git a/src/pages/docs/reference/protocol/classes/ProvableOption.md b/src/pages/docs/reference/protocol/classes/ProvableOption.md deleted file mode 100644 index d34383f..0000000 --- a/src/pages/docs/reference/protocol/classes/ProvableOption.md +++ /dev/null @@ -1,433 +0,0 @@ ---- -title: ProvableOption ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableOption - -# Class: ProvableOption - -Defined in: [packages/protocol/src/model/Option.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L11) - -## Extends - -- `object` - -## Constructors - -### new ProvableOption() - -> **new ProvableOption**(`value`): [`ProvableOption`](ProvableOption.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### isSome - -`Bool` = `Bool` - -###### value - -`Field` = `Field` - -#### Returns - -[`ProvableOption`](ProvableOption.md) - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).constructor` - -## Properties - -### isSome - -> **isSome**: `Bool` = `Bool` - -Defined in: [packages/protocol/src/model/Option.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L12) - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).isSome` - -*** - -### value - -> **value**: `Field` = `Field` - -Defined in: [packages/protocol/src/model/Option.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L13) - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).value` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### isSome - -`Bool` = `Bool` - -###### value - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### isSome - -> **isSome**: `Bool` = `Bool` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### isSome - -> **isSome**: `Bool` = `Bool` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### isSome - -`boolean` = `Bool` - -###### value - -`string` = `Field` - -#### Returns - -`object` - -##### isSome - -> **isSome**: `Bool` = `Bool` - -##### value - -> **value**: `Field` = `Field` - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### isSome - -`Bool` = `Bool` - -###### value - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### isSome - -`Bool` = `Bool` - -###### value - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### isSome - -`Bool` = `Bool` - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### isSome - -`Bool` = `Bool` - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### isSome - -> **isSome**: `boolean` = `Bool` - -##### value - -> **value**: `string` = `Field` - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### isSome - -`Bool` = `Bool` - -###### value - -`Field` = `Field` - -#### Returns - -`object` - -##### isSome - -> **isSome**: `boolean` = `Bool` - -##### value - -> **value**: `bigint` = `Field` - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).toValue` - -## Methods - -### toSome() - -> **toSome**(): [`ProvableOption`](ProvableOption.md) - -Defined in: [packages/protocol/src/model/Option.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/Option.ts#L15) - -#### Returns - -[`ProvableOption`](ProvableOption.md) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ isSome: Bool, value: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md b/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md deleted file mode 100644 index 48d5f44..0000000 --- a/src/pages/docs/reference/protocol/classes/ProvableReductionHashList.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -title: ProvableReductionHashList ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableReductionHashList - -# Class: ProvableReductionHashList\ - -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L5) - -Utilities for creating a hash list from a given value type. - -## Extends - -- [`ProvableHashList`](ProvableHashList.md)\<`Value`\> - -## Extended by - -- [`StateTransitionReductionList`](StateTransitionReductionList.md) - -## Type Parameters - -• **Value** - -## Constructors - -### new ProvableReductionHashList() - -> **new ProvableReductionHashList**\<`Value`\>(`valueType`, `commitment`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L7) - -#### Parameters - -##### valueType - -`ProvablePure`\<`Value`\> - -##### commitment - -`Field` = `...` - -#### Returns - -[`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`constructor`](ProvableHashList.md#constructors) - -## Properties - -### commitment - -> **commitment**: `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`commitment`](ProvableHashList.md#commitment-1) - -*** - -### unconstrainedList - -> **unconstrainedList**: `Value`[] = `[]` - -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) - -*** - -### valueType - -> `protected` `readonly` **valueType**: `ProvablePure`\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`valueType`](ProvableHashList.md#valuetype-1) - -## Methods - -### hash() - -> **hash**(`elements`): `Field` - -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) - -#### Parameters - -##### elements - -`Field`[] - -#### Returns - -`Field` - -#### Overrides - -[`ProvableHashList`](ProvableHashList.md).[`hash`](ProvableHashList.md#hash) - -*** - -### push() - -> **push**(`value`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L21) - -Converts the provided value to Field[] and appends it to -the current hashlist. - -#### Parameters - -##### value - -`Value` - -Value to be appended to the hash list - -#### Returns - -[`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> - -Current hash list. - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`push`](ProvableHashList.md#push) - -*** - -### pushAndReduce() - -> **pushAndReduce**(`value`, `reduce`): `object` - -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) - -#### Parameters - -##### value - -`Value` - -##### reduce - -(`previous`) => \[`Value`, `Bool`\] - -#### Returns - -`object` - -##### popLast - -> **popLast**: `Bool` - -##### value - -> **value**: `Value` - -*** - -### pushIf() - -> **pushIf**(`value`, `condition`): [`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> - -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) - -#### Parameters - -##### value - -`Value` - -##### condition - -`Bool` - -#### Returns - -[`ProvableReductionHashList`](ProvableReductionHashList.md)\<`Value`\> - -#### Overrides - -[`ProvableHashList`](ProvableHashList.md).[`pushIf`](ProvableHashList.md#pushif) - -*** - -### toField() - -> **toField**(): `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) - -#### Returns - -`Field` - -Traling hash of the current hashlist. - -#### Inherited from - -[`ProvableHashList`](ProvableHashList.md).[`toField`](ProvableHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md b/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md deleted file mode 100644 index 7675d75..0000000 --- a/src/pages/docs/reference/protocol/classes/ProvableSettlementHook.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -title: ProvableSettlementHook ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableSettlementHook - -# Class: `abstract` ProvableSettlementHook\ - -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L29) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ProtocolModule`](ProtocolModule.md)\<`Config`\> - -## Extended by - -- [`NetworkStateSettlementModule`](NetworkStateSettlementModule.md) - -## Type Parameters - -• **Config** - -## Constructors - -### new ProvableSettlementHook() - -> **new ProvableSettlementHook**\<`Config`\>(): [`ProvableSettlementHook`](ProvableSettlementHook.md)\<`Config`\> - -#### Returns - -[`ProvableSettlementHook`](ProvableSettlementHook.md)\<`Config`\> - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`constructor`](ProtocolModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`currentConfig`](ProtocolModule.md#currentconfig) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`protocol`](ProtocolModule.md#protocol) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`areProofsEnabled`](ProtocolModule.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`config`](ProtocolModule.md#config) - -## Methods - -### beforeSettlement() - -> `abstract` **beforeSettlement**(`smartContract`, `inputs`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L32) - -#### Parameters - -##### smartContract - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md) - -##### inputs - -[`SettlementHookInputs`](../type-aliases/SettlementHookInputs.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`create`](ProtocolModule.md#create) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`start`](ProtocolModule.md#start) diff --git a/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md b/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md deleted file mode 100644 index 94be00b..0000000 --- a/src/pages/docs/reference/protocol/classes/ProvableStateTransition.md +++ /dev/null @@ -1,549 +0,0 @@ ---- -title: ProvableStateTransition ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableStateTransition - -# Class: ProvableStateTransition - -Defined in: [packages/protocol/src/model/StateTransition.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L10) - -Provable representation of a State Transition, used to -normalize state transitions of various value types for -the state transition circuit. - -## Extends - -- `object` - -## Constructors - -### new ProvableStateTransition() - -> **new ProvableStateTransition**(`value`): [`ProvableStateTransition`](ProvableStateTransition.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### from - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -###### path - -`Field` = `Field` - -###### to - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -#### Returns - -[`ProvableStateTransition`](ProvableStateTransition.md) - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).constructor `` - -## Properties - -### from - -> **from**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` - -Defined in: [packages/protocol/src/model/StateTransition.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L14) - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).from `` - -*** - -### path - -> **path**: `Field` = `Field` - -Defined in: [packages/protocol/src/model/StateTransition.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L11) - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).path `` - -*** - -### to - -> **to**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` - -Defined in: [packages/protocol/src/model/StateTransition.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L17) - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).to `` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, })._isStruct `` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### from - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -###### path - -`Field` = `Field` - -###### to - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -#### Returns - -`void` - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).check `` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### from - -> **from**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` - -##### path - -> **path**: `Field` = `Field` - -##### to - -> **to**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).empty `` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### from - -> **from**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` - -##### path - -> **path**: `Field` = `Field` - -##### to - -> **to**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).fromFields `` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### from - -\{ `isSome`: `boolean`; `value`: `string`; \} = `ProvableOption` - -###### from.isSome - -`boolean` = `Bool` - -###### from.value - -`string` = `Field` - -###### path - -`string` = `Field` - -###### to - -\{ `isSome`: `boolean`; `value`: `string`; \} = `ProvableOption` - -###### to.isSome - -`boolean` = `Bool` - -###### to.value - -`string` = `Field` - -#### Returns - -`object` - -##### from - -> **from**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` - -##### path - -> **path**: `Field` = `Field` - -##### to - -> **to**: [`ProvableOption`](ProvableOption.md) = `ProvableOption` - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).fromJSON `` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).fromValue `` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### from - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -###### path - -`Field` = `Field` - -###### to - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).toAuxiliary `` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### from - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -###### path - -`Field` = `Field` - -###### to - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).toFields `` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### from - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -###### path - -`Field` = `Field` - -###### to - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).toInput `` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### from - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -###### path - -`Field` = `Field` - -###### to - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -#### Returns - -`object` - -##### from - -> **from**: `object` = `ProvableOption` - -###### from.isSome - -> **from.isSome**: `boolean` = `Bool` - -###### from.value - -> **from.value**: `string` = `Field` - -##### path - -> **path**: `string` = `Field` - -##### to - -> **to**: `object` = `ProvableOption` - -###### to.isSome - -> **to.isSome**: `boolean` = `Bool` - -###### to.value - -> **to.value**: `string` = `Field` - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).toJSON `` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### from - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -###### path - -`Field` = `Field` - -###### to - -[`ProvableOption`](ProvableOption.md) = `ProvableOption` - -#### Returns - -`object` - -##### from - -> **from**: `object` = `ProvableOption` - -###### from.isSome - -> **from.isSome**: `boolean` = `Bool` - -###### from.value - -> **from.value**: `bigint` = `Field` - -##### path - -> **path**: `bigint` = `Field` - -##### to - -> **to**: `object` = `ProvableOption` - -###### to.isSome - -> **to.isSome**: `boolean` = `Bool` - -###### to.value - -> **to.value**: `bigint` = `Field` - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).toValue `` - -## Methods - -### dummy() - -> `static` **dummy**(): [`ProvableStateTransition`](ProvableStateTransition.md) - -Defined in: [packages/protocol/src/model/StateTransition.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L19) - -#### Returns - -[`ProvableStateTransition`](ProvableStateTransition.md) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`` Struct({ path: Field, // must be applied even if `None` from: ProvableOption, // must be ignored if `None` to: ProvableOption, }).sizeInFields `` diff --git a/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md b/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md deleted file mode 100644 index 6356681..0000000 --- a/src/pages/docs/reference/protocol/classes/ProvableStateTransitionType.md +++ /dev/null @@ -1,409 +0,0 @@ ---- -title: ProvableStateTransitionType ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableStateTransitionType - -# Class: ProvableStateTransitionType - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L27) - -## Extends - -- `object` - -## Constructors - -### new ProvableStateTransitionType() - -> **new ProvableStateTransitionType**(`value`): [`ProvableStateTransitionType`](ProvableStateTransitionType.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### type - -`Bool` = `Bool` - -#### Returns - -[`ProvableStateTransitionType`](ProvableStateTransitionType.md) - -#### Inherited from - -`Struct({ type: Bool, }).constructor` - -## Properties - -### type - -> **type**: `Bool` = `Bool` - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L28) - -#### Inherited from - -`Struct({ type: Bool, }).type` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ type: Bool, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### type - -`Bool` = `Bool` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ type: Bool, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### type - -> **type**: `Bool` = `Bool` - -#### Inherited from - -`Struct({ type: Bool, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### type - -> **type**: `Bool` = `Bool` - -#### Inherited from - -`Struct({ type: Bool, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### type - -`boolean` = `Bool` - -#### Returns - -`object` - -##### type - -> **type**: `Bool` = `Bool` - -#### Inherited from - -`Struct({ type: Bool, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ type: Bool, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### type - -`Bool` = `Bool` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ type: Bool, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### type - -`Bool` = `Bool` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ type: Bool, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### type - -`Bool` = `Bool` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ type: Bool, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### type - -`Bool` = `Bool` - -#### Returns - -`object` - -##### type - -> **type**: `boolean` = `Bool` - -#### Inherited from - -`Struct({ type: Bool, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### type - -`Bool` = `Bool` - -#### Returns - -`object` - -##### type - -> **type**: `boolean` = `Bool` - -#### Inherited from - -`Struct({ type: Bool, }).toValue` - -## Accessors - -### normal - -#### Get Signature - -> **get** `static` **normal**(): [`ProvableStateTransitionType`](ProvableStateTransitionType.md) - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L30) - -##### Returns - -[`ProvableStateTransitionType`](ProvableStateTransitionType.md) - -*** - -### protocol - -#### Get Signature - -> **get** `static` **protocol**(): [`ProvableStateTransitionType`](ProvableStateTransitionType.md) - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L36) - -##### Returns - -[`ProvableStateTransitionType`](ProvableStateTransitionType.md) - -## Methods - -### isNormal() - -> **isNormal**(): `Bool` - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L42) - -#### Returns - -`Bool` - -*** - -### isProtocol() - -> **isProtocol**(): `Bool` - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L46) - -#### Returns - -`Bool` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ type: Bool, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md b/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md deleted file mode 100644 index 67a6fb0..0000000 --- a/src/pages/docs/reference/protocol/classes/ProvableTransactionHook.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -title: ProvableTransactionHook ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProvableTransactionHook - -# Class: `abstract` ProvableTransactionHook\ - -Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProvableTransactionHook.ts#L7) - -## Extends - -- `TransitioningProtocolModule`\<`Config`\> - -## Extended by - -- [`AccountStateHook`](AccountStateHook.md) -- [`TransactionFeeHook`](../../library/classes/TransactionFeeHook.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -## Constructors - -### new ProvableTransactionHook() - -> **new ProvableTransactionHook**\<`Config`\>(): [`ProvableTransactionHook`](ProvableTransactionHook.md)\<`Config`\> - -#### Returns - -[`ProvableTransactionHook`](ProvableTransactionHook.md)\<`Config`\> - -#### Inherited from - -`TransitioningProtocolModule.constructor` - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -`TransitioningProtocolModule.currentConfig` - -*** - -### name? - -> `optional` **name**: `string` - -Defined in: [packages/protocol/src/protocol/TransitioningProtocolModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/TransitioningProtocolModule.ts#L11) - -#### Inherited from - -`TransitioningProtocolModule.name` - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Inherited from - -`TransitioningProtocolModule.protocol` - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -`TransitioningProtocolModule.areProofsEnabled` - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -`TransitioningProtocolModule.config` - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -`TransitioningProtocolModule.create` - -*** - -### onTransaction() - -> `abstract` **onTransaction**(`executionData`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProvableTransactionHook.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProvableTransactionHook.ts#L10) - -#### Parameters - -##### executionData - -[`BlockProverExecutionData`](BlockProverExecutionData.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TransitioningProtocolModule.start` diff --git a/src/pages/docs/reference/protocol/classes/PublicKeyOption.md b/src/pages/docs/reference/protocol/classes/PublicKeyOption.md deleted file mode 100644 index 5174080..0000000 --- a/src/pages/docs/reference/protocol/classes/PublicKeyOption.md +++ /dev/null @@ -1,479 +0,0 @@ ---- -title: PublicKeyOption ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / PublicKeyOption - -# Class: PublicKeyOption - -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L26) - -## Extends - -- `Generic`\<`PublicKey`, `this`\> - -## Constructors - -### new PublicKeyOption() - -> **new PublicKeyOption**(`value`): [`PublicKeyOption`](PublicKeyOption.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### isSome - -`Bool` = `Bool` - -###### value - -`PublicKey` = `valueType` - -#### Returns - -[`PublicKeyOption`](PublicKeyOption.md) - -#### Inherited from - -`genericOptionFactory( PublicKey ).constructor` - -## Properties - -### isSome - -> **isSome**: `Bool` = `Bool` - -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L5) - -#### Inherited from - -`genericOptionFactory( PublicKey ).isSome` - -*** - -### value - -> **value**: `PublicKey` = `valueType` - -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L6) - -#### Inherited from - -`genericOptionFactory( PublicKey ).value` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`genericOptionFactory( PublicKey )._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### isSome - -`Bool` = `Bool` - -###### value - -`PublicKey` = `valueType` - -#### Returns - -`void` - -#### Inherited from - -`genericOptionFactory( PublicKey ).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### isSome - -> **isSome**: `Bool` = `Bool` - -##### value - -> **value**: `PublicKey` = `valueType` - -#### Inherited from - -`genericOptionFactory( PublicKey ).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`, `aux`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 - -A function that returns an element of type `T` from the given provable and "auxiliary" data. - -This function is the reverse operation of calling [toFields](PublicKeyOption.md#tofields) and toAuxilary methods on an element of type `T`. - -#### Parameters - -##### fields - -`Field`[] - -an array of Field elements describing the provable data of the new `T` element. - -##### aux - -`any`[] - -an array of any type describing the "auxiliary" data of the new `T` element, optional. - -#### Returns - -`object` - -An element of type `T` generated from the given provable and "auxiliary" data. - -##### isSome - -> **isSome**: `Bool` = `Bool` - -##### value - -> **value**: `PublicKey` = `valueType` - -#### Inherited from - -`genericOptionFactory( PublicKey ).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### isSome - -`boolean` = `Bool` - -###### value - -`any` = `valueType` - -#### Returns - -`object` - -##### isSome - -> **isSome**: `Bool` = `Bool` - -##### value - -> **value**: `PublicKey` = `valueType` - -#### Inherited from - -`genericOptionFactory( PublicKey ).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`genericOptionFactory( PublicKey ).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### isSome - -`Bool` = `Bool` - -###### value - -`PublicKey` = `valueType` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`genericOptionFactory( PublicKey ).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### isSome - -`Bool` = `Bool` - -###### value - -`PublicKey` = `valueType` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`genericOptionFactory( PublicKey ).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### isSome - -`Bool` = `Bool` - -###### value - -`PublicKey` = `valueType` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`genericOptionFactory( PublicKey ).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### isSome - -`Bool` = `Bool` - -###### value - -`PublicKey` = `valueType` - -#### Returns - -`object` - -##### isSome - -> **isSome**: `boolean` = `Bool` - -##### value - -> **value**: `any` = `valueType` - -#### Inherited from - -`genericOptionFactory( PublicKey ).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### isSome - -`Bool` = `Bool` - -###### value - -`PublicKey` = `valueType` - -#### Returns - -`object` - -##### isSome - -> **isSome**: `boolean` = `Bool` - -##### value - -> **value**: `any` = `valueType` - -#### Inherited from - -`genericOptionFactory( PublicKey ).toValue` - -## Methods - -### fromSome() - -> `static` **fromSome**(`value`): `Generic`\<`PublicKey`\> - -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L8) - -#### Parameters - -##### value - -`PublicKey` - -#### Returns - -`Generic`\<`PublicKey`\> - -#### Inherited from - -`genericOptionFactory( PublicKey ).fromSome` - -*** - -### none() - -> `static` **none**(`value`): `Generic`\<`PublicKey`\> - -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L15) - -#### Parameters - -##### value - -`PublicKey` - -#### Returns - -`Generic`\<`PublicKey`\> - -#### Inherited from - -`genericOptionFactory( PublicKey ).none` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`genericOptionFactory( PublicKey ).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md deleted file mode 100644 index f58669c..0000000 --- a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionContext.md +++ /dev/null @@ -1,398 +0,0 @@ ---- -title: RuntimeMethodExecutionContext ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeMethodExecutionContext - -# Class: RuntimeMethodExecutionContext - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L54) - -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'. - -## Extends - -- [`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md) - -## Constructors - -### new RuntimeMethodExecutionContext() - -> **new RuntimeMethodExecutionContext**(): [`RuntimeMethodExecutionContext`](RuntimeMethodExecutionContext.md) - -#### Returns - -[`RuntimeMethodExecutionContext`](RuntimeMethodExecutionContext.md) - -#### Inherited from - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`constructor`](../../common/classes/ProvableMethodExecutionContext.md#constructors) - -## Properties - -### id - -> **id**: `string` - -Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:16 - -#### Inherited from - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`id`](../../common/classes/ProvableMethodExecutionContext.md#id) - -*** - -### input - -> **input**: `undefined` \| [`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md) - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L57) - -*** - -### methods - -> **methods**: `string`[] = `[]` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L55) - -#### Overrides - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`methods`](../../common/classes/ProvableMethodExecutionContext.md#methods) - -*** - -### result - -> **result**: [`RuntimeProvableMethodExecutionResult`](RuntimeProvableMethodExecutionResult.md) - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L62) - -#### Overrides - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`result`](../../common/classes/ProvableMethodExecutionContext.md#result) - -## Accessors - -### isFinished - -#### Get Signature - -> **get** **isFinished**(): `boolean` - -Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:41 - -##### Returns - -`boolean` - -#### Inherited from - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`isFinished`](../../common/classes/ProvableMethodExecutionContext.md#isfinished) - -*** - -### isTopLevel - -#### Get Signature - -> **get** **isTopLevel**(): `boolean` - -Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:40 - -##### Returns - -`boolean` - -#### Inherited from - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`isTopLevel`](../../common/classes/ProvableMethodExecutionContext.md#istoplevel) - -## Methods - -### addEvent() - -> **addEvent**(`eventType`, `event`, `eventName`, `condition`): `void` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:83](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L83) - -#### Parameters - -##### eventType - -`FlexibleProvablePure`\<`any`\> - -##### event - -`any` - -##### eventName - -`string` - -##### condition - -`Bool` = `...` - -#### Returns - -`void` - -*** - -### addStateTransition() - -> **addStateTransition**\<`Value`\>(`stateTransition`): `void` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L78) - -Adds an in-method generated state transition to the current context - -#### Type Parameters - -• **Value** - -#### Parameters - -##### stateTransition - -[`StateTransition`](StateTransition.md)\<`Value`\> - -State transition to add to the context - -#### Returns - -`void` - -*** - -### afterMethod() - -> **afterMethod**(): `void` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:152](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L152) - -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` - -#### Overrides - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`afterMethod`](../../common/classes/ProvableMethodExecutionContext.md#aftermethod) - -*** - -### beforeMethod() - -> **beforeMethod**(`moduleName`, `methodName`, `args`): `void` - -Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:33 - -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`](../../common/type-aliases/ArgumentTypes.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`beforeMethod`](../../common/classes/ProvableMethodExecutionContext.md#beforemethod) - -*** - -### clear() - -> **clear**(): `void` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:148](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L148) - -Manually clears/resets the execution context - -#### Returns - -`void` - -#### Overrides - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`clear`](../../common/classes/ProvableMethodExecutionContext.md#clear) - -*** - -### current() - -> **current**(): `object` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:166](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L166) - -Had to override current() otherwise it would not infer -the type of result correctly (parent type would be reused) - -#### Returns - -`object` - -##### input - -> **input**: `undefined` \| [`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md) - -##### isFinished - -> **isFinished**: `boolean` - -##### isSimulated - -> **isSimulated**: `boolean` - -##### result - -> **result**: [`RuntimeProvableMethodExecutionResult`](RuntimeProvableMethodExecutionResult.md) - -#### Overrides - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`current`](../../common/classes/ProvableMethodExecutionContext.md#current) - -*** - -### setProver() - -> **setProver**(`prover`): `void` - -Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:26 - -Adds a method prover to the current execution context, -which can be collected and ran asynchronously at a later point in time. - -#### Parameters - -##### prover - -() => `Promise`\<`Proof`\<`unknown`, `unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md).[`setProver`](../../common/classes/ProvableMethodExecutionContext.md#setprover) - -*** - -### setSimulated() - -> **setSimulated**(`simulated`): `void` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:141](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L141) - -#### Parameters - -##### simulated - -`boolean` - -#### Returns - -`void` - -*** - -### setStatus() - -> **setStatus**(`status`): `void` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L114) - -#### Parameters - -##### status - -`Bool` - -Execution status of the current method - -#### Returns - -`void` - -*** - -### setStatusMessage() - -> **setStatusMessage**(`message`?, `stackTrace`?): `void` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L102) - -#### Parameters - -##### message? - -`string` - -Status message to acompany the current status - -##### stackTrace? - -`string` - -#### Returns - -`void` - -*** - -### setup() - -> **setup**(`input`): `void` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:125](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L125) - -#### Parameters - -##### input - -[`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md) - -Input witness data required for a runtime execution - -#### Returns - -`void` - -*** - -### witnessInput() - -> **witnessInput**(): [`RuntimeMethodExecutionDataStruct`](RuntimeMethodExecutionDataStruct.md) - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L129) - -#### Returns - -[`RuntimeMethodExecutionDataStruct`](RuntimeMethodExecutionDataStruct.md) diff --git a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md b/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md deleted file mode 100644 index c43aaae..0000000 --- a/src/pages/docs/reference/protocol/classes/RuntimeMethodExecutionDataStruct.md +++ /dev/null @@ -1,591 +0,0 @@ ---- -title: RuntimeMethodExecutionDataStruct ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeMethodExecutionDataStruct - -# Class: RuntimeMethodExecutionDataStruct - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L41) - -## Extends - -- `object` - -## Implements - -- [`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md) - -## Constructors - -### new RuntimeMethodExecutionDataStruct() - -> **new RuntimeMethodExecutionDataStruct**(`value`): [`RuntimeMethodExecutionDataStruct`](RuntimeMethodExecutionDataStruct.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -[`RuntimeMethodExecutionDataStruct`](RuntimeMethodExecutionDataStruct.md) - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).constructor` - -## Properties - -### networkState - -> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L44) - -#### Implementation of - -[`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md).[`networkState`](../interfaces/RuntimeMethodExecutionData.md#networkstate) - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).networkState` - -*** - -### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L43) - -#### Implementation of - -[`RuntimeMethodExecutionData`](../interfaces/RuntimeMethodExecutionData.md).[`transaction`](../interfaces/RuntimeMethodExecutionData.md#transaction) - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).transaction` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### networkState - -> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` - -##### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`, `aux`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 - -A function that returns an element of type `T` from the given provable and "auxiliary" data. - -This function is the reverse operation of calling [toFields](RuntimeMethodExecutionDataStruct.md#tofields) and toAuxilary methods on an element of type `T`. - -#### Parameters - -##### fields - -`Field`[] - -an array of Field elements describing the provable data of the new `T` element. - -##### aux - -`any`[] - -an array of any type describing the "auxiliary" data of the new `T` element, optional. - -#### Returns - -`object` - -An element of type `T` generated from the given provable and "auxiliary" data. - -##### networkState - -> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` - -##### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### networkState - -\{ `block`: \{ `height`: `string`; \}; `previous`: \{ `rootHash`: `string`; \}; \} = `NetworkState` - -###### networkState.block - -\{ `height`: `string`; \} = `CurrentBlock` - -###### networkState.block.height - -`string` = `UInt64` - -###### networkState.previous - -\{ `rootHash`: `string`; \} = `PreviousBlock` - -###### networkState.previous.rootHash - -`string` = `Field` - -###### transaction - -\{ `argsHash`: `string`; `methodId`: `string`; `nonce`: \{ `isSome`: `boolean`; `value`: `any`; \}; `sender`: \{ `isSome`: `boolean`; `value`: `any`; \}; \} = `RuntimeTransaction` - -###### transaction.argsHash - -`string` = `Field` - -###### transaction.methodId - -`string` = `Field` - -###### transaction.nonce - -\{ `isSome`: `boolean`; `value`: `any`; \} = `UInt64Option` - -###### transaction.nonce.isSome - -`boolean` = `Bool` - -###### transaction.nonce.value - -`any` = `valueType` - -###### transaction.sender - -\{ `isSome`: `boolean`; `value`: `any`; \} = `PublicKeyOption` - -###### transaction.sender.isSome - -`boolean` = `Bool` - -###### transaction.sender.value - -`any` = `valueType` - -#### Returns - -`object` - -##### networkState - -> **networkState**: [`NetworkState`](NetworkState.md) = `NetworkState` - -##### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`object` - -##### networkState - -> **networkState**: `object` = `NetworkState` - -###### networkState.block - -> **networkState.block**: `object` = `CurrentBlock` - -###### networkState.block.height - -> **networkState.block.height**: `string` = `UInt64` - -###### networkState.previous - -> **networkState.previous**: `object` = `PreviousBlock` - -###### networkState.previous.rootHash - -> **networkState.previous.rootHash**: `string` = `Field` - -##### transaction - -> **transaction**: `object` = `RuntimeTransaction` - -###### transaction.argsHash - -> **transaction.argsHash**: `string` = `Field` - -###### transaction.methodId - -> **transaction.methodId**: `string` = `Field` - -###### transaction.nonce - -> **transaction.nonce**: `object` = `UInt64Option` - -###### transaction.nonce.isSome - -> **transaction.nonce.isSome**: `boolean` = `Bool` - -###### transaction.nonce.value - -> **transaction.nonce.value**: `any` = `valueType` - -###### transaction.sender - -> **transaction.sender**: `object` = `PublicKeyOption` - -###### transaction.sender.isSome - -> **transaction.sender.isSome**: `boolean` = `Bool` - -###### transaction.sender.value - -> **transaction.sender.value**: `any` = `valueType` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### networkState - -[`NetworkState`](NetworkState.md) = `NetworkState` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`object` - -##### networkState - -> **networkState**: `object` = `NetworkState` - -###### networkState.block - -> **networkState.block**: `object` = `CurrentBlock` - -###### networkState.block.height - -> **networkState.block.height**: `bigint` = `UInt64` - -###### networkState.previous - -> **networkState.previous**: `object` = `PreviousBlock` - -###### networkState.previous.rootHash - -> **networkState.previous.rootHash**: `bigint` = `Field` - -##### transaction - -> **transaction**: `object` = `RuntimeTransaction` - -###### transaction.argsHash - -> **transaction.argsHash**: `bigint` = `Field` - -###### transaction.methodId - -> **transaction.methodId**: `bigint` = `Field` - -###### transaction.nonce - -> **transaction.nonce**: `object` = `UInt64Option` - -###### transaction.nonce.isSome - -> **transaction.nonce.isSome**: `boolean` = `Bool` - -###### transaction.nonce.value - -> **transaction.nonce.value**: `any` = `valueType` - -###### transaction.sender - -> **transaction.sender**: `object` = `PublicKeyOption` - -###### transaction.sender.isSome - -> **transaction.sender.isSome**: `boolean` = `Bool` - -###### transaction.sender.value - -> **transaction.sender.value**: `any` = `valueType` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, networkState: NetworkState, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md b/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md deleted file mode 100644 index e02980c..0000000 --- a/src/pages/docs/reference/protocol/classes/RuntimeProvableMethodExecutionResult.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: RuntimeProvableMethodExecutionResult ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeProvableMethodExecutionResult - -# Class: RuntimeProvableMethodExecutionResult - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L19) - -## Extends - -- [`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md) - -## Constructors - -### new RuntimeProvableMethodExecutionResult() - -> **new RuntimeProvableMethodExecutionResult**(): [`RuntimeProvableMethodExecutionResult`](RuntimeProvableMethodExecutionResult.md) - -#### Returns - -[`RuntimeProvableMethodExecutionResult`](RuntimeProvableMethodExecutionResult.md) - -#### Inherited from - -[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`constructor`](../../common/classes/ProvableMethodExecutionResult.md#constructors) - -## Properties - -### args? - -> `optional` **args**: [`ArgumentTypes`](../../common/type-aliases/ArgumentTypes.md) - -Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:6 - -#### Inherited from - -[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`args`](../../common/classes/ProvableMethodExecutionResult.md#args) - -*** - -### events - -> **events**: `object`[] = `[]` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L28) - -#### condition - -> **condition**: `Bool` - -#### event - -> **event**: `any` - -#### eventName - -> **eventName**: `string` - -#### eventType - -> **eventType**: `FlexibleProvablePure`\<`any`\> - -*** - -### methodName? - -> `optional` **methodName**: `string` - -Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:5 - -#### Inherited from - -[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`methodName`](../../common/classes/ProvableMethodExecutionResult.md#methodname) - -*** - -### moduleName? - -> `optional` **moduleName**: `string` - -Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:4 - -#### Inherited from - -[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`moduleName`](../../common/classes/ProvableMethodExecutionResult.md#modulename) - -*** - -### prover()? - -> `optional` **prover**: () => `Promise`\<`Proof`\<`unknown`, `unknown`\>\> - -Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:7 - -#### Returns - -`Promise`\<`Proof`\<`unknown`, `unknown`\>\> - -#### Inherited from - -[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`prover`](../../common/classes/ProvableMethodExecutionResult.md#prover) - -*** - -### stackTrace? - -> `optional` **stackTrace**: `string` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L26) - -*** - -### stateTransitions - -> **stateTransitions**: [`StateTransition`](StateTransition.md)\<`any`\>[] = `[]` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L20) - -*** - -### status - -> **status**: `Bool` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L22) - -*** - -### statusMessage? - -> `optional` **statusMessage**: `string` - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L24) - -## Methods - -### prove() - -> **prove**\<`ProofType`\>(): `Promise`\<`ProofType`\> - -Defined in: packages/common/dist/zkProgrammable/ProvableMethodExecutionContext.d.ts:8 - -#### Type Parameters - -• **ProofType** *extends* `Proof`\<`unknown`, `unknown`\> - -#### Returns - -`Promise`\<`ProofType`\> - -#### Inherited from - -[`ProvableMethodExecutionResult`](../../common/classes/ProvableMethodExecutionResult.md).[`prove`](../../common/classes/ProvableMethodExecutionResult.md#prove) diff --git a/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md b/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md deleted file mode 100644 index 3c54b9d..0000000 --- a/src/pages/docs/reference/protocol/classes/RuntimeTransaction.md +++ /dev/null @@ -1,743 +0,0 @@ ---- -title: RuntimeTransaction ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeTransaction - -# Class: RuntimeTransaction - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L11) - -This struct is used to expose transaction information to the runtime method -execution. This class has not all data included in transactions on purpose. -For example, we don't want to expose the signature or args as fields. - -## Extends - -- `object` - -## Constructors - -### new RuntimeTransaction() - -> **new RuntimeTransaction**(`value`): [`RuntimeTransaction`](RuntimeTransaction.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### argsHash - -`Field` = `Field` - -###### methodId - -`Field` = `Field` - -###### nonce - -[`UInt64Option`](UInt64Option.md) = `UInt64Option` - -###### sender - -[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -#### Returns - -[`RuntimeTransaction`](RuntimeTransaction.md) - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).constructor` - -## Properties - -### argsHash - -> **argsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L13) - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).argsHash` - -*** - -### methodId - -> **methodId**: `Field` = `Field` - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L12) - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).methodId` - -*** - -### nonce - -> **nonce**: [`UInt64Option`](UInt64Option.md) = `UInt64Option` - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L14) - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).nonce` - -*** - -### sender - -> **sender**: [`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L15) - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).sender` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### argsHash - -`Field` = `Field` - -###### methodId - -`Field` = `Field` - -###### nonce - -[`UInt64Option`](UInt64Option.md) = `UInt64Option` - -###### sender - -[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### argsHash - -> **argsHash**: `Field` = `Field` - -##### methodId - -> **methodId**: `Field` = `Field` - -##### nonce - -> **nonce**: [`UInt64Option`](UInt64Option.md) = `UInt64Option` - -##### sender - -> **sender**: [`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`, `aux`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 - -A function that returns an element of type `T` from the given provable and "auxiliary" data. - -This function is the reverse operation of calling [toFields](RuntimeTransaction.md#tofields) and toAuxilary methods on an element of type `T`. - -#### Parameters - -##### fields - -`Field`[] - -an array of Field elements describing the provable data of the new `T` element. - -##### aux - -`any`[] - -an array of any type describing the "auxiliary" data of the new `T` element, optional. - -#### Returns - -`object` - -An element of type `T` generated from the given provable and "auxiliary" data. - -##### argsHash - -> **argsHash**: `Field` = `Field` - -##### methodId - -> **methodId**: `Field` = `Field` - -##### nonce - -> **nonce**: [`UInt64Option`](UInt64Option.md) = `UInt64Option` - -##### sender - -> **sender**: [`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### argsHash - -`string` = `Field` - -###### methodId - -`string` = `Field` - -###### nonce - -\{ `isSome`: `boolean`; `value`: `any`; \} = `UInt64Option` - -###### nonce.isSome - -`boolean` = `Bool` - -###### nonce.value - -`any` = `valueType` - -###### sender - -\{ `isSome`: `boolean`; `value`: `any`; \} = `PublicKeyOption` - -###### sender.isSome - -`boolean` = `Bool` - -###### sender.value - -`any` = `valueType` - -#### Returns - -`object` - -##### argsHash - -> **argsHash**: `Field` = `Field` - -##### methodId - -> **methodId**: `Field` = `Field` - -##### nonce - -> **nonce**: [`UInt64Option`](UInt64Option.md) = `UInt64Option` - -##### sender - -> **sender**: [`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### argsHash - -`Field` = `Field` - -###### methodId - -`Field` = `Field` - -###### nonce - -[`UInt64Option`](UInt64Option.md) = `UInt64Option` - -###### sender - -[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### argsHash - -`Field` = `Field` - -###### methodId - -`Field` = `Field` - -###### nonce - -[`UInt64Option`](UInt64Option.md) = `UInt64Option` - -###### sender - -[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### argsHash - -`Field` = `Field` - -###### methodId - -`Field` = `Field` - -###### nonce - -[`UInt64Option`](UInt64Option.md) = `UInt64Option` - -###### sender - -[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### argsHash - -`Field` = `Field` - -###### methodId - -`Field` = `Field` - -###### nonce - -[`UInt64Option`](UInt64Option.md) = `UInt64Option` - -###### sender - -[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -#### Returns - -`object` - -##### argsHash - -> **argsHash**: `string` = `Field` - -##### methodId - -> **methodId**: `string` = `Field` - -##### nonce - -> **nonce**: `object` = `UInt64Option` - -###### nonce.isSome - -> **nonce.isSome**: `boolean` = `Bool` - -###### nonce.value - -> **nonce.value**: `any` = `valueType` - -##### sender - -> **sender**: `object` = `PublicKeyOption` - -###### sender.isSome - -> **sender.isSome**: `boolean` = `Bool` - -###### sender.value - -> **sender.value**: `any` = `valueType` - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### argsHash - -`Field` = `Field` - -###### methodId - -`Field` = `Field` - -###### nonce - -[`UInt64Option`](UInt64Option.md) = `UInt64Option` - -###### sender - -[`PublicKeyOption`](PublicKeyOption.md) = `PublicKeyOption` - -#### Returns - -`object` - -##### argsHash - -> **argsHash**: `bigint` = `Field` - -##### methodId - -> **methodId**: `bigint` = `Field` - -##### nonce - -> **nonce**: `object` = `UInt64Option` - -###### nonce.isSome - -> **nonce.isSome**: `boolean` = `Bool` - -###### nonce.value - -> **nonce.value**: `any` = `valueType` - -##### sender - -> **sender**: `object` = `PublicKeyOption` - -###### sender.isSome - -> **sender.isSome**: `boolean` = `Bool` - -###### sender.value - -> **sender.value**: `any` = `valueType` - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).toValue` - -## Methods - -### assertTransactionType() - -> **assertTransactionType**(`isMessage`): `void` - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L61) - -#### Parameters - -##### isMessage - -`Bool` - -#### Returns - -`void` - -*** - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L102) - -#### Returns - -`Field` - -*** - -### hashData() - -> **hashData**(): `Field`[] - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:76](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L76) - -#### Returns - -`Field`[] - -*** - -### dummyTransaction() - -> `static` **dummyTransaction**(): [`RuntimeTransaction`](RuntimeTransaction.md) - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L46) - -#### Returns - -[`RuntimeTransaction`](RuntimeTransaction.md) - -*** - -### fromHashData() - -> `static` **fromHashData**(`fields`): [`RuntimeTransaction`](RuntimeTransaction.md) - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L85) - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -[`RuntimeTransaction`](RuntimeTransaction.md) - -*** - -### fromMessage() - -> `static` **fromMessage**(`__namedParameters`): [`RuntimeTransaction`](RuntimeTransaction.md) - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L31) - -#### Parameters - -##### \_\_namedParameters - -###### argsHash - -`Field` - -###### methodId - -`Field` - -#### Returns - -[`RuntimeTransaction`](RuntimeTransaction.md) - -*** - -### fromTransaction() - -> `static` **fromTransaction**(`input`): [`RuntimeTransaction`](RuntimeTransaction.md) - -Defined in: [packages/protocol/src/model/transaction/RuntimeTransaction.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/RuntimeTransaction.ts#L17) - -#### Parameters - -##### input - -###### argsHash - -`Field` - -###### methodId - -`Field` - -###### nonce - -`UInt64` - -###### sender - -`PublicKey` - -#### Returns - -[`RuntimeTransaction`](RuntimeTransaction.md) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ methodId: Field, argsHash: Field, nonce: UInt64Option, sender: PublicKeyOption, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md deleted file mode 100644 index 41f4ff6..0000000 --- a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyAttestation.md +++ /dev/null @@ -1,467 +0,0 @@ ---- -title: RuntimeVerificationKeyAttestation ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeVerificationKeyAttestation - -# Class: RuntimeVerificationKeyAttestation - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L8) - -## Extends - -- `object` - -## Constructors - -### new RuntimeVerificationKeyAttestation() - -> **new RuntimeVerificationKeyAttestation**(`value`): [`RuntimeVerificationKeyAttestation`](RuntimeVerificationKeyAttestation.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### verificationKey - -`VerificationKey` = `VerificationKey` - -###### witness - -[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -#### Returns - -[`RuntimeVerificationKeyAttestation`](RuntimeVerificationKeyAttestation.md) - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).constructor` - -## Properties - -### verificationKey - -> **verificationKey**: `VerificationKey` = `VerificationKey` - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L9) - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).verificationKey` - -*** - -### witness - -> **witness**: [`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L10) - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).witness` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### verificationKey - -`VerificationKey` = `VerificationKey` - -###### witness - -[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### verificationKey - -> **verificationKey**: `VerificationKey` = `VerificationKey` - -##### witness - -> **witness**: [`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`, `aux`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 - -A function that returns an element of type `T` from the given provable and "auxiliary" data. - -This function is the reverse operation of calling [toFields](RuntimeVerificationKeyAttestation.md#tofields) and toAuxilary methods on an element of type `T`. - -#### Parameters - -##### fields - -`Field`[] - -an array of Field elements describing the provable data of the new `T` element. - -##### aux - -`any`[] - -an array of any type describing the "auxiliary" data of the new `T` element, optional. - -#### Returns - -`object` - -An element of type `T` generated from the given provable and "auxiliary" data. - -##### verificationKey - -> **verificationKey**: `VerificationKey` = `VerificationKey` - -##### witness - -> **witness**: [`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### verificationKey - -`string` = `VerificationKey` - -###### witness - -\{ `isLeft`: `boolean`[]; `path`: `string`[]; \} = `VKTreeWitness` - -###### witness.isLeft - -`boolean`[] - -###### witness.path - -`string`[] - -#### Returns - -`object` - -##### verificationKey - -> **verificationKey**: `VerificationKey` = `VerificationKey` - -##### witness - -> **witness**: [`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### verificationKey - -`VerificationKey` = `VerificationKey` - -###### witness - -[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### verificationKey - -`VerificationKey` = `VerificationKey` - -###### witness - -[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### verificationKey - -`VerificationKey` = `VerificationKey` - -###### witness - -[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### verificationKey - -`VerificationKey` = `VerificationKey` - -###### witness - -[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -#### Returns - -`object` - -##### verificationKey - -> **verificationKey**: `string` = `VerificationKey` - -##### witness - -> **witness**: `object` = `VKTreeWitness` - -###### witness.isLeft - -> **witness.isLeft**: `boolean`[] - -###### witness.path - -> **witness.path**: `string`[] - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### verificationKey - -`VerificationKey` = `VerificationKey` - -###### witness - -[`VKTreeWitness`](VKTreeWitness.md) = `VKTreeWitness` - -#### Returns - -`object` - -##### verificationKey - -> **verificationKey**: `object` = `VerificationKey` - -###### verificationKey.data - -> **verificationKey.data**: `string` - -###### verificationKey.hash - -> **verificationKey.hash**: `bigint` - -##### witness - -> **witness**: `object` = `VKTreeWitness` - -###### witness.isLeft - -> **witness.isLeft**: `boolean`[] - -###### witness.path - -> **witness.path**: `bigint`[] - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ verificationKey: VerificationKey, witness: VKTreeWitness, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md b/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md deleted file mode 100644 index 3496685..0000000 --- a/src/pages/docs/reference/protocol/classes/RuntimeVerificationKeyRootService.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: RuntimeVerificationKeyRootService ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeVerificationKeyRootService - -# Class: RuntimeVerificationKeyRootService - -Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L7) - -## Implements - -- [`MinimalVKTreeService`](../interfaces/MinimalVKTreeService.md) - -## Constructors - -### new RuntimeVerificationKeyRootService() - -> **new RuntimeVerificationKeyRootService**(): [`RuntimeVerificationKeyRootService`](RuntimeVerificationKeyRootService.md) - -#### Returns - -[`RuntimeVerificationKeyRootService`](RuntimeVerificationKeyRootService.md) - -## Methods - -### getRoot() - -> **getRoot**(): `bigint` - -Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L14) - -#### Returns - -`bigint` - -#### Implementation of - -[`MinimalVKTreeService`](../interfaces/MinimalVKTreeService.md).[`getRoot`](../interfaces/MinimalVKTreeService.md#getroot) - -*** - -### setRoot() - -> **setRoot**(`root`): `void` - -Defined in: [packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/services/RuntimeVerificationKeyRootService.ts#L10) - -#### Parameters - -##### root - -`bigint` - -#### Returns - -`void` diff --git a/src/pages/docs/reference/protocol/classes/SettlementContractModule.md b/src/pages/docs/reference/protocol/classes/SettlementContractModule.md deleted file mode 100644 index d642fdf..0000000 --- a/src/pages/docs/reference/protocol/classes/SettlementContractModule.md +++ /dev/null @@ -1,793 +0,0 @@ ---- -title: SettlementContractModule ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementContractModule - -# Class: SettlementContractModule\ - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L46) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`SettlementModules`\> - -## Type Parameters - -• **SettlementModules** *extends* [`SettlementModulesRecord`](../type-aliases/SettlementModulesRecord.md) & [`MandatorySettlementModulesRecord`](../type-aliases/MandatorySettlementModulesRecord.md) - -## Implements - -- [`ProtocolModule`](ProtocolModule.md)\<`unknown`\> - -## Constructors - -### new SettlementContractModule() - -> **new SettlementContractModule**\<`SettlementModules`\>(`definition`): [`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\> - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L53) - -#### Parameters - -##### definition - -###### modules - -`SettlementModules` - -#### Returns - -[`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\> - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`SettlementModules`\> - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Implementation of - -[`ProtocolModule`](ProtocolModule.md).[`currentConfig`](ProtocolModule.md#currentconfig) - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) - -*** - -### definition - -> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`SettlementModules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L94) - -#### Implementation of - -[`ProtocolModule`](ProtocolModule.md).[`protocol`](ProtocolModule.md#protocol) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:96](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L96) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Implementation of - -[`ProtocolModule`](ProtocolModule.md).[`areProofsEnabled`](ProtocolModule.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Implementation of - -[`ProtocolModule`](ProtocolModule.md).[`config`](ProtocolModule.md#config) - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`SettlementModules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`SettlementModules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:101](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L101) - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Implementation of - -[`ProtocolModule`](ProtocolModule.md).[`create`](ProtocolModule.md#create) - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) - -*** - -### createBridgeContract() - -> **createBridgeContract**(`address`, `tokenId`?): [`BridgeContractType`](../type-aliases/BridgeContractType.md) & `SmartContract` - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:137](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L137) - -#### Parameters - -##### address - -`PublicKey` - -##### tokenId? - -`Field` - -#### Returns - -[`BridgeContractType`](../type-aliases/BridgeContractType.md) & `SmartContract` - -*** - -### createContracts() - -> **createContracts**(`addresses`): `object` - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:119](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L119) - -#### Parameters - -##### addresses - -###### dispatch - -`PublicKey` - -###### settlement - -`PublicKey` - -#### Returns - -`object` - -##### dispatch - -> **dispatch**: [`DispatchContractType`](../interfaces/DispatchContractType.md) & `SmartContract` - -##### settlement - -> **settlement**: [`SettlementContractType`](../interfaces/SettlementContractType.md) & `SmartContract` - -*** - -### decorateModule() - -> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:134 - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`SettlementModules`\> - -##### containedModule - -`InstanceType`\<`SettlementModules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`SettlementModules`\>\]\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) - -*** - -### getContractClasses() - -> **getContractClasses**(): `GetContracts`\<`SettlementModules`\> - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L109) - -#### Returns - -`GetContracts`\<`SettlementModules`\> - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`SettlementModules`\>[] - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -`SettlementModules` - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`SettlementModules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -`SettlementModules` - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`SettlementModules`\>\[`KeyType`\]\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`SettlementModules`\>\[`KeyType`\]\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L105) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`ProtocolModule`](ProtocolModule.md).[`start`](ProtocolModule.md#start) - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`SettlementModules`\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`SettlementModules`\>(`modules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\>\> - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L57) - -#### Type Parameters - -• **SettlementModules** *extends* [`SettlementModulesRecord`](../type-aliases/SettlementModulesRecord.md) & [`MandatorySettlementModulesRecord`](../type-aliases/MandatorySettlementModulesRecord.md) - -#### Parameters - -##### modules - -`SettlementModules` - -#### Returns - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`SettlementModules`\>\> - -*** - -### fromDefaults() - -> `static` **fromDefaults**(): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<\{ `BridgeContract`: *typeof* [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md); `DispatchContract`: *typeof* [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md); `SettlementContract`: *typeof* [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md); \}\>\> - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L78) - -#### Returns - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<\{ `BridgeContract`: *typeof* [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md); `DispatchContract`: *typeof* [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md); `SettlementContract`: *typeof* [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md); \}\>\> - -*** - -### mandatoryModules() - -> `static` **mandatoryModules**(): `object` - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L70) - -#### Returns - -`object` - -##### BridgeContract - -> `readonly` **BridgeContract**: *typeof* [`BridgeContractProtocolModule`](BridgeContractProtocolModule.md) = `BridgeContractProtocolModule` - -##### DispatchContract - -> `readonly` **DispatchContract**: *typeof* [`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) = `DispatchContractProtocolModule` - -##### SettlementContract - -> `readonly` **SettlementContract**: *typeof* [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md) = `SettlementContractProtocolModule` - -*** - -### with() - -> `static` **with**\<`AdditionalModules`\>(`additionalModules`): [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`object` & `AdditionalModules`\>\> - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L84) - -#### Type Parameters - -• **AdditionalModules** *extends* [`SettlementModulesRecord`](../type-aliases/SettlementModulesRecord.md) - -#### Parameters - -##### additionalModules - -`AdditionalModules` - -#### Returns - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`SettlementContractModule`](SettlementContractModule.md)\<`object` & `AdditionalModules`\>\> diff --git a/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md b/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md deleted file mode 100644 index d4c47e3..0000000 --- a/src/pages/docs/reference/protocol/classes/SettlementContractProtocolModule.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: SettlementContractProtocolModule ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementContractProtocolModule - -# Class: SettlementContractProtocolModule - -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L34) - -This module type is used to define a contract module that can be used to -construct and inject smart contract instances. -It defines a method contractFactory, whose arguments can be configured via -the Argument generic. It returns a smart contract class that is a subclass -of SmartContract and implements a certain interface as specified by the -ContractType generic. - -## Extends - -- [`ContractModule`](ContractModule.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md), [`SettlementContractConfig`](../type-aliases/SettlementContractConfig.md)\> - -## Constructors - -### new SettlementContractProtocolModule() - -> **new SettlementContractProtocolModule**(`hooks`, `blockProver`, `dispatchContractModule`, `bridgeContractModule`, `childVerificationKeyService`): [`SettlementContractProtocolModule`](SettlementContractProtocolModule.md) - -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L38) - -#### Parameters - -##### hooks - -[`ProvableSettlementHook`](ProvableSettlementHook.md)\<`unknown`\>[] - -##### blockProver - -[`BlockProvable`](../interfaces/BlockProvable.md) - -##### dispatchContractModule - -[`DispatchContractProtocolModule`](DispatchContractProtocolModule.md) - -##### bridgeContractModule - -[`BridgeContractProtocolModule`](BridgeContractProtocolModule.md) - -##### childVerificationKeyService - -[`ChildVerificationKeyService`](../../common/classes/ChildVerificationKeyService.md) - -#### Returns - -[`SettlementContractProtocolModule`](SettlementContractProtocolModule.md) - -#### Overrides - -[`ContractModule`](ContractModule.md).[`constructor`](ContractModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`SettlementContractConfig`](../type-aliases/SettlementContractConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ContractModule`](ContractModule.md).[`currentConfig`](ContractModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ContractModule`](ContractModule.md).[`config`](ContractModule.md#config) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L82) - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`undefined` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -#### Overrides - -[`ContractModule`](ContractModule.md).[`compile`](ContractModule.md#compile) - -*** - -### contractFactory() - -> **contractFactory**(): [`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L52) - -#### Returns - -[`SmartContractClassFromInterface`](../type-aliases/SmartContractClassFromInterface.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md)\> - -#### Overrides - -[`ContractModule`](ContractModule.md).[`contractFactory`](ContractModule.md#contractfactory) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ContractModule`](ContractModule.md).[`create`](ContractModule.md#create) diff --git a/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md b/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md deleted file mode 100644 index db36dc5..0000000 --- a/src/pages/docs/reference/protocol/classes/SettlementSmartContract.md +++ /dev/null @@ -1,1736 +0,0 @@ ---- -title: SettlementSmartContract ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementSmartContract - -# Class: SettlementSmartContract - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:433](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L433) - -## Extends - -- [`SettlementSmartContractBase`](SettlementSmartContractBase.md) - -## Implements - -- [`SettlementContractType`](../interfaces/SettlementContractType.md) - -## Constructors - -### new SettlementSmartContract() - -> **new SettlementSmartContract**(`address`, `tokenId`?): [`SettlementSmartContract`](SettlementSmartContract.md) - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 - -#### Parameters - -##### address - -`PublicKey` - -##### tokenId? - -`Field` - -#### Returns - -[`SettlementSmartContract`](SettlementSmartContract.md) - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`constructor`](SettlementSmartContractBase.md#constructors) - -## Properties - -### address - -> **address**: `PublicKey` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`address`](SettlementSmartContractBase.md#address-1) - -*** - -### authorizationField - -> **authorizationField**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:446](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L446) - -#### Implementation of - -[`SettlementContractType`](../interfaces/SettlementContractType.md).[`authorizationField`](../interfaces/SettlementContractType.md#authorizationfield) - -#### Overrides - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`authorizationField`](SettlementSmartContractBase.md#authorizationfield) - -*** - -### blockHashRoot - -> **blockHashRoot**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:442](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L442) - -#### Overrides - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`blockHashRoot`](SettlementSmartContractBase.md#blockhashroot) - -*** - -### dispatchContractAddressX - -> **dispatchContractAddressX**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:444](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L444) - -#### Overrides - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`dispatchContractAddressX`](SettlementSmartContractBase.md#dispatchcontractaddressx) - -*** - -### events - -> **events**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) - -A list of event types that can be emitted using this.emitEvent()`. - -#### token-bridge-deployed - -> **token-bridge-deployed**: *typeof* [`TokenMapping`](TokenMapping.md) = `TokenMapping` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`events`](SettlementSmartContractBase.md#events) - -*** - -### lastSettlementL1BlockHeight - -> **lastSettlementL1BlockHeight**: `State`\<`UInt32`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:438](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L438) - -#### Overrides - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`lastSettlementL1BlockHeight`](SettlementSmartContractBase.md#lastsettlementl1blockheight) - -*** - -### networkStateHash - -> **networkStateHash**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:441](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L441) - -#### Overrides - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`networkStateHash`](SettlementSmartContractBase.md#networkstatehash) - -*** - -### sender - -> **sender**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 - -#### self - -> **self**: `SmartContract` - -#### ~~getAndRequireSignature()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key. - -#### getAndRequireSignatureV2() - -Return a public key that is forced to sign this transaction. - -Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created -the transaction controls the private key associated with the returned public key. - -##### Returns - -`PublicKey` - -#### ~~getUnconstrained()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getUnconstrainedV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key, -which would cause an account update with that public key to not be included. - -#### getUnconstrainedV2() - -The public key of the current transaction's sender account. - -Throws an error if not inside a transaction, or the sender wasn't passed in. - -**Warning**: The fact that this public key equals the current sender is not part of the proof. -A malicious prover could use any other public key without affecting the validity of the proof. - -Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. - -##### Returns - -`PublicKey` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`sender`](SettlementSmartContractBase.md#sender) - -*** - -### sequencerKey - -> **sequencerKey**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:437](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L437) - -#### Overrides - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`sequencerKey`](SettlementSmartContractBase.md#sequencerkey) - -*** - -### stateRoot - -> **stateRoot**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:440](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L440) - -#### Overrides - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`stateRoot`](SettlementSmartContractBase.md#stateroot) - -*** - -### tokenId - -> **tokenId**: `Field` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`tokenId`](SettlementSmartContractBase.md#tokenid-1) - -*** - -### \_maxProofsVerified? - -> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`_maxProofsVerified`](SettlementSmartContractBase.md#_maxproofsverified) - -*** - -### \_methodMetadata? - -> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`_methodMetadata`](SettlementSmartContractBase.md#_methodmetadata) - -*** - -### \_methods? - -> `static` `optional` **\_methods**: `MethodInterface`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`_methods`](SettlementSmartContractBase.md#_methods) - -*** - -### \_provers? - -> `static` `optional` **\_provers**: `Prover`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`_provers`](SettlementSmartContractBase.md#_provers) - -*** - -### \_verificationKey? - -> `static` `optional` **\_verificationKey**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 - -#### data - -> **data**: `string` - -#### hash - -> **hash**: `Field` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`_verificationKey`](SettlementSmartContractBase.md#_verificationkey) - -*** - -### args - -> `static` **args**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) - -#### BridgeContract - -> **BridgeContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BridgeContractType`](../type-aliases/BridgeContractType.md)\> & *typeof* `SmartContract` - -#### BridgeContractPermissions - -> **BridgeContractPermissions**: `undefined` \| `Permissions` - -#### BridgeContractVerificationKey - -> **BridgeContractVerificationKey**: `undefined` \| `VerificationKey` - -#### ChildVerificationKeyService - -> **ChildVerificationKeyService**: [`ChildVerificationKeyService`](../../common/classes/ChildVerificationKeyService.md) - -#### DispatchContract - -> **DispatchContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md) & `SmartContract`\> - -#### escapeHatchSlotsInterval - -> **escapeHatchSlotsInterval**: `number` - -#### hooks - -> **hooks**: [`ProvableSettlementHook`](ProvableSettlementHook.md)\<`unknown`\>[] - -#### signedSettlements - -> **signedSettlements**: `undefined` \| `boolean` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`args`](SettlementSmartContractBase.md#args) - -*** - -### MAX\_ACCOUNT\_UPDATES - -> `static` **MAX\_ACCOUNT\_UPDATES**: `number` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:94 - -The maximum number of account updates using the token in a single -transaction that this contract supports. - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`MAX_ACCOUNT_UPDATES`](SettlementSmartContractBase.md#max_account_updates) - -## Accessors - -### account - -#### Get Signature - -> **get** **account**(): `Account` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 - -Current account of the SmartContract. - -##### Returns - -`Account` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`account`](SettlementSmartContractBase.md#account) - -*** - -### balance - -#### Get Signature - -> **get** **balance**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 - -Balance of this SmartContract. - -##### Returns - -`object` - -###### addInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -###### subInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`balance`](SettlementSmartContractBase.md#balance) - -*** - -### currentSlot - -#### Get Signature - -> **get** **currentSlot**(): `CurrentSlot` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 - -Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value -at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) -or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) - -##### Returns - -`CurrentSlot` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`currentSlot`](SettlementSmartContractBase.md#currentslot) - -*** - -### internal - -#### Get Signature - -> **get** **internal**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:47 - -Helper methods to use from within a token contract. - -##### Returns - -`object` - -###### burn() - -###### Parameters - -###### \_\_namedParameters - -###### address - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### Returns - -`AccountUpdate` - -###### mint() - -###### Parameters - -###### \_\_namedParameters - -###### address - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### Returns - -`AccountUpdate` - -###### send() - -###### Parameters - -###### \_\_namedParameters - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### from - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### to - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### Returns - -`AccountUpdate` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`internal`](SettlementSmartContractBase.md#internal) - -*** - -### network - -#### Get Signature - -> **get** **network**(): `Network` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 - -Current network state of the SmartContract. - -##### Returns - -`Network` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`network`](SettlementSmartContractBase.md#network) - -*** - -### self - -#### Get Signature - -> **get** **self**(): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 - -Returns the current AccountUpdate associated to this SmartContract. - -##### Returns - -`AccountUpdate` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`self`](SettlementSmartContractBase.md#self) - -## Methods - -### addTokenBridge() - -> **addTokenBridge**(`tokenId`, `address`, `dispatchContract`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:468](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L468) - -#### Parameters - -##### tokenId - -`Field` - -##### address - -`PublicKey` - -##### dispatchContract - -`PublicKey` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`SettlementContractType`](../interfaces/SettlementContractType.md).[`addTokenBridge`](../interfaces/SettlementContractType.md#addtokenbridge) - -*** - -### approve() - -> **approve**(`update`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 - -Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, -which allows you to read and use its content in a proof, make assertions about it, and modify it. - -```ts -`@method` myApprovingMethod(update: AccountUpdate) { - this.approve(update); - - // read balance on the account (for example) - let balance = update.account.balance.getAndRequireEquals(); -} -``` - -Under the hood, "approving" just means that the account update is made a child of the zkApp in the -tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, -the entire tree will become a subtree of the zkApp's account update. - -Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update -at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally -excluding important information from the public input. - -#### Parameters - -##### update - -`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` - -#### Returns - -`void` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`approve`](SettlementSmartContractBase.md#approve) - -*** - -### approveAccountUpdate() - -> **approveAccountUpdate**(`accountUpdate`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:78 - -Approve a single account update (with arbitrarily many children). - -#### Parameters - -##### accountUpdate - -`AccountUpdate` | `AccountUpdateTree` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`approveAccountUpdate`](SettlementSmartContractBase.md#approveaccountupdate) - -*** - -### approveAccountUpdates() - -> **approveAccountUpdates**(`accountUpdates`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:82 - -Approve a list of account updates (with arbitrarily many children). - -#### Parameters - -##### accountUpdates - -(`AccountUpdate` \| `AccountUpdateTree`)[] - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`approveAccountUpdates`](SettlementSmartContractBase.md#approveaccountupdates) - -*** - -### approveBase() - -> **approveBase**(`forest`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:448](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L448) - -#### Parameters - -##### forest - -`AccountUpdateForest` - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`approveBase`](SettlementSmartContractBase.md#approvebase) - -*** - -### assertStateRoot() - -> **assertStateRoot**(`root`): `AccountUpdate` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) - -#### Parameters - -##### root - -`Field` - -#### Returns - -`AccountUpdate` - -#### Implementation of - -[`SettlementContractType`](../interfaces/SettlementContractType.md).[`assertStateRoot`](../interfaces/SettlementContractType.md#assertstateroot) - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`assertStateRoot`](SettlementSmartContractBase.md#assertstateroot) - -*** - -### checkZeroBalanceChange() - -> **checkZeroBalanceChange**(`updates`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:74 - -Use `forEachUpdate()` to prove that the total balance change of child account updates is zero. - -This is provided out of the box as it is both a good example, and probably the most common implementation, of `approveBase()`. - -#### Parameters - -##### updates - -`AccountUpdateForest` - -#### Returns - -`void` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`checkZeroBalanceChange`](SettlementSmartContractBase.md#checkzerobalancechange) - -*** - -### deploy() - -> **deploy**(`args`?): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:39 - -Deploys a TokenContract. - -In addition to base smart contract deployment, this adds two steps: -- set the `access` permission to `proofOrSignature()`, to prevent against unauthorized token operations - - not doing this would imply that anyone can bypass token contract authorization and simply mint themselves tokens -- require the zkapp account to be new, using the `isNew` precondition. - this guarantees that the access permission is set from the very start of the existence of this account. - creating the zkapp account before deployment would otherwise be a security vulnerability that is too easy to introduce. - -Note that because of the `isNew` precondition, the zkapp account must not be created prior to calling `deploy()`. - -If the contract needs to be re-deployed, you can switch off this behaviour by overriding the `isNew` precondition: -```ts -async deploy() { - await super.deploy(); - // DON'T DO THIS ON THE INITIAL DEPLOYMENT! - this.account.isNew.requireNothing(); -} -``` - -#### Parameters - -##### args? - -`DeployArgs` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`deploy`](SettlementSmartContractBase.md#deploy) - -*** - -### deployTokenBridge() - -> `protected` **deployTokenBridge**(`tokenId`, `address`, `dispatchContractAddress`, `dispatchContractPreconditionEnforced`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) - -#### Parameters - -##### tokenId - -`Field` - -##### address - -`PublicKey` - -##### dispatchContractAddress - -`PublicKey` - -##### dispatchContractPreconditionEnforced - -`boolean` = `false` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`deployTokenBridge`](SettlementSmartContractBase.md#deploytokenbridge) - -*** - -### deriveTokenId() - -> **deriveTokenId**(): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:43 - -Returns the `tokenId` of the token managed by this contract. - -#### Returns - -`Field` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`deriveTokenId`](SettlementSmartContractBase.md#derivetokenid) - -*** - -### emitEvent() - -> **emitEvent**\<`K`\>(`type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 - -Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `"token-bridge-deployed"` - -#### Parameters - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`emitEvent`](SettlementSmartContractBase.md#emitevent) - -*** - -### emitEventIf() - -> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 - -Conditionally emits an event. - -Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `"token-bridge-deployed"` - -#### Parameters - -##### condition - -`Bool` - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`emitEventIf`](SettlementSmartContractBase.md#emiteventif) - -*** - -### fetchEvents() - -> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 - -Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. - -#### Parameters - -##### start? - -`UInt32` - -The start height of the events to fetch. - -##### end? - -`UInt32` - -The end height of the events to fetch. If not provided, fetches events up to the latest height. - -#### Returns - -`Promise`\<`object`[]\> - -A promise that resolves to an array of objects, each containing the event type and event data for the specified range. - -#### Async - -#### Throws - -If there is an error fetching events from the Mina network. - -#### Example - -```ts -const startHeight = UInt32.from(1000); -const endHeight = UInt32.from(2000); -const events = await myZkapp.fetchEvents(startHeight, endHeight); -console.log(events); -``` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`fetchEvents`](SettlementSmartContractBase.md#fetchevents) - -*** - -### forEachUpdate() - -> **forEachUpdate**(`updates`, `callback`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:68 - -Iterate through the account updates in `updates` and apply `callback` to each. - -This method is provable and is suitable as a base for implementing `approveUpdates()`. - -#### Parameters - -##### updates - -`AccountUpdateForest` - -##### callback - -(`update`, `usesToken`) => `void` - -#### Returns - -`void` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`forEachUpdate`](SettlementSmartContractBase.md#foreachupdate) - -*** - -### init() - -> **init**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 - -`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. -This method can be overridden as follows -``` -class MyContract extends SmartContract { - init() { - super.init(); - this.account.permissions.set(...); - this.x.set(Field(1)); - } -} -``` - -#### Returns - -`void` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`init`](SettlementSmartContractBase.md#init) - -*** - -### initialize() - -> **initialize**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:453](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L453) - -#### Parameters - -##### sequencer - -`PublicKey` - -##### dispatchContract - -`PublicKey` - -##### bridgeContract - -`PublicKey` - -##### contractKey - -`PrivateKey` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`SettlementContractType`](../interfaces/SettlementContractType.md).[`initialize`](../interfaces/SettlementContractType.md#initialize) - -*** - -### initializeBase() - -> `protected` **initializeBase**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) - -#### Parameters - -##### sequencer - -`PublicKey` - -##### dispatchContract - -`PublicKey` - -##### bridgeContract - -`PublicKey` - -##### contractKey - -`PrivateKey` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`initializeBase`](SettlementSmartContractBase.md#initializebase) - -*** - -### newSelf() - -> **newSelf**(`methodName`?): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 - -Same as `SmartContract.self` but explicitly creates a new AccountUpdate. - -#### Parameters - -##### methodName? - -`string` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`newSelf`](SettlementSmartContractBase.md#newself) - -*** - -### requireSignature() - -> **requireSignature**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 - -Use this command if the account update created by this SmartContract should be signed by the account owner, -instead of authorized with a proof. - -Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. - -If you only want to avoid creating proofs for quicker testing, we advise you to -use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting -`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, -with the only difference being that quick mock proofs are filled in instead of real proofs. - -#### Returns - -`void` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`requireSignature`](SettlementSmartContractBase.md#requiresignature) - -*** - -### send() - -> **send**(`args`): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 - -#### Parameters - -##### args - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### to - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`send`](SettlementSmartContractBase.md#send-2) - -*** - -### settle() - -> **settle**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:477](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L477) - -#### Parameters - -##### blockProof - -[`DynamicBlockProof`](DynamicBlockProof.md) - -##### signature - -`Signature` - -##### dispatchContractAddress - -`PublicKey` - -##### publicKey - -`PublicKey` - -##### inputNetworkState - -[`NetworkState`](NetworkState.md) - -##### outputNetworkState - -[`NetworkState`](NetworkState.md) - -##### newPromisedMessagesHash - -`Field` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`SettlementContractType`](../interfaces/SettlementContractType.md).[`settle`](../interfaces/SettlementContractType.md#settle) - -*** - -### settleBase() - -> `protected` **settleBase**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) - -#### Parameters - -##### blockProof - -[`DynamicBlockProof`](DynamicBlockProof.md) - -##### signature - -`Signature` - -##### dispatchContractAddress - -`PublicKey` - -##### publicKey - -`PublicKey` - -##### inputNetworkState - -[`NetworkState`](NetworkState.md) - -##### outputNetworkState - -[`NetworkState`](NetworkState.md) - -##### newPromisedMessagesHash - -`Field` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`settleBase`](SettlementSmartContractBase.md#settlebase) - -*** - -### skipAuthorization() - -> **skipAuthorization**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 - -Use this command if the account update created by this SmartContract should have no authorization on it, -instead of being authorized with a proof. - -WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look -at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the -authorization flow. - -#### Returns - -`void` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`skipAuthorization`](SettlementSmartContractBase.md#skipauthorization) - -*** - -### transfer() - -> **transfer**(`from`, `to`, `amount`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:86 - -Transfer `amount` of tokens from `from` to `to`. - -#### Parameters - -##### from - -`PublicKey` | `AccountUpdate` - -##### to - -`PublicKey` | `AccountUpdate` - -##### amount - -`number` | `bigint` | `UInt64` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`transfer`](SettlementSmartContractBase.md#transfer) - -*** - -### analyzeMethods() - -> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 - -This function is run internally before compiling a smart contract, to collect metadata about what each of your -smart contract methods does. - -For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, -so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. - -`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), -which is a good indicator for circuit size and the time it will take to create proofs. -To inspect the created circuit in detail, you can look at the returned `gates`. - -Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. - -#### Parameters - -##### \_\_namedParameters? - -###### printSummary - -`boolean` - -#### Returns - -`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -an object, keyed by method name, each entry containing: - - `rows` the size of the constraint system created by this method - - `digest` a digest of the method circuit - - `actions` the number of actions the method dispatches - - `gates` the constraint system, represented as an array of gates - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`analyzeMethods`](SettlementSmartContractBase.md#analyzemethods) - -*** - -### compile() - -> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 - -Compile your smart contract. - -This generates both the prover functions, needed to create proofs for running `@method`s, -and the verification key, needed to deploy your zkApp. - -Although provers and verification key are returned by this method, they are also cached internally and used when needed, -so you don't actually have to use the return value of this function. - -Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to -create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps -it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, -up to several minutes if your circuit is large or your hardware is not optimal for these operations. - -#### Parameters - -##### \_\_namedParameters? - -###### cache - -`Cache` - -###### forceRecompile - -`boolean` - -#### Returns - -`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`compile`](SettlementSmartContractBase.md#compile) - -*** - -### digest() - -> `static` **digest**(): `Promise`\<`string`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 - -Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. -This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or -a cached verification key can be used. - -#### Returns - -`Promise`\<`string`\> - -the digest, as a hex string - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`digest`](SettlementSmartContractBase.md#digest) - -*** - -### Proof() - -> `static` **Proof**(): (`__namedParameters`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 - -Returns a Proof type that belongs to this SmartContract. - -#### Returns - -`Function` - -##### Parameters - -###### \_\_namedParameters - -###### maxProofsVerified - -`0` \| `1` \| `2` - -###### proof - -`unknown` - -###### publicInput - -`ZkappPublicInput` - -###### publicOutput - -`undefined` - -##### Returns - -`object` - -###### maxProofsVerified - -> **maxProofsVerified**: `0` \| `1` \| `2` - -###### proof - -> **proof**: `unknown` - -###### publicInput - -> **publicInput**: `ZkappPublicInput` - -###### publicOutput - -> **publicOutput**: `undefined` - -###### shouldVerify - -> **shouldVerify**: `Bool` - -###### toJSON() - -###### Returns - -`JsonProof` - -###### verify() - -###### Returns - -`void` - -###### verifyIf() - -###### Parameters - -###### condition - -`Bool` - -###### Returns - -`void` - -##### publicInputType - -> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` - -###### Type declaration - -###### fromFields() - -> **fromFields**: (`fields`) => `object` - -###### Parameters - -###### fields - -`Field`[] - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### Type declaration - -###### empty() - -> **empty**: () => `object` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### fromJSON() - -> **fromJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`string` - -###### calls - -`string` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### toInput() - -> **toInput**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### fields? - -> `optional` **fields**: `Field`[] - -###### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -###### toJSON() - -> **toJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `string` - -###### calls - -> **calls**: `string` - -##### publicOutputType - -> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> - -##### tag() - -> **tag**: () => *typeof* `SmartContract` - -###### Returns - -*typeof* `SmartContract` - -##### dummy() - -###### Type Parameters - -• **Input** - -• **OutPut** - -###### Parameters - -###### publicInput - -`Input` - -###### publicOutput - -`OutPut` - -###### maxProofsVerified - -`0` | `1` | `2` - -###### domainLog2? - -`number` - -###### Returns - -`Promise`\<`Proof`\<`Input`, `OutPut`\>\> - -##### fromJSON() - -###### Type Parameters - -• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` - -###### Parameters - -###### this - -`S` - -###### \_\_namedParameters - -`JsonProof` - -###### Returns - -`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`Proof`](SettlementSmartContractBase.md#proof) - -*** - -### runOutsideCircuit() - -> `static` **runOutsideCircuit**(`run`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 - -#### Parameters - -##### run - -() => `void` - -#### Returns - -`void` - -#### Inherited from - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md).[`runOutsideCircuit`](SettlementSmartContractBase.md#runoutsidecircuit) diff --git a/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md b/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md deleted file mode 100644 index 3c9ce86..0000000 --- a/src/pages/docs/reference/protocol/classes/SettlementSmartContractBase.md +++ /dev/null @@ -1,1570 +0,0 @@ ---- -title: SettlementSmartContractBase ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementSmartContractBase - -# Class: `abstract` SettlementSmartContractBase - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L108) - -## Extends - -- `TokenContractV2` - -## Extended by - -- [`SettlementSmartContract`](SettlementSmartContract.md) - -## Constructors - -### new SettlementSmartContractBase() - -> **new SettlementSmartContractBase**(`address`, `tokenId`?): [`SettlementSmartContractBase`](SettlementSmartContractBase.md) - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:138 - -#### Parameters - -##### address - -`PublicKey` - -##### tokenId? - -`Field` - -#### Returns - -[`SettlementSmartContractBase`](SettlementSmartContractBase.md) - -#### Inherited from - -`TokenContractV2.constructor` - -## Properties - -### address - -> **address**: `PublicKey` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:50 - -#### Inherited from - -`TokenContractV2.address` - -*** - -### authorizationField - -> `abstract` **authorizationField**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:135](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L135) - -*** - -### blockHashRoot - -> `abstract` **blockHashRoot**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L132) - -*** - -### dispatchContractAddressX - -> `abstract` **dispatchContractAddressX**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:133](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L133) - -*** - -### events - -> **events**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:124](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L124) - -A list of event types that can be emitted using this.emitEvent()`. - -#### token-bridge-deployed - -> **token-bridge-deployed**: *typeof* [`TokenMapping`](TokenMapping.md) = `TokenMapping` - -#### Overrides - -`TokenContractV2.events` - -*** - -### lastSettlementL1BlockHeight - -> `abstract` **lastSettlementL1BlockHeight**: `State`\<`UInt32`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L129) - -*** - -### networkStateHash - -> `abstract` **networkStateHash**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:131](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L131) - -*** - -### sender - -> **sender**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:231 - -#### self - -> **self**: `SmartContract` - -#### ~~getAndRequireSignature()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getAndRequireSignatureV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key. - -#### getAndRequireSignatureV2() - -Return a public key that is forced to sign this transaction. - -Note: This doesn't prove that the return value is the transaction sender, but it proves that whoever created -the transaction controls the private key associated with the returned public key. - -##### Returns - -`PublicKey` - -#### ~~getUnconstrained()~~ - -##### Returns - -`PublicKey` - -##### Deprecated - -Deprecated in favor of `this.sender.getUnconstrainedV2()`. -This method is vulnerable because it allows the prover to return a dummy (empty) public key, -which would cause an account update with that public key to not be included. - -#### getUnconstrainedV2() - -The public key of the current transaction's sender account. - -Throws an error if not inside a transaction, or the sender wasn't passed in. - -**Warning**: The fact that this public key equals the current sender is not part of the proof. -A malicious prover could use any other public key without affecting the validity of the proof. - -Consider using `this.sender.getAndRequireSignatureV2()` if you need to prove that the sender controls this account. - -##### Returns - -`PublicKey` - -#### Inherited from - -`TokenContractV2.sender` - -*** - -### sequencerKey - -> `abstract` **sequencerKey**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:128](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L128) - -*** - -### stateRoot - -> `abstract` **stateRoot**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L130) - -*** - -### tokenId - -> **tokenId**: `Field` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:51 - -#### Inherited from - -`TokenContractV2.tokenId` - -*** - -### \_maxProofsVerified? - -> `static` `optional` **\_maxProofsVerified**: `0` \| `2` \| `1` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:60 - -#### Inherited from - -`TokenContractV2._maxProofsVerified` - -*** - -### \_methodMetadata? - -> `static` `optional` **\_methodMetadata**: `Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:53 - -#### Inherited from - -`TokenContractV2._methodMetadata` - -*** - -### \_methods? - -> `static` `optional` **\_methods**: `MethodInterface`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:52 - -#### Inherited from - -`TokenContractV2._methods` - -*** - -### \_provers? - -> `static` `optional` **\_provers**: `Prover`[] - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:59 - -#### Inherited from - -`TokenContractV2._provers` - -*** - -### \_verificationKey? - -> `static` `optional` **\_verificationKey**: `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:61 - -#### data - -> **data**: `string` - -#### hash - -> **hash**: `Field` - -#### Inherited from - -`TokenContractV2._verificationKey` - -*** - -### args - -> `static` **args**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L112) - -#### BridgeContract - -> **BridgeContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BridgeContractType`](../type-aliases/BridgeContractType.md)\> & *typeof* `SmartContract` - -#### BridgeContractPermissions - -> **BridgeContractPermissions**: `undefined` \| `Permissions` - -#### BridgeContractVerificationKey - -> **BridgeContractVerificationKey**: `undefined` \| `VerificationKey` - -#### ChildVerificationKeyService - -> **ChildVerificationKeyService**: [`ChildVerificationKeyService`](../../common/classes/ChildVerificationKeyService.md) - -#### DispatchContract - -> **DispatchContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md) & `SmartContract`\> - -#### escapeHatchSlotsInterval - -> **escapeHatchSlotsInterval**: `number` - -#### hooks - -> **hooks**: [`ProvableSettlementHook`](ProvableSettlementHook.md)\<`unknown`\>[] - -#### signedSettlements - -> **signedSettlements**: `undefined` \| `boolean` - -*** - -### MAX\_ACCOUNT\_UPDATES - -> `static` **MAX\_ACCOUNT\_UPDATES**: `number` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:94 - -The maximum number of account updates using the token in a single -transaction that this contract supports. - -#### Inherited from - -`TokenContractV2.MAX_ACCOUNT_UPDATES` - -## Accessors - -### account - -#### Get Signature - -> **get** **account**(): `Account` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:268 - -Current account of the SmartContract. - -##### Returns - -`Account` - -#### Inherited from - -`TokenContractV2.account` - -*** - -### balance - -#### Get Signature - -> **get** **balance**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:308 - -Balance of this SmartContract. - -##### Returns - -`object` - -###### addInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -###### subInPlace() - -###### Parameters - -###### x - -`string` | `number` | `bigint` | `UInt64` | `UInt32` | `Int64` - -###### Returns - -`void` - -#### Inherited from - -`TokenContractV2.balance` - -*** - -### currentSlot - -#### Get Signature - -> **get** **currentSlot**(): `CurrentSlot` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:278 - -Current global slot on the network. This is the slot at which this transaction is included in a block. Since we cannot know this value -at the time of transaction construction, this only has the `assertBetween()` method but no `get()` (impossible to implement) -or `assertEquals()` (confusing, because the developer can't know the exact slot at which this will be included either) - -##### Returns - -`CurrentSlot` - -#### Inherited from - -`TokenContractV2.currentSlot` - -*** - -### internal - -#### Get Signature - -> **get** **internal**(): `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:47 - -Helper methods to use from within a token contract. - -##### Returns - -`object` - -###### burn() - -###### Parameters - -###### \_\_namedParameters - -###### address - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### Returns - -`AccountUpdate` - -###### mint() - -###### Parameters - -###### \_\_namedParameters - -###### address - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### Returns - -`AccountUpdate` - -###### send() - -###### Parameters - -###### \_\_namedParameters - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### from - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### to - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -###### Returns - -`AccountUpdate` - -#### Inherited from - -`TokenContractV2.internal` - -*** - -### network - -#### Get Signature - -> **get** **network**(): `Network` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:272 - -Current network state of the SmartContract. - -##### Returns - -`Network` - -#### Inherited from - -`TokenContractV2.network` - -*** - -### self - -#### Get Signature - -> **get** **self**(): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:226 - -Returns the current AccountUpdate associated to this SmartContract. - -##### Returns - -`AccountUpdate` - -#### Inherited from - -`TokenContractV2.self` - -## Methods - -### approve() - -> **approve**(`update`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:300 - -Approve an account update or tree / forest of updates. Doing this means you include the account update in the zkApp's public input, -which allows you to read and use its content in a proof, make assertions about it, and modify it. - -```ts -`@method` myApprovingMethod(update: AccountUpdate) { - this.approve(update); - - // read balance on the account (for example) - let balance = update.account.balance.getAndRequireEquals(); -} -``` - -Under the hood, "approving" just means that the account update is made a child of the zkApp in the -tree of account updates that forms the transaction. Similarly, if you pass in an AccountUpdateTree, -the entire tree will become a subtree of the zkApp's account update. - -Passing in a forest is a bit different, because it means you set the entire children of the zkApp's account update -at once. `approve()` will fail if the zkApp's account update already has children, to prevent you from accidentally -excluding important information from the public input. - -#### Parameters - -##### update - -`AccountUpdate` | `AccountUpdateTree` | `AccountUpdateForest` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.approve` - -*** - -### approveAccountUpdate() - -> **approveAccountUpdate**(`accountUpdate`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:78 - -Approve a single account update (with arbitrarily many children). - -#### Parameters - -##### accountUpdate - -`AccountUpdate` | `AccountUpdateTree` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TokenContractV2.approveAccountUpdate` - -*** - -### approveAccountUpdates() - -> **approveAccountUpdates**(`accountUpdates`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:82 - -Approve a list of account updates (with arbitrarily many children). - -#### Parameters - -##### accountUpdates - -(`AccountUpdate` \| `AccountUpdateTree`)[] - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TokenContractV2.approveAccountUpdates` - -*** - -### approveBase() - -> `abstract` **approveBase**(`forest`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:62 - -#### Parameters - -##### forest - -`AccountUpdateForest` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TokenContractV2.approveBase` - -*** - -### assertStateRoot() - -> **assertStateRoot**(`root`): `AccountUpdate` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:140](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L140) - -#### Parameters - -##### root - -`Field` - -#### Returns - -`AccountUpdate` - -*** - -### checkZeroBalanceChange() - -> **checkZeroBalanceChange**(`updates`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:74 - -Use `forEachUpdate()` to prove that the total balance change of child account updates is zero. - -This is provided out of the box as it is both a good example, and probably the most common implementation, of `approveBase()`. - -#### Parameters - -##### updates - -`AccountUpdateForest` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.checkZeroBalanceChange` - -*** - -### deploy() - -> **deploy**(`args`?): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:39 - -Deploys a TokenContract. - -In addition to base smart contract deployment, this adds two steps: -- set the `access` permission to `proofOrSignature()`, to prevent against unauthorized token operations - - not doing this would imply that anyone can bypass token contract authorization and simply mint themselves tokens -- require the zkapp account to be new, using the `isNew` precondition. - this guarantees that the access permission is set from the very start of the existence of this account. - creating the zkapp account before deployment would otherwise be a security vulnerability that is too easy to introduce. - -Note that because of the `isNew` precondition, the zkapp account must not be created prior to calling `deploy()`. - -If the contract needs to be re-deployed, you can switch off this behaviour by overriding the `isNew` precondition: -```ts -async deploy() { - await super.deploy(); - // DON'T DO THIS ON THE INITIAL DEPLOYMENT! - this.account.isNew.requireNothing(); -} -``` - -#### Parameters - -##### args? - -`DeployArgs` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TokenContractV2.deploy` - -*** - -### deployTokenBridge() - -> `protected` **deployTokenBridge**(`tokenId`, `address`, `dispatchContractAddress`, `dispatchContractPreconditionEnforced`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:164](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L164) - -#### Parameters - -##### tokenId - -`Field` - -##### address - -`PublicKey` - -##### dispatchContractAddress - -`PublicKey` - -##### dispatchContractPreconditionEnforced - -`boolean` = `false` - -#### Returns - -`Promise`\<`void`\> - -*** - -### deriveTokenId() - -> **deriveTokenId**(): `Field` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:43 - -Returns the `tokenId` of the token managed by this contract. - -#### Returns - -`Field` - -#### Inherited from - -`TokenContractV2.deriveTokenId` - -*** - -### emitEvent() - -> **emitEvent**\<`K`\>(`type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:327 - -Emits an event. Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `"token-bridge-deployed"` - -#### Parameters - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.emitEvent` - -*** - -### emitEventIf() - -> **emitEventIf**\<`K`\>(`condition`, `type`, `event`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:323 - -Conditionally emits an event. - -Events will be emitted as a part of the transaction and can be collected by archive nodes. - -#### Type Parameters - -• **K** *extends* `"token-bridge-deployed"` - -#### Parameters - -##### condition - -`Bool` - -##### type - -`K` - -##### event - -`any` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.emitEventIf` - -*** - -### fetchEvents() - -> **fetchEvents**(`start`?, `end`?): `Promise`\<`object`[]\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:341 - -Asynchronously fetches events emitted by this SmartContract and returns an array of events with their corresponding types. - -#### Parameters - -##### start? - -`UInt32` - -The start height of the events to fetch. - -##### end? - -`UInt32` - -The end height of the events to fetch. If not provided, fetches events up to the latest height. - -#### Returns - -`Promise`\<`object`[]\> - -A promise that resolves to an array of objects, each containing the event type and event data for the specified range. - -#### Async - -#### Throws - -If there is an error fetching events from the Mina network. - -#### Example - -```ts -const startHeight = UInt32.from(1000); -const endHeight = UInt32.from(2000); -const events = await myZkapp.fetchEvents(startHeight, endHeight); -console.log(events); -``` - -#### Inherited from - -`TokenContractV2.fetchEvents` - -*** - -### forEachUpdate() - -> **forEachUpdate**(`updates`, `callback`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:68 - -Iterate through the account updates in `updates` and apply `callback` to each. - -This method is provable and is suitable as a base for implementing `approveUpdates()`. - -#### Parameters - -##### updates - -`AccountUpdateForest` - -##### callback - -(`update`, `usesToken`) => `void` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.forEachUpdate` - -*** - -### init() - -> **init**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:201 - -`SmartContract.init()` will be called only when a SmartContract will be first deployed, not for redeployment. -This method can be overridden as follows -``` -class MyContract extends SmartContract { - init() { - super.init(); - this.account.permissions.set(...); - this.x.set(Field(1)); - } -} -``` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.init` - -*** - -### initializeBase() - -> `protected` **initializeBase**(`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:246](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L246) - -#### Parameters - -##### sequencer - -`PublicKey` - -##### dispatchContract - -`PublicKey` - -##### bridgeContract - -`PublicKey` - -##### contractKey - -`PrivateKey` - -#### Returns - -`Promise`\<`void`\> - -*** - -### newSelf() - -> **newSelf**(`methodName`?): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:230 - -Same as `SmartContract.self` but explicitly creates a new AccountUpdate. - -#### Parameters - -##### methodName? - -`string` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -`TokenContractV2.newSelf` - -*** - -### requireSignature() - -> **requireSignature**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:213 - -Use this command if the account update created by this SmartContract should be signed by the account owner, -instead of authorized with a proof. - -Note that the smart contract's Permissions determine which updates have to be (can be) authorized by a signature. - -If you only want to avoid creating proofs for quicker testing, we advise you to -use `LocalBlockchain({ proofsEnabled: false })` instead of `requireSignature()`. Setting -`proofsEnabled` to `false` allows you to test your transactions with the same authorization flow as in production, -with the only difference being that quick mock proofs are filled in instead of real proofs. - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.requireSignature` - -*** - -### send() - -> **send**(`args`): `AccountUpdate` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:301 - -#### Parameters - -##### args - -###### amount - -`number` \| `bigint` \| `UInt64` - -###### to - -`PublicKey` \| `SmartContract` \| `AccountUpdate` - -#### Returns - -`AccountUpdate` - -#### Inherited from - -`TokenContractV2.send` - -*** - -### settleBase() - -> `protected` **settleBase**(`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:279](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L279) - -#### Parameters - -##### blockProof - -[`DynamicBlockProof`](DynamicBlockProof.md) - -##### signature - -`Signature` - -##### dispatchContractAddress - -`PublicKey` - -##### publicKey - -`PublicKey` - -##### inputNetworkState - -[`NetworkState`](NetworkState.md) - -##### outputNetworkState - -[`NetworkState`](NetworkState.md) - -##### newPromisedMessagesHash - -`Field` - -#### Returns - -`Promise`\<`void`\> - -*** - -### skipAuthorization() - -> **skipAuthorization**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:222 - -Use this command if the account update created by this SmartContract should have no authorization on it, -instead of being authorized with a proof. - -WARNING: This is a method that should rarely be useful. If you want to disable proofs for quicker testing, take a look -at `LocalBlockchain({ proofsEnabled: false })`, which causes mock proofs to be created and doesn't require changing the -authorization flow. - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.skipAuthorization` - -*** - -### transfer() - -> **transfer**(`from`, `to`, `amount`): `Promise`\<`void`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/token/token-contract.d.ts:86 - -Transfer `amount` of tokens from `from` to `to`. - -#### Parameters - -##### from - -`PublicKey` | `AccountUpdate` - -##### to - -`PublicKey` | `AccountUpdate` - -##### amount - -`number` | `bigint` | `UInt64` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -`TokenContractV2.transfer` - -*** - -### analyzeMethods() - -> `static` **analyzeMethods**(`__namedParameters`?): `Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:377 - -This function is run internally before compiling a smart contract, to collect metadata about what each of your -smart contract methods does. - -For external usage, this function can be handy because calling it involves running all methods in the same "mode" as `compile()` does, -so it serves as a quick-to-run check for whether your contract can be compiled without errors, which can greatly speed up iterating. - -`analyzeMethods()` will also return the number of `rows` of each of your method circuits (i.e., the number of constraints in the underlying proof system), -which is a good indicator for circuit size and the time it will take to create proofs. -To inspect the created circuit in detail, you can look at the returned `gates`. - -Note: If this function was already called before, it will short-circuit and just return the metadata collected the first time. - -#### Parameters - -##### \_\_namedParameters? - -###### printSummary - -`boolean` - -#### Returns - -`Promise`\<`Record`\<`string`, \{ `actions`: `number`; `digest`: `string`; `gates`: `Gate`[]; `rows`: `number`; \}\>\> - -an object, keyed by method name, each entry containing: - - `rows` the size of the constraint system created by this method - - `digest` a digest of the method circuit - - `actions` the number of actions the method dispatches - - `gates` the constraint system, represented as an array of gates - -#### Inherited from - -`TokenContractV2.analyzeMethods` - -*** - -### compile() - -> `static` **compile**(`__namedParameters`?): `Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:153 - -Compile your smart contract. - -This generates both the prover functions, needed to create proofs for running `@method`s, -and the verification key, needed to deploy your zkApp. - -Although provers and verification key are returned by this method, they are also cached internally and used when needed, -so you don't actually have to use the return value of this function. - -Under the hood, "compiling" means calling into the lower-level [Pickles and Kimchi libraries](https://o1-labs.github.io/proof-systems/kimchi/overview.html) to -create multiple prover & verifier indices (one for each smart contract method as part of a "step circuit" and one for the "wrap circuit" which recursively wraps -it so that proofs end up in the original finite field). These are fairly expensive operations, so **expect compiling to take at least 20 seconds**, -up to several minutes if your circuit is large or your hardware is not optimal for these operations. - -#### Parameters - -##### \_\_namedParameters? - -###### cache - -`Cache` - -###### forceRecompile - -`boolean` - -#### Returns - -`Promise`\<\{ `provers`: `Prover`[]; `verificationKey`: \{ `data`: `string`; `hash`: `Field`; \}; `verify`: (`statement`, `proof`) => `Promise`\<`boolean`\>; \}\> - -#### Inherited from - -`TokenContractV2.compile` - -*** - -### digest() - -> `static` **digest**(): `Promise`\<`string`\> - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:170 - -Computes a hash of your smart contract, which will reliably change _whenever one of your method circuits changes_. -This digest is quick to compute. it is designed to help with deciding whether a contract should be re-compiled or -a cached verification key can be used. - -#### Returns - -`Promise`\<`string`\> - -the digest, as a hex string - -#### Inherited from - -`TokenContractV2.digest` - -*** - -### Proof() - -> `static` **Proof**(): (`__namedParameters`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:68 - -Returns a Proof type that belongs to this SmartContract. - -#### Returns - -`Function` - -##### Parameters - -###### \_\_namedParameters - -###### maxProofsVerified - -`0` \| `1` \| `2` - -###### proof - -`unknown` - -###### publicInput - -`ZkappPublicInput` - -###### publicOutput - -`undefined` - -##### Returns - -`object` - -###### maxProofsVerified - -> **maxProofsVerified**: `0` \| `1` \| `2` - -###### proof - -> **proof**: `unknown` - -###### publicInput - -> **publicInput**: `ZkappPublicInput` - -###### publicOutput - -> **publicOutput**: `undefined` - -###### shouldVerify - -> **shouldVerify**: `Bool` - -###### toJSON() - -###### Returns - -`JsonProof` - -###### verify() - -###### Returns - -`void` - -###### verifyIf() - -###### Parameters - -###### condition - -`Bool` - -###### Returns - -`void` - -##### publicInputType - -> **publicInputType**: `Omit`\<`Provable`\<\{ `accountUpdate`: `Field`; `calls`: `Field`; \}, \{ `accountUpdate`: `bigint`; `calls`: `bigint`; \}\>, `"fromFields"`\> & `object` & `object` - -###### Type declaration - -###### fromFields() - -> **fromFields**: (`fields`) => `object` - -###### Parameters - -###### fields - -`Field`[] - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### Type declaration - -###### empty() - -> **empty**: () => `object` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### fromJSON() - -> **fromJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`string` - -###### calls - -`string` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `Field` - -###### calls - -> **calls**: `Field` - -###### toInput() - -> **toInput**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### fields? - -> `optional` **fields**: `Field`[] - -###### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -###### toJSON() - -> **toJSON**: (`x`) => `object` - -###### Parameters - -###### x - -###### accountUpdate - -`Field` - -###### calls - -`Field` - -###### Returns - -`object` - -###### accountUpdate - -> **accountUpdate**: `string` - -###### calls - -> **calls**: `string` - -##### publicOutputType - -> **publicOutputType**: `ProvablePureExtended`\<`undefined`, `undefined`, `null`\> - -##### tag() - -> **tag**: () => *typeof* `SmartContract` - -###### Returns - -*typeof* `SmartContract` - -##### dummy() - -###### Type Parameters - -• **Input** - -• **OutPut** - -###### Parameters - -###### publicInput - -`Input` - -###### publicOutput - -`OutPut` - -###### maxProofsVerified - -`0` | `1` | `2` - -###### domainLog2? - -`number` - -###### Returns - -`Promise`\<`Proof`\<`Input`, `OutPut`\>\> - -##### fromJSON() - -###### Type Parameters - -• **S** *extends* (...`args`) => `Proof`\<`unknown`, `unknown`\> & `object` & `object` - -###### Parameters - -###### this - -`S` - -###### \_\_namedParameters - -`JsonProof` - -###### Returns - -`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -#### Inherited from - -`TokenContractV2.Proof` - -*** - -### runOutsideCircuit() - -> `static` **runOutsideCircuit**(`run`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/mina/zkapp.d.ts:357 - -#### Parameters - -##### run - -() => `void` - -#### Returns - -`void` - -#### Inherited from - -`TokenContractV2.runOutsideCircuit` diff --git a/src/pages/docs/reference/protocol/classes/SignedTransaction.md b/src/pages/docs/reference/protocol/classes/SignedTransaction.md deleted file mode 100644 index c7625d9..0000000 --- a/src/pages/docs/reference/protocol/classes/SignedTransaction.md +++ /dev/null @@ -1,607 +0,0 @@ ---- -title: SignedTransaction ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SignedTransaction - -# Class: SignedTransaction - -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L5) - -## Extends - -- `object` - -## Constructors - -### new SignedTransaction() - -> **new SignedTransaction**(`value`): [`SignedTransaction`](SignedTransaction.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -[`SignedTransaction`](SignedTransaction.md) - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).constructor` - -## Properties - -### signature - -> **signature**: `Signature` = `Signature` - -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L7) - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).signature` - -*** - -### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L6) - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).transaction` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### signature - -> **signature**: `Signature` = `Signature` - -##### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`, `aux`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 - -A function that returns an element of type `T` from the given provable and "auxiliary" data. - -This function is the reverse operation of calling [toFields](SignedTransaction.md#tofields) and toAuxilary methods on an element of type `T`. - -#### Parameters - -##### fields - -`Field`[] - -an array of Field elements describing the provable data of the new `T` element. - -##### aux - -`any`[] - -an array of any type describing the "auxiliary" data of the new `T` element, optional. - -#### Returns - -`object` - -An element of type `T` generated from the given provable and "auxiliary" data. - -##### signature - -> **signature**: `Signature` = `Signature` - -##### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### signature - -`any` = `Signature` - -###### transaction - -\{ `argsHash`: `string`; `methodId`: `string`; `nonce`: \{ `isSome`: `boolean`; `value`: `any`; \}; `sender`: \{ `isSome`: `boolean`; `value`: `any`; \}; \} = `RuntimeTransaction` - -###### transaction.argsHash - -`string` = `Field` - -###### transaction.methodId - -`string` = `Field` - -###### transaction.nonce - -\{ `isSome`: `boolean`; `value`: `any`; \} = `UInt64Option` - -###### transaction.nonce.isSome - -`boolean` = `Bool` - -###### transaction.nonce.value - -`any` = `valueType` - -###### transaction.sender - -\{ `isSome`: `boolean`; `value`: `any`; \} = `PublicKeyOption` - -###### transaction.sender.isSome - -`boolean` = `Bool` - -###### transaction.sender.value - -`any` = `valueType` - -#### Returns - -`object` - -##### signature - -> **signature**: `Signature` = `Signature` - -##### transaction - -> **transaction**: [`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`object` - -##### signature - -> **signature**: `any` = `Signature` - -##### transaction - -> **transaction**: `object` = `RuntimeTransaction` - -###### transaction.argsHash - -> **transaction.argsHash**: `string` = `Field` - -###### transaction.methodId - -> **transaction.methodId**: `string` = `Field` - -###### transaction.nonce - -> **transaction.nonce**: `object` = `UInt64Option` - -###### transaction.nonce.isSome - -> **transaction.nonce.isSome**: `boolean` = `Bool` - -###### transaction.nonce.value - -> **transaction.nonce.value**: `any` = `valueType` - -###### transaction.sender - -> **transaction.sender**: `object` = `PublicKeyOption` - -###### transaction.sender.isSome - -> **transaction.sender.isSome**: `boolean` = `Bool` - -###### transaction.sender.value - -> **transaction.sender.value**: `any` = `valueType` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### signature - -`Signature` = `Signature` - -###### transaction - -[`RuntimeTransaction`](RuntimeTransaction.md) = `RuntimeTransaction` - -#### Returns - -`object` - -##### signature - -> **signature**: `any` = `Signature` - -##### transaction - -> **transaction**: `object` = `RuntimeTransaction` - -###### transaction.argsHash - -> **transaction.argsHash**: `bigint` = `Field` - -###### transaction.methodId - -> **transaction.methodId**: `bigint` = `Field` - -###### transaction.nonce - -> **transaction.nonce**: `object` = `UInt64Option` - -###### transaction.nonce.isSome - -> **transaction.nonce.isSome**: `boolean` = `Bool` - -###### transaction.nonce.value - -> **transaction.nonce.value**: `any` = `valueType` - -###### transaction.sender - -> **transaction.sender**: `object` = `PublicKeyOption` - -###### transaction.sender.isSome - -> **transaction.sender.isSome**: `boolean` = `Bool` - -###### transaction.sender.value - -> **transaction.sender.value**: `any` = `valueType` - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).toValue` - -## Methods - -### getSignatureData() - -> **getSignatureData**(): `Field`[] - -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L32) - -#### Returns - -`Field`[] - -*** - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L28) - -#### Returns - -`Field` - -*** - -### validateSignature() - -> **validateSignature**(): `Bool` - -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L41) - -#### Returns - -`Bool` - -*** - -### dummy() - -> `static` **dummy**(): [`SignedTransaction`](SignedTransaction.md) - -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L17) - -#### Returns - -[`SignedTransaction`](SignedTransaction.md) - -*** - -### getSignatureData() - -> `static` **getSignatureData**(`args`): `Field`[] - -Defined in: [packages/protocol/src/model/transaction/SignedTransaction.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/SignedTransaction.ts#L9) - -#### Parameters - -##### args - -###### argsHash - -`Field` - -###### methodId - -`Field` - -###### nonce - -`UInt64` - -#### Returns - -`Field`[] - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ transaction: RuntimeTransaction, signature: Signature, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/State.md b/src/pages/docs/reference/protocol/classes/State.md deleted file mode 100644 index b9c6ff3..0000000 --- a/src/pages/docs/reference/protocol/classes/State.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: State ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / State - -# Class: State\ - -Defined in: [packages/protocol/src/state/State.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L42) - -Utilities for runtime module state, such as get/set - -## Extends - -- [`WithPath`](WithPath.md)\<`this`\> & [`WithStateServiceProvider`](WithStateServiceProvider.md)\<`this`\> - -## Type Parameters - -• **Value** - -## Constructors - -### new State() - -> **new State**\<`Value`\>(`valueType`): [`State`](State.md)\<`Value`\> - -Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L53) - -#### Parameters - -##### valueType - -`FlexibleProvablePure`\<`Value`\> - -#### Returns - -[`State`](State.md)\<`Value`\> - -#### Overrides - -`Mixin(WithPath, WithStateServiceProvider).constructor` - -## Properties - -### path? - -> `optional` **path**: `Field` - -Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L14) - -#### Inherited from - -`Mixin(WithPath, WithStateServiceProvider).path` - -*** - -### stateServiceProvider? - -> `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) - -Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L26) - -#### Inherited from - -`Mixin(WithPath, WithStateServiceProvider).stateServiceProvider` - -*** - -### valueType - -> **valueType**: `FlexibleProvablePure`\<`Value`\> - -Defined in: [packages/protocol/src/state/State.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L53) - -## Methods - -### get() - -> **get**(): `Promise`\<[`Option`](Option.md)\<`Value`\>\> - -Defined in: [packages/protocol/src/state/State.ts:133](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L133) - -Retrieves the current state and creates a state transition -anchoring the use of the current state value in the circuit. - -#### Returns - -`Promise`\<[`Option`](Option.md)\<`Value`\>\> - -Option representation of the current state. - -*** - -### hasPathOrFail() - -> **hasPathOrFail**(): `asserts this is { path: Path }` - -Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L16) - -#### Returns - -`asserts this is { path: Path }` - -#### Inherited from - -`Mixin(WithPath, WithStateServiceProvider).hasPathOrFail` - -*** - -### hasStateServiceOrFail() - -> **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` - -Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L28) - -#### Returns - -`asserts this is { stateServiceProvider: StateServiceProvider }` - -#### Inherited from - -`Mixin(WithPath, WithStateServiceProvider).hasStateServiceOrFail` - -*** - -### set() - -> **set**(`value`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/state/State.ts:158](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L158) - -Sets a new state value by creating a state transition from -the current value to the newly set value. - -The newly set value isn't available via state.get(), since the -state transitions are not applied within the same circuit. -You can however store and access your new value in -a separate circuit variable. - -#### Parameters - -##### value - -`Value` - -Value to be set as the current state - -#### Returns - -`Promise`\<`void`\> - -*** - -### from() - -> `static` **from**\<`Value`\>(`valueType`): [`State`](State.md)\<`Value`\> - -Defined in: [packages/protocol/src/state/State.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L49) - -Creates a new state wrapper for the provided value type. - -#### Type Parameters - -• **Value** - -#### Parameters - -##### valueType - -`FlexibleProvablePure`\<`Value`\> - -Type of value to be stored (e.g. UInt64, Struct, ...) - -#### Returns - -[`State`](State.md)\<`Value`\> - -New state for the given value type. diff --git a/src/pages/docs/reference/protocol/classes/StateMap.md b/src/pages/docs/reference/protocol/classes/StateMap.md deleted file mode 100644 index c8f70ac..0000000 --- a/src/pages/docs/reference/protocol/classes/StateMap.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -title: StateMap ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateMap - -# Class: StateMap\ - -Defined in: [packages/protocol/src/state/StateMap.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L12) - -Map-like wrapper for state - -## Extends - -- [`WithPath`](WithPath.md)\<`this`\> & [`WithStateServiceProvider`](WithStateServiceProvider.md)\<`this`\> - -## Type Parameters - -• **KeyType** - -• **ValueType** - -## Constructors - -### new StateMap() - -> **new StateMap**\<`KeyType`, `ValueType`\>(`keyType`, `valueType`): [`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> - -Defined in: [packages/protocol/src/state/StateMap.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L30) - -#### Parameters - -##### keyType - -`FlexibleProvablePure`\<`KeyType`\> - -##### valueType - -`FlexibleProvablePure`\<`ValueType`\> - -#### Returns - -[`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> - -#### Overrides - -`Mixin( WithPath, WithStateServiceProvider ).constructor` - -## Properties - -### keyType - -> **keyType**: `FlexibleProvablePure`\<`KeyType`\> - -Defined in: [packages/protocol/src/state/StateMap.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L31) - -*** - -### path? - -> `optional` **path**: `Field` - -Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L14) - -#### Inherited from - -`Mixin( WithPath, WithStateServiceProvider ).path` - -*** - -### stateServiceProvider? - -> `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) - -Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L26) - -#### Inherited from - -`Mixin( WithPath, WithStateServiceProvider ).stateServiceProvider` - -*** - -### valueType - -> **valueType**: `FlexibleProvablePure`\<`ValueType`\> - -Defined in: [packages/protocol/src/state/StateMap.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L32) - -## Methods - -### get() - -> **get**(`key`): `Promise`\<[`Option`](Option.md)\<`ValueType`\>\> - -Defined in: [packages/protocol/src/state/StateMap.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L48) - -Obtains a value for the provided key in the current state map. - -#### Parameters - -##### key - -`KeyType` - -Key to obtain the state for - -#### Returns - -`Promise`\<[`Option`](Option.md)\<`ValueType`\>\> - -Value for the provided key. - -*** - -### getPath() - -> **getPath**(`key`): `Field` - -Defined in: [packages/protocol/src/state/StateMap.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L37) - -#### Parameters - -##### key - -`KeyType` - -#### Returns - -`Field` - -*** - -### hasPathOrFail() - -> **hasPathOrFail**(): `asserts this is { path: Path }` - -Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L16) - -#### Returns - -`asserts this is { path: Path }` - -#### Inherited from - -`Mixin( WithPath, WithStateServiceProvider ).hasPathOrFail` - -*** - -### hasStateServiceOrFail() - -> **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` - -Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L28) - -#### Returns - -`asserts this is { stateServiceProvider: StateServiceProvider }` - -#### Inherited from - -`Mixin( WithPath, WithStateServiceProvider ).hasStateServiceOrFail` - -*** - -### set() - -> **set**(`key`, `value`): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/state/StateMap.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L64) - -Sets a value for the given key in the current state map. - -#### Parameters - -##### key - -`KeyType` - -Key to store the value under - -##### value - -`ValueType` - -Value to be stored under the given key - -#### Returns - -`Promise`\<`void`\> - -*** - -### from() - -> `static` **from**\<`KeyType`, `ValueType`\>(`keyType`, `valueType`): [`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> - -Defined in: [packages/protocol/src/state/StateMap.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateMap.ts#L23) - -Create a new state map with the given key and value types - -#### Type Parameters - -• **KeyType** - -• **ValueType** - -#### Parameters - -##### keyType - -`FlexibleProvablePure`\<`KeyType`\> - -Type to be used as a key - -##### valueType - -`FlexibleProvablePure`\<`ValueType`\> - -Type to be stored as a value - -#### Returns - -[`StateMap`](StateMap.md)\<`KeyType`, `ValueType`\> - -State map with provided key and value types. diff --git a/src/pages/docs/reference/protocol/classes/StateServiceProvider.md b/src/pages/docs/reference/protocol/classes/StateServiceProvider.md deleted file mode 100644 index e315b12..0000000 --- a/src/pages/docs/reference/protocol/classes/StateServiceProvider.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: StateServiceProvider ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateServiceProvider - -# Class: StateServiceProvider - -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateServiceProvider.ts#L14) - -## Constructors - -### new StateServiceProvider() - -> **new StateServiceProvider**(): [`StateServiceProvider`](StateServiceProvider.md) - -#### Returns - -[`StateServiceProvider`](StateServiceProvider.md) - -## Accessors - -### stateService - -#### Get Signature - -> **get** **stateService**(): [`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) - -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateServiceProvider.ts#L17) - -##### Returns - -[`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) - -## Methods - -### popCurrentStateService() - -> **popCurrentStateService**(): `void` - -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateServiceProvider.ts#L30) - -#### Returns - -`void` - -*** - -### setCurrentStateService() - -> **setCurrentStateService**(`service`): `void` - -Defined in: [packages/protocol/src/state/StateServiceProvider.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateServiceProvider.ts#L26) - -#### Parameters - -##### service - -[`SimpleAsyncStateService`](../interfaces/SimpleAsyncStateService.md) - -#### Returns - -`void` diff --git a/src/pages/docs/reference/protocol/classes/StateTransition.md b/src/pages/docs/reference/protocol/classes/StateTransition.md deleted file mode 100644 index e529e11..0000000 --- a/src/pages/docs/reference/protocol/classes/StateTransition.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -title: StateTransition ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransition - -# Class: StateTransition\ - -Defined in: [packages/protocol/src/model/StateTransition.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L32) - -Generic state transition that constraints the current method circuit -to external state, by providing a state anchor. - -## Type Parameters - -• **Value** - -## Constructors - -### new StateTransition() - -> **new StateTransition**\<`Value`\>(`path`, `fromValue`, `toValue`): [`StateTransition`](StateTransition.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/StateTransition.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L45) - -#### Parameters - -##### path - -`Field` - -##### fromValue - -[`Option`](Option.md)\<`Value`\> - -##### toValue - -[`Option`](Option.md)\<`Field`\> | [`Option`](Option.md)\<`Value`\> - -#### Returns - -[`StateTransition`](StateTransition.md)\<`Value`\> - -## Properties - -### fromValue - -> **fromValue**: [`Option`](Option.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/StateTransition.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L47) - -*** - -### path - -> **path**: `Field` - -Defined in: [packages/protocol/src/model/StateTransition.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L46) - -*** - -### toValue - -> **toValue**: [`Option`](Option.md)\<`Field`\> \| [`Option`](Option.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/StateTransition.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L48) - -## Accessors - -### from - -#### Get Signature - -> **get** **from**(): [`Option`](Option.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/StateTransition.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L51) - -##### Returns - -[`Option`](Option.md)\<`Value`\> - -*** - -### to - -#### Get Signature - -> **get** **to**(): [`Option`](Option.md)\<`Field`\> \| [`Option`](Option.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/StateTransition.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L57) - -##### Returns - -[`Option`](Option.md)\<`Field`\> \| [`Option`](Option.md)\<`Value`\> - -## Methods - -### toConstant() - -> **toConstant**(): [`StateTransition`](StateTransition.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/StateTransition.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L81) - -#### Returns - -[`StateTransition`](StateTransition.md)\<`Value`\> - -*** - -### toJSON() - -> **toJSON**(): `object` - -Defined in: [packages/protocol/src/model/StateTransition.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L73) - -#### Returns - -`object` - -##### from - -> **from**: `object` - -###### from.isForcedSome - -> **from.isForcedSome**: `boolean` - -###### from.isSome - -> **from.isSome**: `boolean` - -###### from.value - -> **from.value**: `string`[] - -##### path - -> **path**: `string` - -##### to - -> **to**: `object` - -###### to.isForcedSome - -> **to.isForcedSome**: `boolean` - -###### to.isSome - -> **to.isSome**: `boolean` - -###### to.value - -> **to.value**: `string`[] - -*** - -### toProvable() - -> **toProvable**(): [`ProvableStateTransition`](ProvableStateTransition.md) - -Defined in: [packages/protocol/src/model/StateTransition.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L65) - -Converts a StateTransition to a ProvableStateTransition, -while enforcing the 'from' property to be 'Some' in all cases. - -#### Returns - -[`ProvableStateTransition`](ProvableStateTransition.md) - -*** - -### from() - -> `static` **from**\<`Value`\>(`path`, `fromValue`): [`StateTransition`](StateTransition.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/StateTransition.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L33) - -#### Type Parameters - -• **Value** - -#### Parameters - -##### path - -`Field` - -##### fromValue - -[`Option`](Option.md)\<`Value`\> - -#### Returns - -[`StateTransition`](StateTransition.md)\<`Value`\> - -*** - -### fromTo() - -> `static` **fromTo**\<`Value`\>(`path`, `fromValue`, `toValue`): [`StateTransition`](StateTransition.md)\<`Value`\> - -Defined in: [packages/protocol/src/model/StateTransition.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransition.ts#L37) - -#### Type Parameters - -• **Value** - -#### Parameters - -##### path - -`Field` - -##### fromValue - -[`Option`](Option.md)\<`Value`\> - -##### toValue - -[`Option`](Option.md)\<`Value`\> - -#### Returns - -[`StateTransition`](StateTransition.md)\<`Value`\> diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md b/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md deleted file mode 100644 index 97569e0..0000000 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProvableBatch.md +++ /dev/null @@ -1,507 +0,0 @@ ---- -title: StateTransitionProvableBatch ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProvableBatch - -# Class: StateTransitionProvableBatch - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L58) - -A Batch of StateTransitions to be consumed by the StateTransitionProver -to prove multiple STs at once - -transitionType: -true == normal ST, false == protocol ST - -## Extends - -- `object` - -## Properties - -### batch - -> **batch**: [`ProvableStateTransition`](ProvableStateTransition.md)[] - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L59) - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).batch` - -*** - -### merkleWitnesses - -> **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L69) - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).merkleWitnesses` - -*** - -### transitionTypes - -> **transitionTypes**: [`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L64) - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).transitionTypes` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### batch - -[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` - -###### merkleWitnesses - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` - -###### transitionTypes - -[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### batch - -> **batch**: [`ProvableStateTransition`](ProvableStateTransition.md)[] - -##### merkleWitnesses - -> **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] - -##### transitionTypes - -> **transitionTypes**: [`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### batch - -> **batch**: [`ProvableStateTransition`](ProvableStateTransition.md)[] - -##### merkleWitnesses - -> **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] - -##### transitionTypes - -> **transitionTypes**: [`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### batch - -`object`[] = `...` - -###### merkleWitnesses - -`object`[] = `...` - -###### transitionTypes - -`object`[] = `...` - -#### Returns - -`object` - -##### batch - -> **batch**: [`ProvableStateTransition`](ProvableStateTransition.md)[] - -##### merkleWitnesses - -> **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] - -##### transitionTypes - -> **transitionTypes**: [`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### batch - -[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` - -###### merkleWitnesses - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` - -###### transitionTypes - -[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### batch - -[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` - -###### merkleWitnesses - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` - -###### transitionTypes - -[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### batch - -[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` - -###### merkleWitnesses - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` - -###### transitionTypes - -[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### batch - -[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` - -###### merkleWitnesses - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` - -###### transitionTypes - -[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` - -#### Returns - -`object` - -##### batch - -> **batch**: `object`[] - -##### merkleWitnesses - -> **merkleWitnesses**: `object`[] - -##### transitionTypes - -> **transitionTypes**: `object`[] - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### batch - -[`ProvableStateTransition`](ProvableStateTransition.md)[] = `...` - -###### merkleWitnesses - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] = `...` - -###### transitionTypes - -[`ProvableStateTransitionType`](ProvableStateTransitionType.md)[] = `...` - -#### Returns - -`object` - -##### batch - -> **batch**: `object`[] - -##### merkleWitnesses - -> **merkleWitnesses**: `object`[] - -##### transitionTypes - -> **transitionTypes**: `object`[] - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).toValue` - -## Methods - -### fromMappings() - -> `static` **fromMappings**(`transitions`, `merkleWitnesses`): [`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L74) - -#### Parameters - -##### transitions - -`object`[] - -##### merkleWitnesses - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] - -#### Returns - -[`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) - -*** - -### fromTransitions() - -> `static` **fromTransitions**(`transitions`, `protocolTransitions`, `merkleWitnesses`): [`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:111](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L111) - -#### Parameters - -##### transitions - -[`ProvableStateTransition`](ProvableStateTransition.md)[] - -##### protocolTransitions - -[`ProvableStateTransition`](ProvableStateTransition.md)[] - -##### merkleWitnesses - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] - -#### Returns - -[`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ batch: Provable.Array( ProvableStateTransition, constants.stateTransitionProverBatchSize ), transitionTypes: Provable.Array( ProvableStateTransitionType, constants.stateTransitionProverBatchSize ), merkleWitnesses: Provable.Array( RollupMerkleTreeWitness, constants.stateTransitionProverBatchSize ), }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProver.md b/src/pages/docs/reference/protocol/classes/StateTransitionProver.md deleted file mode 100644 index 7fa408a..0000000 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProver.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -title: StateTransitionProver ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProver - -# Class: StateTransitionProver - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:343](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L343) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ProtocolModule`](ProtocolModule.md) - -## Implements - -- [`StateTransitionProvable`](../interfaces/StateTransitionProvable.md) -- [`StateTransitionProverType`](../interfaces/StateTransitionProverType.md) -- [`CompilableModule`](../../common/interfaces/CompilableModule.md) - -## Constructors - -### new StateTransitionProver() - -> **new StateTransitionProver**(): [`StateTransitionProver`](StateTransitionProver.md) - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:352](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L352) - -#### Returns - -[`StateTransitionProver`](StateTransitionProver.md) - -#### Overrides - -[`ProtocolModule`](ProtocolModule.md).[`constructor`](ProtocolModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Implementation of - -[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`currentConfig`](../interfaces/StateTransitionProverType.md#currentconfig) - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`currentConfig`](ProtocolModule.md#currentconfig) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](../interfaces/ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Implementation of - -[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`protocol`](../interfaces/StateTransitionProverType.md#protocol) - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`protocol`](ProtocolModule.md#protocol) - -*** - -### zkProgrammable - -> **zkProgrammable**: [`StateTransitionProverProgrammable`](StateTransitionProverProgrammable.md) - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:350](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L350) - -#### Implementation of - -[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`zkProgrammable`](../interfaces/StateTransitionProverType.md#zkprogrammable) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Implementation of - -[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`areProofsEnabled`](../interfaces/StateTransitionProverType.md#areproofsenabled) - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`areProofsEnabled`](ProtocolModule.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Implementation of - -[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`config`](../interfaces/StateTransitionProverType.md#config) - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`config`](ProtocolModule.md#config) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:357](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L357) - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -#### Implementation of - -[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Implementation of - -[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`create`](../interfaces/StateTransitionProverType.md#create) - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`create`](ProtocolModule.md#create) - -*** - -### merge() - -> **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:370](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L370) - -#### Parameters - -##### publicInput - -[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) - -##### proof1 - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -##### proof2 - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -#### Returns - -`Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -#### Implementation of - -[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`merge`](../interfaces/StateTransitionProverType.md#merge) - -*** - -### runBatch() - -> **runBatch**(`publicInput`, `batch`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:363](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L363) - -#### Parameters - -##### publicInput - -[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) - -##### batch - -[`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) - -#### Returns - -`Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -#### Implementation of - -[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`runBatch`](../interfaces/StateTransitionProverType.md#runbatch) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md).[`start`](../interfaces/StateTransitionProverType.md#start) - -#### Inherited from - -[`ProtocolModule`](ProtocolModule.md).[`start`](ProtocolModule.md#start) diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md deleted file mode 100644 index 9f254ac..0000000 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProverProgrammable.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -title: StateTransitionProverProgrammable ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProverProgrammable - -# Class: StateTransitionProverProgrammable - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L74) - -StateTransitionProver is the prover that proves the application of some state -transitions and checks and updates their merkle-tree entries - -## Extends - -- [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -## Constructors - -### new StateTransitionProverProgrammable() - -> **new StateTransitionProverProgrammable**(`stateTransitionProver`): [`StateTransitionProverProgrammable`](StateTransitionProverProgrammable.md) - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L78) - -#### Parameters - -##### stateTransitionProver - -[`StateTransitionProver`](StateTransitionProver.md) - -#### Returns - -[`StateTransitionProverProgrammable`](StateTransitionProverProgrammable.md) - -#### Overrides - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`constructor`](../../common/classes/ZkProgrammable.md#constructors) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L84) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Overrides - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`areProofsEnabled`](../../common/classes/ZkProgrammable.md#areproofsenabled) - -*** - -### zkProgram - -#### Get Signature - -> **get** **zkProgram**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] - -Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:34 - -##### Returns - -[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<`PublicInput`, `PublicOutput`\>[] - -#### Inherited from - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgram`](../../common/classes/ZkProgrammable.md#zkprogram) - -## Methods - -### applyTransition() - -> **applyTransition**(`state`, `transition`, `type`, `merkleWitness`, `index`): `void` - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:197](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L197) - -Applies a single state transition to the given state -and mutates it in place - -#### Parameters - -##### state - -`StateTransitionProverExecutionState` - -##### transition - -[`ProvableStateTransition`](ProvableStateTransition.md) - -##### type - -[`ProvableStateTransitionType`](ProvableStateTransitionType.md) - -##### merkleWitness - -[`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md) - -##### index - -`number` = `0` - -#### Returns - -`void` - -*** - -### applyTransitions() - -> **applyTransitions**(`stateRoot`, `protocolStateRoot`, `stateTransitionCommitmentFrom`, `protocolTransitionCommitmentFrom`, `transitionBatch`): `StateTransitionProverExecutionState` - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:151](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L151) - -Applies the state transitions to the current stateRoot -and returns the new prover state - -#### Parameters - -##### stateRoot - -`Field` - -##### protocolStateRoot - -`Field` - -##### stateTransitionCommitmentFrom - -`Field` - -##### protocolTransitionCommitmentFrom - -`Field` - -##### transitionBatch - -[`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) - -#### Returns - -`StateTransitionProverExecutionState` - -*** - -### compile() - -> **compile**(`registry`): `Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> - -Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:35 - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`Record`\<`string`, [`CompileArtifact`](../../common/interfaces/CompileArtifact.md)\>\> - -#### Inherited from - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`compile`](../../common/classes/ZkProgrammable.md#compile) - -*** - -### merge() - -> **merge**(`publicInput`, `proof1`, `proof2`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:267](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L267) - -#### Parameters - -##### publicInput - -[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) - -##### proof1 - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -##### proof2 - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -#### Returns - -`Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -*** - -### runBatch() - -> **runBatch**(`publicInput`, `batch`): `Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:246](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L246) - -Applies a whole batch of StateTransitions at once - -#### Parameters - -##### publicInput - -[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) - -##### batch - -[`StateTransitionProvableBatch`](StateTransitionProvableBatch.md) - -#### Returns - -`Promise`\<[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\> - -*** - -### zkProgramFactory() - -> **zkProgramFactory**(): [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\>[] - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProver.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProver.ts#L88) - -#### Returns - -[`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md)\>[] - -#### Overrides - -[`ZkProgrammable`](../../common/classes/ZkProgrammable.md).[`zkProgramFactory`](../../common/classes/ZkProgrammable.md#zkprogramfactory) diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md deleted file mode 100644 index a049be6..0000000 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicInput.md +++ /dev/null @@ -1,549 +0,0 @@ ---- -title: StateTransitionProverPublicInput ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProverPublicInput - -# Class: StateTransitionProverPublicInput - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L6) - -## Extends - -- `object` - -## Constructors - -### new StateTransitionProverPublicInput() - -> **new StateTransitionProverPublicInput**(`value`): [`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -[`StateTransitionProverPublicInput`](StateTransitionProverPublicInput.md) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).constructor` - -## Properties - -### protocolStateRoot - -> **protocolStateRoot**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L10) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).protocolStateRoot` - -*** - -### protocolTransitionsHash - -> **protocolTransitionsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L8) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).protocolTransitionsHash` - -*** - -### stateRoot - -> **stateRoot**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L9) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).stateRoot` - -*** - -### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L7) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).stateTransitionsHash` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### protocolStateRoot - -> **protocolStateRoot**: `Field` = `Field` - -##### protocolTransitionsHash - -> **protocolTransitionsHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### protocolStateRoot - -> **protocolStateRoot**: `Field` = `Field` - -##### protocolTransitionsHash - -> **protocolTransitionsHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### protocolStateRoot - -`string` = `Field` - -###### protocolTransitionsHash - -`string` = `Field` - -###### stateRoot - -`string` = `Field` - -###### stateTransitionsHash - -`string` = `Field` - -#### Returns - -`object` - -##### protocolStateRoot - -> **protocolStateRoot**: `Field` = `Field` - -##### protocolTransitionsHash - -> **protocolTransitionsHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### protocolStateRoot - -> **protocolStateRoot**: `string` = `Field` - -##### protocolTransitionsHash - -> **protocolTransitionsHash**: `string` = `Field` - -##### stateRoot - -> **stateRoot**: `string` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `string` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### protocolStateRoot - -> **protocolStateRoot**: `bigint` = `Field` - -##### protocolTransitionsHash - -> **protocolTransitionsHash**: `bigint` = `Field` - -##### stateRoot - -> **stateRoot**: `bigint` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `bigint` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md b/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md deleted file mode 100644 index 3709b0e..0000000 --- a/src/pages/docs/reference/protocol/classes/StateTransitionProverPublicOutput.md +++ /dev/null @@ -1,549 +0,0 @@ ---- -title: StateTransitionProverPublicOutput ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProverPublicOutput - -# Class: StateTransitionProverPublicOutput - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L13) - -## Extends - -- `object` - -## Constructors - -### new StateTransitionProverPublicOutput() - -> **new StateTransitionProverPublicOutput**(`value`): [`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -[`StateTransitionProverPublicOutput`](StateTransitionProverPublicOutput.md) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).constructor` - -## Properties - -### protocolStateRoot - -> **protocolStateRoot**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L17) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).protocolStateRoot` - -*** - -### protocolTransitionsHash - -> **protocolTransitionsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L15) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).protocolTransitionsHash` - -*** - -### stateRoot - -> **stateRoot**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L16) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).stateRoot` - -*** - -### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L14) - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).stateTransitionsHash` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### protocolStateRoot - -> **protocolStateRoot**: `Field` = `Field` - -##### protocolTransitionsHash - -> **protocolTransitionsHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### protocolStateRoot - -> **protocolStateRoot**: `Field` = `Field` - -##### protocolTransitionsHash - -> **protocolTransitionsHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### protocolStateRoot - -`string` = `Field` - -###### protocolTransitionsHash - -`string` = `Field` - -###### stateRoot - -`string` = `Field` - -###### stateTransitionsHash - -`string` = `Field` - -#### Returns - -`object` - -##### protocolStateRoot - -> **protocolStateRoot**: `Field` = `Field` - -##### protocolTransitionsHash - -> **protocolTransitionsHash**: `Field` = `Field` - -##### stateRoot - -> **stateRoot**: `Field` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `Field` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### protocolStateRoot - -> **protocolStateRoot**: `string` = `Field` - -##### protocolTransitionsHash - -> **protocolTransitionsHash**: `string` = `Field` - -##### stateRoot - -> **stateRoot**: `string` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `string` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### protocolStateRoot - -`Field` = `Field` - -###### protocolTransitionsHash - -`Field` = `Field` - -###### stateRoot - -`Field` = `Field` - -###### stateTransitionsHash - -`Field` = `Field` - -#### Returns - -`object` - -##### protocolStateRoot - -> **protocolStateRoot**: `bigint` = `Field` - -##### protocolTransitionsHash - -> **protocolTransitionsHash**: `bigint` = `Field` - -##### stateRoot - -> **stateRoot**: `bigint` = `Field` - -##### stateTransitionsHash - -> **stateTransitionsHash**: `bigint` = `Field` - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ stateTransitionsHash: Field, protocolTransitionsHash: Field, stateRoot: Field, protocolStateRoot: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md b/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md deleted file mode 100644 index c10ac5d..0000000 --- a/src/pages/docs/reference/protocol/classes/StateTransitionReductionList.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -title: StateTransitionReductionList ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionReductionList - -# Class: StateTransitionReductionList - -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/StateTransitionReductionList.ts#L11) - -Utilities for creating a hash list from a given value type. - -## Extends - -- [`ProvableReductionHashList`](ProvableReductionHashList.md)\<[`ProvableStateTransition`](ProvableStateTransition.md)\> - -## Constructors - -### new StateTransitionReductionList() - -> **new StateTransitionReductionList**(`valueType`, `commitment`): [`StateTransitionReductionList`](StateTransitionReductionList.md) - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L7) - -#### Parameters - -##### valueType - -`ProvablePure`\<[`ProvableStateTransition`](ProvableStateTransition.md)\> - -##### commitment - -`Field` = `...` - -#### Returns - -[`StateTransitionReductionList`](StateTransitionReductionList.md) - -#### Inherited from - -[`ProvableReductionHashList`](ProvableReductionHashList.md).[`constructor`](ProvableReductionHashList.md#constructors) - -## Properties - -### commitment - -> **commitment**: `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L9) - -#### Inherited from - -[`ProvableReductionHashList`](ProvableReductionHashList.md).[`commitment`](ProvableReductionHashList.md#commitment-1) - -*** - -### unconstrainedList - -> **unconstrainedList**: [`ProvableStateTransition`](ProvableStateTransition.md)[] = `[]` - -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L6) - -#### Inherited from - -[`ProvableReductionHashList`](ProvableReductionHashList.md).[`unconstrainedList`](ProvableReductionHashList.md#unconstrainedlist) - -*** - -### valueType - -> `protected` `readonly` **valueType**: `ProvablePure`\<[`ProvableStateTransition`](ProvableStateTransition.md)\> - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L8) - -#### Inherited from - -[`ProvableReductionHashList`](ProvableReductionHashList.md).[`valueType`](ProvableReductionHashList.md#valuetype-1) - -## Methods - -### hash() - -> **hash**(`elements`): `Field` - -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L65) - -#### Parameters - -##### elements - -`Field`[] - -#### Returns - -`Field` - -#### Inherited from - -[`ProvableReductionHashList`](ProvableReductionHashList.md).[`hash`](ProvableReductionHashList.md#hash) - -*** - -### push() - -> **push**(`value`): [`StateTransitionReductionList`](StateTransitionReductionList.md) - -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/StateTransitionReductionList.ts#L12) - -Converts the provided value to Field[] and appends it to -the current hashlist. - -#### Parameters - -##### value - -[`ProvableStateTransition`](ProvableStateTransition.md) - -Value to be appended to the hash list - -#### Returns - -[`StateTransitionReductionList`](StateTransitionReductionList.md) - -Current hash list. - -#### Overrides - -[`ProvableReductionHashList`](ProvableReductionHashList.md).[`push`](ProvableReductionHashList.md#push) - -*** - -### pushAndReduce() - -> **pushAndReduce**(`value`, `reduce`): `object` - -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L12) - -#### Parameters - -##### value - -[`ProvableStateTransition`](ProvableStateTransition.md) - -##### reduce - -(`previous`) => \[[`ProvableStateTransition`](ProvableStateTransition.md), `Bool`\] - -#### Returns - -`object` - -##### popLast - -> **popLast**: `Bool` - -##### value - -> **value**: [`ProvableStateTransition`](ProvableStateTransition.md) - -#### Inherited from - -[`ProvableReductionHashList`](ProvableReductionHashList.md).[`pushAndReduce`](ProvableReductionHashList.md#pushandreduce) - -*** - -### pushIf() - -> **pushIf**(`value`, `condition`): [`StateTransitionReductionList`](StateTransitionReductionList.md) - -Defined in: [packages/protocol/src/utils/ProvableReductionHashList.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableReductionHashList.ts#L59) - -#### Parameters - -##### value - -[`ProvableStateTransition`](ProvableStateTransition.md) - -##### condition - -`Bool` - -#### Returns - -[`StateTransitionReductionList`](StateTransitionReductionList.md) - -#### Inherited from - -[`ProvableReductionHashList`](ProvableReductionHashList.md).[`pushIf`](ProvableReductionHashList.md#pushif) - -*** - -### pushWithMetadata() - -> **pushWithMetadata**(`value`): `object` - -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/StateTransitionReductionList.ts#L18) - -#### Parameters - -##### value - -[`ProvableStateTransition`](ProvableStateTransition.md) - -#### Returns - -`object` - -##### popLast - -> **popLast**: `Bool` - -##### value - -> **value**: [`ProvableStateTransition`](ProvableStateTransition.md) - -*** - -### toField() - -> **toField**(): `Field` - -Defined in: [packages/protocol/src/utils/ProvableHashList.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/ProvableHashList.ts#L41) - -#### Returns - -`Field` - -Traling hash of the current hashlist. - -#### Inherited from - -[`ProvableReductionHashList`](ProvableReductionHashList.md).[`toField`](ProvableReductionHashList.md#tofield) diff --git a/src/pages/docs/reference/protocol/classes/StateTransitionType.md b/src/pages/docs/reference/protocol/classes/StateTransitionType.md deleted file mode 100644 index 77bec3d..0000000 --- a/src/pages/docs/reference/protocol/classes/StateTransitionType.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: StateTransitionType ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionType - -# Class: StateTransitionType - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L13) - -## Constructors - -### new StateTransitionType() - -> **new StateTransitionType**(): [`StateTransitionType`](StateTransitionType.md) - -#### Returns - -[`StateTransitionType`](StateTransitionType.md) - -## Properties - -### normal - -> `readonly` `static` **normal**: `true` = `true` - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L14) - -*** - -### protocol - -> `readonly` `static` **protocol**: `false` = `false` - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L16) - -## Methods - -### isNormal() - -> `static` **isNormal**(`type`): `boolean` - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L18) - -#### Parameters - -##### type - -`boolean` - -#### Returns - -`boolean` - -*** - -### isProtocol() - -> `static` **isProtocol**(`type`): `boolean` - -Defined in: [packages/protocol/src/model/StateTransitionProvableBatch.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/StateTransitionProvableBatch.ts#L22) - -#### Parameters - -##### type - -`boolean` - -#### Returns - -`boolean` diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md b/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md deleted file mode 100644 index 78e2069..0000000 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeAttestation.md +++ /dev/null @@ -1,445 +0,0 @@ ---- -title: TokenBridgeAttestation ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeAttestation - -# Class: TokenBridgeAttestation - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L65) - -## Extends - -- `object` - -## Constructors - -### new TokenBridgeAttestation() - -> **new TokenBridgeAttestation**(`value`): [`TokenBridgeAttestation`](TokenBridgeAttestation.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### index - -`Field` = `Field` - -###### witness - -[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -#### Returns - -[`TokenBridgeAttestation`](TokenBridgeAttestation.md) - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).constructor` - -## Properties - -### index - -> **index**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:67](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L67) - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).index` - -*** - -### witness - -> **witness**: [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L66) - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).witness` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### index - -`Field` = `Field` - -###### witness - -[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### witness - -> **witness**: [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### witness - -> **witness**: [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### index - -`string` = `Field` - -###### witness - -\{ `isLeft`: `boolean`[]; `path`: `string`[]; \} = `TokenBridgeTreeWitness` - -###### witness.isLeft - -`boolean`[] - -###### witness.path - -`string`[] - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### witness - -> **witness**: [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### index - -`Field` = `Field` - -###### witness - -[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### index - -`Field` = `Field` - -###### witness - -[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### witness - -[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### witness - -[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -#### Returns - -`object` - -##### index - -> **index**: `string` = `Field` - -##### witness - -> **witness**: `object` = `TokenBridgeTreeWitness` - -###### witness.isLeft - -> **witness.isLeft**: `boolean`[] - -###### witness.path - -> **witness.path**: `string`[] - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### witness - -[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) = `TokenBridgeTreeWitness` - -#### Returns - -`object` - -##### index - -> **index**: `bigint` = `Field` - -##### witness - -> **witness**: `object` = `TokenBridgeTreeWitness` - -###### witness.isLeft - -> **witness.isLeft**: `boolean`[] - -###### witness.path - -> **witness.path**: `bigint`[] - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ witness: TokenBridgeTreeWitness, index: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md b/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md deleted file mode 100644 index 19557f5..0000000 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeDeploymentAuth.md +++ /dev/null @@ -1,528 +0,0 @@ ---- -title: TokenBridgeDeploymentAuth ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeDeploymentAuth - -# Class: TokenBridgeDeploymentAuth - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L5) - -Interface for cross-contract call authorization -See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 - -## Extends - -- `object` - -## Implements - -- [`ContractAuthorization`](../interfaces/ContractAuthorization.md) - -## Constructors - -### new TokenBridgeDeploymentAuth() - -> **new TokenBridgeDeploymentAuth**(`value`): [`TokenBridgeDeploymentAuth`](TokenBridgeDeploymentAuth.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### address - -`PublicKey` = `PublicKey` - -###### target - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -[`TokenBridgeDeploymentAuth`](TokenBridgeDeploymentAuth.md) - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).constructor` - -## Properties - -### address - -> **address**: `PublicKey` = `PublicKey` - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L9) - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).address` - -*** - -### target - -> **target**: `PublicKey` = `PublicKey` - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L7) - -#### Implementation of - -[`ContractAuthorization`](../interfaces/ContractAuthorization.md).[`target`](../interfaces/ContractAuthorization.md#target) - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).target` - -*** - -### tokenId - -> **tokenId**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L8) - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).tokenId` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### address - -`PublicKey` = `PublicKey` - -###### target - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### target - -> **target**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### target - -> **target**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### address - -`string` = `PublicKey` - -###### target - -`string` = `PublicKey` - -###### tokenId - -`string` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### target - -> **target**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### address - -`PublicKey` = `PublicKey` - -###### target - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### address - -`PublicKey` = `PublicKey` - -###### target - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### target - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### target - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `string` = `PublicKey` - -##### target - -> **target**: `string` = `PublicKey` - -##### tokenId - -> **tokenId**: `string` = `Field` - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### target - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `object` = `PublicKey` - -###### address.isOdd - -> **address.isOdd**: `boolean` - -###### address.x - -> **address.x**: `bigint` - -##### target - -> **target**: `object` = `PublicKey` - -###### target.isOdd - -> **target.isOdd**: `boolean` - -###### target.x - -> **target.x**: `bigint` - -##### tokenId - -> **tokenId**: `bigint` = `Field` - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).toValue` - -## Methods - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/TokenBridgeDeploymentAuth.ts#L13) - -#### Returns - -`Field` - -#### Implementation of - -[`ContractAuthorization`](../interfaces/ContractAuthorization.md).[`hash`](../interfaces/ContractAuthorization.md#hash) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ target: PublicKey, tokenId: Field, address: PublicKey, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md b/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md deleted file mode 100644 index 621939e..0000000 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeEntry.md +++ /dev/null @@ -1,441 +0,0 @@ ---- -title: TokenBridgeEntry ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeEntry - -# Class: TokenBridgeEntry - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L56) - -## Extends - -- `object` - -## Constructors - -### new TokenBridgeEntry() - -> **new TokenBridgeEntry**(`value`): [`TokenBridgeEntry`](TokenBridgeEntry.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -[`TokenBridgeEntry`](TokenBridgeEntry.md) - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).constructor` - -## Properties - -### address - -> **address**: `PublicKey` = `PublicKey` - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L57) - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).address` - -*** - -### tokenId - -> **tokenId**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L58) - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).tokenId` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### address - -`string` = `PublicKey` - -###### tokenId - -`string` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `string` = `PublicKey` - -##### tokenId - -> **tokenId**: `string` = `Field` - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `object` = `PublicKey` - -###### address.isOdd - -> **address.isOdd**: `boolean` - -###### address.x - -> **address.x**: `bigint` - -##### tokenId - -> **tokenId**: `bigint` = `Field` - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).toValue` - -## Methods - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L60) - -#### Returns - -`Field` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ address: PublicKey, tokenId: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md deleted file mode 100644 index f9f0897..0000000 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeTree.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -title: TokenBridgeTree ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeTree - -# Class: TokenBridgeTree - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L15) - -Merkle tree that contains all the deployed token bridges as a mapping of -tokenId => PublicKey - -It should be used as an append-only tree with incremental indizes - this allows -us to reduce the height of it - -## Extends - -- [`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md) - -## Constructors - -### new TokenBridgeTree() - -> **new TokenBridgeTree**(`store`): [`TokenBridgeTree`](TokenBridgeTree.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:113 - -#### Parameters - -##### store - -[`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) - -#### Returns - -[`TokenBridgeTree`](TokenBridgeTree.md) - -#### Inherited from - -`createMerkleTree(256).constructor` - -## Properties - -### indizes - -> **indizes**: `Record`\<`string`, `bigint`\> = `{}` - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L16) - -*** - -### leafCount - -> `readonly` **leafCount**: `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:78 - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`leafCount`](../../common/interfaces/AbstractMerkleTree.md#leafcount) - -*** - -### store - -> **store**: [`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:77 - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`store`](../../common/interfaces/AbstractMerkleTree.md#store) - -*** - -### EMPTY\_ROOT - -> `static` **EMPTY\_ROOT**: `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:118 - -#### Inherited from - -`createMerkleTree(256).EMPTY_ROOT` - -*** - -### HEIGHT - -> `static` **HEIGHT**: `number` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:117 - -#### Inherited from - -`createMerkleTree(256).HEIGHT` - -*** - -### WITNESS - -> `static` **WITNESS**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:114 - -#### Type declaration - -##### dummy() - -> **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -###### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -#### Inherited from - -`createMerkleTree(256).WITNESS` - -## Accessors - -### leafCount - -#### Get Signature - -> **get** `static` **leafCount**(): `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:119 - -##### Returns - -`bigint` - -#### Inherited from - -`createMerkleTree(256).leafCount` - -## Methods - -### assertIndexRange() - -> **assertIndexRange**(`index`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:79 - -#### Parameters - -##### index - -`bigint` - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`assertIndexRange`](../../common/interfaces/AbstractMerkleTree.md#assertindexrange) - -*** - -### fill() - -> **fill**(`leaves`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:110 - -Fills all leaves of the tree. - -#### Parameters - -##### leaves - -`Field`[] - -Values to fill the leaves with. - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`fill`](../../common/interfaces/AbstractMerkleTree.md#fill) - -*** - -### getIndex() - -> **getIndex**(`tokenId`): `bigint` - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L49) - -#### Parameters - -##### tokenId - -`Field` - -#### Returns - -`bigint` - -*** - -### getNode() - -> **getNode**(`level`, `index`): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:86 - -Returns a node which lives at a given index and level. - -#### Parameters - -##### level - -`number` - -Level of the node. - -##### index - -`bigint` - -Index of the node. - -#### Returns - -`Field` - -The data of the node. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getNode`](../../common/interfaces/AbstractMerkleTree.md#getnode) - -*** - -### getRoot() - -> **getRoot**(): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:91 - -Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). - -#### Returns - -`Field` - -The root of the Merkle Tree. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getRoot`](../../common/interfaces/AbstractMerkleTree.md#getroot) - -*** - -### getWitness() - -> **getWitness**(`index`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:105 - -Returns the witness (also known as -[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) -for the leaf at the given index. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -#### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -The witness that belongs to the leaf. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getWitness`](../../common/interfaces/AbstractMerkleTree.md#getwitness) - -*** - -### setLeaf() - -> **setLeaf**(`index`, `leaf`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:97 - -Sets the value of a leaf node at a given index to a given value. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -##### leaf - -`Field` - -New value. - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`setLeaf`](../../common/interfaces/AbstractMerkleTree.md#setleaf) - -*** - -### buildTreeFromEvents() - -> `static` **buildTreeFromEvents**(`contract`): `Promise`\<[`TokenBridgeTree`](TokenBridgeTree.md)\> - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L22) - -Initializes and fills the tree based on all on-chain events that have been -emitted by every emit - -#### Parameters - -##### contract - -`SmartContract` & `object` - -#### Returns - -`Promise`\<[`TokenBridgeTree`](TokenBridgeTree.md)\> diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md deleted file mode 100644 index 674bc84..0000000 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeAddition.md +++ /dev/null @@ -1,453 +0,0 @@ ---- -title: TokenBridgeTreeAddition ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeTreeAddition - -# Class: TokenBridgeTreeAddition - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L70) - -## Extends - -- `object` - -## Constructors - -### new TokenBridgeTreeAddition() - -> **new TokenBridgeTreeAddition**(`value`): [`TokenBridgeTreeAddition`](TokenBridgeTreeAddition.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### index - -`Field` = `Field` - -###### value - -[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -#### Returns - -[`TokenBridgeTreeAddition`](TokenBridgeTreeAddition.md) - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).constructor` - -## Properties - -### index - -> **index**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L71) - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).index` - -*** - -### value - -> **value**: [`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L72) - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).value` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### index - -`Field` = `Field` - -###### value - -[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### value - -> **value**: [`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### value - -> **value**: [`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### index - -`string` = `Field` - -###### value - -\{ `address`: `string`; `tokenId`: `string`; \} = `TokenBridgeEntry` - -###### value.address - -`string` = `PublicKey` - -###### value.tokenId - -`string` = `Field` - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### value - -> **value**: [`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### index - -`Field` = `Field` - -###### value - -[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### index - -`Field` = `Field` - -###### value - -[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### value - -[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### value - -[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -#### Returns - -`object` - -##### index - -> **index**: `string` = `Field` - -##### value - -> **value**: `object` = `TokenBridgeEntry` - -###### value.address - -> **value.address**: `string` = `PublicKey` - -###### value.tokenId - -> **value.tokenId**: `string` = `Field` - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### value - -[`TokenBridgeEntry`](TokenBridgeEntry.md) = `TokenBridgeEntry` - -#### Returns - -`object` - -##### index - -> **index**: `bigint` = `Field` - -##### value - -> **value**: `object` = `TokenBridgeEntry` - -###### value.address - -> **value.address**: `object` = `PublicKey` - -###### value.address.isOdd - -> **value.address.isOdd**: `boolean` - -###### value.address.x - -> **value.address.x**: `bigint` - -###### value.tokenId - -> **value.tokenId**: `bigint` = `Field` - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ index: Field, value: TokenBridgeEntry, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md b/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md deleted file mode 100644 index d3bbfad..0000000 --- a/src/pages/docs/reference/protocol/classes/TokenBridgeTreeWitness.md +++ /dev/null @@ -1,575 +0,0 @@ ---- -title: TokenBridgeTreeWitness ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenBridgeTreeWitness - -# Class: TokenBridgeTreeWitness - -Defined in: [packages/protocol/src/settlement/contracts/TokenBridgeTree.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/TokenBridgeTree.ts#L54) - -## Extends - -- [`WITNESS`](VKTree.md#witness) - -## Constructors - -### new TokenBridgeTreeWitness() - -> **new TokenBridgeTreeWitness**(`value`): [`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:4 - -#### Parameters - -##### value - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -[`TokenBridgeTreeWitness`](TokenBridgeTreeWitness.md) - -#### Inherited from - -`TokenBridgeTree.WITNESS.constructor` - -## Properties - -### isLeft - -> **isLeft**: `Bool`[] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:9 - -#### Inherited from - -`TokenBridgeTree.WITNESS.isLeft` - -*** - -### path - -> **path**: `Field`[] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:8 - -#### Inherited from - -`TokenBridgeTree.WITNESS.path` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:11 - -#### Inherited from - -`TokenBridgeTree.WITNESS._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`void` - -#### Inherited from - -`TokenBridgeTree.WITNESS.check` - -*** - -### dummy() - -> `static` **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:115 - -#### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -#### Inherited from - -`TokenBridgeTree.WITNESS.dummy` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:52 - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`TokenBridgeTree.WITNESS.empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:19 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`TokenBridgeTree.WITNESS.fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:45 - -#### Parameters - -##### x - -###### isLeft - -`boolean`[] - -###### path - -`string`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`TokenBridgeTree.WITNESS.fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`TokenBridgeTree.WITNESS.fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`TokenBridgeTree.WITNESS.toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`TokenBridgeTree.WITNESS.toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:31 - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`TokenBridgeTree.WITNESS.toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:38 - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `boolean`[] - -##### path - -> **path**: `string`[] - -#### Inherited from - -`TokenBridgeTree.WITNESS.toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `boolean`[] - -##### path - -> **path**: `bigint`[] - -#### Inherited from - -`TokenBridgeTree.WITNESS.toValue` - -## Methods - -### calculateIndex() - -> **calculateIndex**(): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:71 - -Calculates the index of the leaf node that belongs to this Witness. - -#### Returns - -`Field` - -Index of the leaf. - -#### Inherited from - -`TokenBridgeTree.WITNESS.calculateIndex` - -*** - -### calculateRoot() - -> **calculateRoot**(`hash`): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:66 - -Calculates a root depending on the leaf value. - -#### Parameters - -##### hash - -`Field` - -#### Returns - -`Field` - -The calculated root. - -#### Inherited from - -`TokenBridgeTree.WITNESS.calculateRoot` - -*** - -### checkMembership() - -> **checkMembership**(`root`, `key`, `value`): `Bool` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:72 - -#### Parameters - -##### root - -`Field` - -##### key - -`Field` - -##### value - -`Field` - -#### Returns - -`Bool` - -#### Inherited from - -`TokenBridgeTree.WITNESS.checkMembership` - -*** - -### checkMembershipGetRoots() - -> **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:73 - -#### Parameters - -##### root - -`Field` - -##### key - -`Field` - -##### value - -`Field` - -#### Returns - -\[`Bool`, `Field`, `Field`\] - -#### Inherited from - -`TokenBridgeTree.WITNESS.checkMembershipGetRoots` - -*** - -### height() - -> **height**(): `number` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:60 - -#### Returns - -`number` - -#### Inherited from - -`TokenBridgeTree.WITNESS.height` - -*** - -### toShortenedEntries() - -> **toShortenedEntries**(): `string`[] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:74 - -#### Returns - -`string`[] - -#### Inherited from - -`TokenBridgeTree.WITNESS.toShortenedEntries` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`TokenBridgeTree.WITNESS.sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TokenMapping.md b/src/pages/docs/reference/protocol/classes/TokenMapping.md deleted file mode 100644 index e9fa6fb..0000000 --- a/src/pages/docs/reference/protocol/classes/TokenMapping.md +++ /dev/null @@ -1,429 +0,0 @@ ---- -title: TokenMapping ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TokenMapping - -# Class: TokenMapping - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L60) - -## Extends - -- `object` - -## Constructors - -### new TokenMapping() - -> **new TokenMapping**(`value`): [`TokenMapping`](TokenMapping.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### publicKey - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -[`TokenMapping`](TokenMapping.md) - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).constructor` - -## Properties - -### publicKey - -> **publicKey**: `PublicKey` = `PublicKey` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L62) - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).publicKey` - -*** - -### tokenId - -> **tokenId**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L61) - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).tokenId` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### publicKey - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### publicKey - -> **publicKey**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### publicKey - -> **publicKey**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### publicKey - -`string` = `PublicKey` - -###### tokenId - -`string` = `Field` - -#### Returns - -`object` - -##### publicKey - -> **publicKey**: `PublicKey` = `PublicKey` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### publicKey - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### publicKey - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### publicKey - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### publicKey - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### publicKey - -> **publicKey**: `string` = `PublicKey` - -##### tokenId - -> **tokenId**: `string` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### publicKey - -`PublicKey` = `PublicKey` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### publicKey - -> **publicKey**: `object` = `PublicKey` - -###### publicKey.isOdd - -> **publicKey.isOdd**: `boolean` - -###### publicKey.x - -> **publicKey.x**: `bigint` - -##### tokenId - -> **tokenId**: `bigint` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ tokenId: Field, publicKey: PublicKey, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md b/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md deleted file mode 100644 index 5648b69..0000000 --- a/src/pages/docs/reference/protocol/classes/TransitionMethodExecutionResult.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: TransitionMethodExecutionResult ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TransitionMethodExecutionResult - -# Class: TransitionMethodExecutionResult - -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L3) - -## Constructors - -### new TransitionMethodExecutionResult() - -> **new TransitionMethodExecutionResult**(): [`TransitionMethodExecutionResult`](TransitionMethodExecutionResult.md) - -#### Returns - -[`TransitionMethodExecutionResult`](TransitionMethodExecutionResult.md) - -## Properties - -### stateTransitions - -> **stateTransitions**: [`StateTransition`](StateTransition.md)\<`any`\>[] = `[]` - -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L4) diff --git a/src/pages/docs/reference/protocol/classes/UInt64Option.md b/src/pages/docs/reference/protocol/classes/UInt64Option.md deleted file mode 100644 index 1014a56..0000000 --- a/src/pages/docs/reference/protocol/classes/UInt64Option.md +++ /dev/null @@ -1,479 +0,0 @@ ---- -title: UInt64Option ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / UInt64Option - -# Class: UInt64Option - -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L24) - -## Extends - -- `Generic`\<`UInt64`, `this`\> - -## Constructors - -### new UInt64Option() - -> **new UInt64Option**(`value`): [`UInt64Option`](UInt64Option.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### isSome - -`Bool` = `Bool` - -###### value - -`UInt64` = `valueType` - -#### Returns - -[`UInt64Option`](UInt64Option.md) - -#### Inherited from - -`genericOptionFactory(UInt64).constructor` - -## Properties - -### isSome - -> **isSome**: `Bool` = `Bool` - -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L5) - -#### Inherited from - -`genericOptionFactory(UInt64).isSome` - -*** - -### value - -> **value**: `UInt64` = `valueType` - -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L6) - -#### Inherited from - -`genericOptionFactory(UInt64).value` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`genericOptionFactory(UInt64)._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### isSome - -`Bool` = `Bool` - -###### value - -`UInt64` = `valueType` - -#### Returns - -`void` - -#### Inherited from - -`genericOptionFactory(UInt64).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### isSome - -> **isSome**: `Bool` = `Bool` - -##### value - -> **value**: `UInt64` = `valueType` - -#### Inherited from - -`genericOptionFactory(UInt64).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`, `aux`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:45 - -A function that returns an element of type `T` from the given provable and "auxiliary" data. - -This function is the reverse operation of calling [toFields](UInt64Option.md#tofields) and toAuxilary methods on an element of type `T`. - -#### Parameters - -##### fields - -`Field`[] - -an array of Field elements describing the provable data of the new `T` element. - -##### aux - -`any`[] - -an array of any type describing the "auxiliary" data of the new `T` element, optional. - -#### Returns - -`object` - -An element of type `T` generated from the given provable and "auxiliary" data. - -##### isSome - -> **isSome**: `Bool` = `Bool` - -##### value - -> **value**: `UInt64` = `valueType` - -#### Inherited from - -`genericOptionFactory(UInt64).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### isSome - -`boolean` = `Bool` - -###### value - -`any` = `valueType` - -#### Returns - -`object` - -##### isSome - -> **isSome**: `Bool` = `Bool` - -##### value - -> **value**: `UInt64` = `valueType` - -#### Inherited from - -`genericOptionFactory(UInt64).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`genericOptionFactory(UInt64).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### isSome - -`Bool` = `Bool` - -###### value - -`UInt64` = `valueType` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`genericOptionFactory(UInt64).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### isSome - -`Bool` = `Bool` - -###### value - -`UInt64` = `valueType` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`genericOptionFactory(UInt64).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### isSome - -`Bool` = `Bool` - -###### value - -`UInt64` = `valueType` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`genericOptionFactory(UInt64).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### isSome - -`Bool` = `Bool` - -###### value - -`UInt64` = `valueType` - -#### Returns - -`object` - -##### isSome - -> **isSome**: `boolean` = `Bool` - -##### value - -> **value**: `any` = `valueType` - -#### Inherited from - -`genericOptionFactory(UInt64).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### isSome - -`Bool` = `Bool` - -###### value - -`UInt64` = `valueType` - -#### Returns - -`object` - -##### isSome - -> **isSome**: `boolean` = `Bool` - -##### value - -> **value**: `any` = `valueType` - -#### Inherited from - -`genericOptionFactory(UInt64).toValue` - -## Methods - -### fromSome() - -> `static` **fromSome**(`value`): `Generic`\<`UInt64`\> - -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L8) - -#### Parameters - -##### value - -`UInt64` - -#### Returns - -`Generic`\<`UInt64`\> - -#### Inherited from - -`genericOptionFactory(UInt64).fromSome` - -*** - -### none() - -> `static` **none**(`value`): `Generic`\<`UInt64`\> - -Defined in: [packages/protocol/src/model/transaction/ValueOption.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/transaction/ValueOption.ts#L15) - -#### Parameters - -##### value - -`UInt64` - -#### Returns - -`Generic`\<`UInt64`\> - -#### Inherited from - -`genericOptionFactory(UInt64).none` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`genericOptionFactory(UInt64).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md b/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md deleted file mode 100644 index 3f96a26..0000000 --- a/src/pages/docs/reference/protocol/classes/UpdateMessagesHashAuth.md +++ /dev/null @@ -1,520 +0,0 @@ ---- -title: UpdateMessagesHashAuth ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / UpdateMessagesHashAuth - -# Class: UpdateMessagesHashAuth - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L5) - -Interface for cross-contract call authorization -See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 - -## Extends - -- `object` - -## Implements - -- [`ContractAuthorization`](../interfaces/ContractAuthorization.md) - -## Constructors - -### new UpdateMessagesHashAuth() - -> **new UpdateMessagesHashAuth**(`value`): [`UpdateMessagesHashAuth`](UpdateMessagesHashAuth.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### executedMessagesHash - -`Field` = `Field` - -###### newPromisedMessagesHash - -`Field` = `Field` - -###### target - -`PublicKey` = `PublicKey` - -#### Returns - -[`UpdateMessagesHashAuth`](UpdateMessagesHashAuth.md) - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).constructor` - -## Properties - -### executedMessagesHash - -> **executedMessagesHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L8) - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).executedMessagesHash` - -*** - -### newPromisedMessagesHash - -> **newPromisedMessagesHash**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L9) - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).newPromisedMessagesHash` - -*** - -### target - -> **target**: `PublicKey` = `PublicKey` - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L7) - -#### Implementation of - -[`ContractAuthorization`](../interfaces/ContractAuthorization.md).[`target`](../interfaces/ContractAuthorization.md#target) - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).target` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### executedMessagesHash - -`Field` = `Field` - -###### newPromisedMessagesHash - -`Field` = `Field` - -###### target - -`PublicKey` = `PublicKey` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### executedMessagesHash - -> **executedMessagesHash**: `Field` = `Field` - -##### newPromisedMessagesHash - -> **newPromisedMessagesHash**: `Field` = `Field` - -##### target - -> **target**: `PublicKey` = `PublicKey` - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### executedMessagesHash - -> **executedMessagesHash**: `Field` = `Field` - -##### newPromisedMessagesHash - -> **newPromisedMessagesHash**: `Field` = `Field` - -##### target - -> **target**: `PublicKey` = `PublicKey` - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### executedMessagesHash - -`string` = `Field` - -###### newPromisedMessagesHash - -`string` = `Field` - -###### target - -`string` = `PublicKey` - -#### Returns - -`object` - -##### executedMessagesHash - -> **executedMessagesHash**: `Field` = `Field` - -##### newPromisedMessagesHash - -> **newPromisedMessagesHash**: `Field` = `Field` - -##### target - -> **target**: `PublicKey` = `PublicKey` - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### executedMessagesHash - -`Field` = `Field` - -###### newPromisedMessagesHash - -`Field` = `Field` - -###### target - -`PublicKey` = `PublicKey` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### executedMessagesHash - -`Field` = `Field` - -###### newPromisedMessagesHash - -`Field` = `Field` - -###### target - -`PublicKey` = `PublicKey` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### executedMessagesHash - -`Field` = `Field` - -###### newPromisedMessagesHash - -`Field` = `Field` - -###### target - -`PublicKey` = `PublicKey` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### executedMessagesHash - -`Field` = `Field` - -###### newPromisedMessagesHash - -`Field` = `Field` - -###### target - -`PublicKey` = `PublicKey` - -#### Returns - -`object` - -##### executedMessagesHash - -> **executedMessagesHash**: `string` = `Field` - -##### newPromisedMessagesHash - -> **newPromisedMessagesHash**: `string` = `Field` - -##### target - -> **target**: `string` = `PublicKey` - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### executedMessagesHash - -`Field` = `Field` - -###### newPromisedMessagesHash - -`Field` = `Field` - -###### target - -`PublicKey` = `PublicKey` - -#### Returns - -`object` - -##### executedMessagesHash - -> **executedMessagesHash**: `bigint` = `Field` - -##### newPromisedMessagesHash - -> **newPromisedMessagesHash**: `bigint` = `Field` - -##### target - -> **target**: `object` = `PublicKey` - -###### target.isOdd - -> **target.isOdd**: `boolean` - -###### target.x - -> **target.x**: `bigint` - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).toValue` - -## Methods - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/UpdateMessagesHashAuth.ts#L13) - -#### Returns - -`Field` - -#### Implementation of - -[`ContractAuthorization`](../interfaces/ContractAuthorization.md).[`hash`](../interfaces/ContractAuthorization.md#hash) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ target: PublicKey, executedMessagesHash: Field, newPromisedMessagesHash: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/VKTree.md b/src/pages/docs/reference/protocol/classes/VKTree.md deleted file mode 100644 index e1fd47a..0000000 --- a/src/pages/docs/reference/protocol/classes/VKTree.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -title: VKTree ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / VKTree - -# Class: VKTree - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L5) - -## Extends - -- [`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md) - -## Constructors - -### new VKTree() - -> **new VKTree**(`store`): [`VKTree`](VKTree.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:113 - -#### Parameters - -##### store - -[`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) - -#### Returns - -[`VKTree`](VKTree.md) - -#### Inherited from - -`createMerkleTree(treeFeeHeight).constructor` - -## Properties - -### leafCount - -> `readonly` **leafCount**: `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:78 - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`leafCount`](../../common/interfaces/AbstractMerkleTree.md#leafcount) - -*** - -### store - -> **store**: [`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:77 - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`store`](../../common/interfaces/AbstractMerkleTree.md#store) - -*** - -### EMPTY\_ROOT - -> `static` **EMPTY\_ROOT**: `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:118 - -#### Inherited from - -`createMerkleTree(treeFeeHeight).EMPTY_ROOT` - -*** - -### HEIGHT - -> `static` **HEIGHT**: `number` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:117 - -#### Inherited from - -`createMerkleTree(treeFeeHeight).HEIGHT` - -*** - -### WITNESS - -> `static` **WITNESS**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md)\> & *typeof* `StructTemplate` & `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:114 - -#### Type declaration - -##### dummy() - -> **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -###### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -#### Inherited from - -`createMerkleTree(treeFeeHeight).WITNESS` - -## Accessors - -### leafCount - -#### Get Signature - -> **get** `static` **leafCount**(): `bigint` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:119 - -##### Returns - -`bigint` - -#### Inherited from - -`createMerkleTree(treeFeeHeight).leafCount` - -## Methods - -### assertIndexRange() - -> **assertIndexRange**(`index`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:79 - -#### Parameters - -##### index - -`bigint` - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`assertIndexRange`](../../common/interfaces/AbstractMerkleTree.md#assertindexrange) - -*** - -### fill() - -> **fill**(`leaves`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:110 - -Fills all leaves of the tree. - -#### Parameters - -##### leaves - -`Field`[] - -Values to fill the leaves with. - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`fill`](../../common/interfaces/AbstractMerkleTree.md#fill) - -*** - -### getNode() - -> **getNode**(`level`, `index`): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:86 - -Returns a node which lives at a given index and level. - -#### Parameters - -##### level - -`number` - -Level of the node. - -##### index - -`bigint` - -Index of the node. - -#### Returns - -`Field` - -The data of the node. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getNode`](../../common/interfaces/AbstractMerkleTree.md#getnode) - -*** - -### getRoot() - -> **getRoot**(): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:91 - -Returns the root of the [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree). - -#### Returns - -`Field` - -The root of the Merkle Tree. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getRoot`](../../common/interfaces/AbstractMerkleTree.md#getroot) - -*** - -### getWitness() - -> **getWitness**(`index`): [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:105 - -Returns the witness (also known as -[Merkle Proof or Merkle Witness](https://computersciencewiki.org/index.php/Merkle_proof)) -for the leaf at the given index. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -#### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -The witness that belongs to the leaf. - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`getWitness`](../../common/interfaces/AbstractMerkleTree.md#getwitness) - -*** - -### setLeaf() - -> **setLeaf**(`index`, `leaf`): `void` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:97 - -Sets the value of a leaf node at a given index to a given value. - -#### Parameters - -##### index - -`bigint` - -Position of the leaf node. - -##### leaf - -`Field` - -New value. - -#### Returns - -`void` - -#### Inherited from - -[`AbstractMerkleTree`](../../common/interfaces/AbstractMerkleTree.md).[`setLeaf`](../../common/interfaces/AbstractMerkleTree.md#setleaf) diff --git a/src/pages/docs/reference/protocol/classes/VKTreeWitness.md b/src/pages/docs/reference/protocol/classes/VKTreeWitness.md deleted file mode 100644 index ac29e6d..0000000 --- a/src/pages/docs/reference/protocol/classes/VKTreeWitness.md +++ /dev/null @@ -1,575 +0,0 @@ ---- -title: VKTreeWitness ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / VKTreeWitness - -# Class: VKTreeWitness - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L6) - -## Extends - -- [`WITNESS`](VKTree.md#witness) - -## Constructors - -### new VKTreeWitness() - -> **new VKTreeWitness**(`value`): [`VKTreeWitness`](VKTreeWitness.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:4 - -#### Parameters - -##### value - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -[`VKTreeWitness`](VKTreeWitness.md) - -#### Inherited from - -`VKTree.WITNESS.constructor` - -## Properties - -### isLeft - -> **isLeft**: `Bool`[] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:9 - -#### Inherited from - -`VKTree.WITNESS.isLeft` - -*** - -### path - -> **path**: `Field`[] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:8 - -#### Inherited from - -`VKTree.WITNESS.path` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:11 - -#### Inherited from - -`VKTree.WITNESS._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`void` - -#### Inherited from - -`VKTree.WITNESS.check` - -*** - -### dummy() - -> `static` **dummy**: () => [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:115 - -#### Returns - -[`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -#### Inherited from - -`VKTree.WITNESS.dummy` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:52 - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`VKTree.WITNESS.empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:19 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`VKTree.WITNESS.fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:45 - -#### Parameters - -##### x - -###### isLeft - -`boolean`[] - -###### path - -`string`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `Bool`[] - -##### path - -> **path**: `Field`[] - -#### Inherited from - -`VKTree.WITNESS.fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`VKTree.WITNESS.fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`VKTree.WITNESS.toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`VKTree.WITNESS.toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:31 - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`VKTree.WITNESS.toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:38 - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `boolean`[] - -##### path - -> **path**: `string`[] - -#### Inherited from - -`VKTree.WITNESS.toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### isLeft - -`Bool`[] - -###### path - -`Field`[] - -#### Returns - -`object` - -##### isLeft - -> **isLeft**: `boolean`[] - -##### path - -> **path**: `bigint`[] - -#### Inherited from - -`VKTree.WITNESS.toValue` - -## Methods - -### calculateIndex() - -> **calculateIndex**(): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:71 - -Calculates the index of the leaf node that belongs to this Witness. - -#### Returns - -`Field` - -Index of the leaf. - -#### Inherited from - -`VKTree.WITNESS.calculateIndex` - -*** - -### calculateRoot() - -> **calculateRoot**(`hash`): `Field` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:66 - -Calculates a root depending on the leaf value. - -#### Parameters - -##### hash - -`Field` - -#### Returns - -`Field` - -The calculated root. - -#### Inherited from - -`VKTree.WITNESS.calculateRoot` - -*** - -### checkMembership() - -> **checkMembership**(`root`, `key`, `value`): `Bool` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:72 - -#### Parameters - -##### root - -`Field` - -##### key - -`Field` - -##### value - -`Field` - -#### Returns - -`Bool` - -#### Inherited from - -`VKTree.WITNESS.checkMembership` - -*** - -### checkMembershipGetRoots() - -> **checkMembershipGetRoots**(`root`, `key`, `value`): \[`Bool`, `Field`, `Field`\] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:73 - -#### Parameters - -##### root - -`Field` - -##### key - -`Field` - -##### value - -`Field` - -#### Returns - -\[`Bool`, `Field`, `Field`\] - -#### Inherited from - -`VKTree.WITNESS.checkMembershipGetRoots` - -*** - -### height() - -> **height**(): `number` - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:60 - -#### Returns - -`number` - -#### Inherited from - -`VKTree.WITNESS.height` - -*** - -### toShortenedEntries() - -> **toShortenedEntries**(): `string`[] - -Defined in: packages/common/dist/trees/RollupMerkleTree.d.ts:74 - -#### Returns - -`string`[] - -#### Inherited from - -`VKTree.WITNESS.toShortenedEntries` - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`VKTree.WITNESS.sizeInFields` diff --git a/src/pages/docs/reference/protocol/classes/WithPath.md b/src/pages/docs/reference/protocol/classes/WithPath.md deleted file mode 100644 index 6ba374e..0000000 --- a/src/pages/docs/reference/protocol/classes/WithPath.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: WithPath ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / WithPath - -# Class: WithPath - -Defined in: [packages/protocol/src/state/State.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L13) - -## Constructors - -### new WithPath() - -> **new WithPath**(): [`WithPath`](WithPath.md) - -#### Returns - -[`WithPath`](WithPath.md) - -## Properties - -### path? - -> `optional` **path**: `Field` - -Defined in: [packages/protocol/src/state/State.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L14) - -## Methods - -### hasPathOrFail() - -> **hasPathOrFail**(): `asserts this is { path: Path }` - -Defined in: [packages/protocol/src/state/State.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L16) - -#### Returns - -`asserts this is { path: Path }` diff --git a/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md b/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md deleted file mode 100644 index 360f911..0000000 --- a/src/pages/docs/reference/protocol/classes/WithStateServiceProvider.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: WithStateServiceProvider ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / WithStateServiceProvider - -# Class: WithStateServiceProvider - -Defined in: [packages/protocol/src/state/State.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L25) - -## Constructors - -### new WithStateServiceProvider() - -> **new WithStateServiceProvider**(): [`WithStateServiceProvider`](WithStateServiceProvider.md) - -#### Returns - -[`WithStateServiceProvider`](WithStateServiceProvider.md) - -## Properties - -### stateServiceProvider? - -> `optional` **stateServiceProvider**: [`StateServiceProvider`](StateServiceProvider.md) - -Defined in: [packages/protocol/src/state/State.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L26) - -## Methods - -### hasStateServiceOrFail() - -> **hasStateServiceOrFail**(): `asserts this is { stateServiceProvider: StateServiceProvider }` - -Defined in: [packages/protocol/src/state/State.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/State.ts#L28) - -#### Returns - -`asserts this is { stateServiceProvider: StateServiceProvider }` diff --git a/src/pages/docs/reference/protocol/classes/Withdrawal.md b/src/pages/docs/reference/protocol/classes/Withdrawal.md deleted file mode 100644 index 3d480b5..0000000 --- a/src/pages/docs/reference/protocol/classes/Withdrawal.md +++ /dev/null @@ -1,505 +0,0 @@ ---- -title: Withdrawal ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Withdrawal - -# Class: Withdrawal - -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Withdrawal.ts#L4) - -## Extends - -- `object` - -## Constructors - -### new Withdrawal() - -> **new Withdrawal**(`value`): [`Withdrawal`](Withdrawal.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -[`Withdrawal`](Withdrawal.md) - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).constructor` - -## Properties - -### address - -> **address**: `PublicKey` = `PublicKey` - -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Withdrawal.ts#L6) - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).address` - -*** - -### amount - -> **amount**: `UInt64` = `UInt64` - -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Withdrawal.ts#L7) - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).amount` - -*** - -### tokenId - -> **tokenId**: `Field` = `Field` - -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Withdrawal.ts#L5) - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).tokenId` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### amount - -> **amount**: `UInt64` = `UInt64` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### amount - -> **amount**: `UInt64` = `UInt64` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### address - -`string` = `PublicKey` - -###### amount - -`string` = `UInt64` - -###### tokenId - -`string` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `PublicKey` = `PublicKey` - -##### amount - -> **amount**: `UInt64` = `UInt64` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `string` = `PublicKey` - -##### amount - -> **amount**: `string` = `UInt64` - -##### tokenId - -> **tokenId**: `string` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### address - -`PublicKey` = `PublicKey` - -###### amount - -`UInt64` = `UInt64` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### address - -> **address**: `object` = `PublicKey` - -###### address.isOdd - -> **address.isOdd**: `boolean` - -###### address.x - -> **address.x**: `bigint` - -##### amount - -> **amount**: `bigint` = `UInt64` - -##### tokenId - -> **tokenId**: `bigint` = `Field` - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).toValue` - -## Methods - -### dummy() - -> `static` **dummy**(): [`Withdrawal`](Withdrawal.md) - -Defined in: [packages/protocol/src/settlement/messages/Withdrawal.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/Withdrawal.ts#L9) - -#### Returns - -[`Withdrawal`](Withdrawal.md) - -*** - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ tokenId: Field, address: PublicKey, amount: UInt64, }).sizeInFields` diff --git a/src/pages/docs/reference/protocol/functions/assert.md b/src/pages/docs/reference/protocol/functions/assert.md deleted file mode 100644 index 1c5128e..0000000 --- a/src/pages/docs/reference/protocol/functions/assert.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: assert ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / assert - -# Function: assert() - -> **assert**(`condition`, `message`?): `void` - -Defined in: [packages/protocol/src/state/assert/assert.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/assert/assert.ts#L16) - -Maintains an execution status of the current runtime module method, -while prioritizing one-time failures. The assertion won't change the -execution status if it has previously failed at least once within the -same method execution context. - -## Parameters - -### condition - -`Bool` - -Result of the assertion made about the execution status - -### message? - -Optional message describing the prior status - -`string` | () => `string` - -## Returns - -`void` diff --git a/src/pages/docs/reference/protocol/functions/emptyActions.md b/src/pages/docs/reference/protocol/functions/emptyActions.md deleted file mode 100644 index 80ccfd0..0000000 --- a/src/pages/docs/reference/protocol/functions/emptyActions.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: emptyActions ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / emptyActions - -# Function: emptyActions() - -> **emptyActions**(): `Field` - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L20) - -## Returns - -`Field` diff --git a/src/pages/docs/reference/protocol/functions/emptyEvents.md b/src/pages/docs/reference/protocol/functions/emptyEvents.md deleted file mode 100644 index f0055a9..0000000 --- a/src/pages/docs/reference/protocol/functions/emptyEvents.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: emptyEvents ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / emptyEvents - -# Function: emptyEvents() - -> **emptyEvents**(): `Field` - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L24) - -## Returns - -`Field` diff --git a/src/pages/docs/reference/protocol/functions/notInCircuit.md b/src/pages/docs/reference/protocol/functions/notInCircuit.md deleted file mode 100644 index 55b1e5f..0000000 --- a/src/pages/docs/reference/protocol/functions/notInCircuit.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: notInCircuit ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / notInCircuit - -# Function: notInCircuit() - -> **notInCircuit**(): `MethodDecorator` - -Defined in: [packages/protocol/src/utils/utils.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/utils.ts#L16) - -## Returns - -`MethodDecorator` diff --git a/src/pages/docs/reference/protocol/functions/protocolState.md b/src/pages/docs/reference/protocol/functions/protocolState.md deleted file mode 100644 index ec2a360..0000000 --- a/src/pages/docs/reference/protocol/functions/protocolState.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: protocolState ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / protocolState - -# Function: protocolState() - -> **protocolState**(): \<`TargetTransitioningModule`\>(`target`, `propertyKey`) => `void` - -Defined in: [packages/protocol/src/state/protocol/ProtocolState.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/protocol/ProtocolState.ts#L23) - -Decorates a runtime module property as state, passing down some -underlying values to improve developer experience. - -## Returns - -`Function` - -### Type Parameters - -• **TargetTransitioningModule** *extends* `TransitioningProtocolModule`\<`unknown`\> - -### Parameters - -#### target - -`TargetTransitioningModule` - -#### propertyKey - -`string` - -### Returns - -`void` diff --git a/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md b/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md deleted file mode 100644 index 5066c32..0000000 --- a/src/pages/docs/reference/protocol/functions/reduceStateTransitions.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: reduceStateTransitions ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / reduceStateTransitions - -# Function: reduceStateTransitions() - -> **reduceStateTransitions**(`transitions`): [`StateTransition`](../classes/StateTransition.md)\<`unknown`\>[] - -Defined in: [packages/protocol/src/utils/StateTransitionReductionList.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/StateTransitionReductionList.ts#L61) - -## Parameters - -### transitions - -[`StateTransition`](../classes/StateTransition.md)\<`unknown`\>[] - -## Returns - -[`StateTransition`](../classes/StateTransition.md)\<`unknown`\>[] diff --git a/src/pages/docs/reference/protocol/functions/singleFieldToString.md b/src/pages/docs/reference/protocol/functions/singleFieldToString.md deleted file mode 100644 index 658dd59..0000000 --- a/src/pages/docs/reference/protocol/functions/singleFieldToString.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: singleFieldToString ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / singleFieldToString - -# Function: singleFieldToString() - -> **singleFieldToString**(`value`): `string` - -Defined in: [packages/protocol/src/utils/utils.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/utils.ts#L69) - -## Parameters - -### value - -`bigint` | `Field` - -## Returns - -`string` diff --git a/src/pages/docs/reference/protocol/functions/stringToField.md b/src/pages/docs/reference/protocol/functions/stringToField.md deleted file mode 100644 index 65da906..0000000 --- a/src/pages/docs/reference/protocol/functions/stringToField.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: stringToField ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / stringToField - -# Function: stringToField() - -> **stringToField**(`value`): `Field` - -Defined in: [packages/protocol/src/utils/utils.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/utils.ts#L36) - -## Parameters - -### value - -`string` - -## Returns - -`Field` diff --git a/src/pages/docs/reference/protocol/globals.md b/src/pages/docs/reference/protocol/globals.md deleted file mode 100644 index 6520805..0000000 --- a/src/pages/docs/reference/protocol/globals.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -title: "@proto-kit/protocol" ---- - -[**@proto-kit/protocol**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/protocol - -# @proto-kit/protocol - -## Classes - -- [AccountState](classes/AccountState.md) -- [AccountStateHook](classes/AccountStateHook.md) -- [BlockHashMerkleTree](classes/BlockHashMerkleTree.md) -- [BlockHashMerkleTreeWitness](classes/BlockHashMerkleTreeWitness.md) -- [BlockHashTreeEntry](classes/BlockHashTreeEntry.md) -- [BlockHeightHook](classes/BlockHeightHook.md) -- [BlockProver](classes/BlockProver.md) -- [BlockProverExecutionData](classes/BlockProverExecutionData.md) -- [BlockProverProgrammable](classes/BlockProverProgrammable.md) -- [BlockProverPublicInput](classes/BlockProverPublicInput.md) -- [BlockProverPublicOutput](classes/BlockProverPublicOutput.md) -- [BridgeContract](classes/BridgeContract.md) -- [BridgeContractBase](classes/BridgeContractBase.md) -- [BridgeContractProtocolModule](classes/BridgeContractProtocolModule.md) -- [ContractModule](classes/ContractModule.md) -- [CurrentBlock](classes/CurrentBlock.md) -- [DefaultProvableHashList](classes/DefaultProvableHashList.md) -- [Deposit](classes/Deposit.md) -- [DispatchContractProtocolModule](classes/DispatchContractProtocolModule.md) -- [DispatchSmartContract](classes/DispatchSmartContract.md) -- [DispatchSmartContractBase](classes/DispatchSmartContractBase.md) -- [DynamicBlockProof](classes/DynamicBlockProof.md) -- [DynamicRuntimeProof](classes/DynamicRuntimeProof.md) -- [LastStateRootBlockHook](classes/LastStateRootBlockHook.md) -- [MethodPublicOutput](classes/MethodPublicOutput.md) -- [MethodVKConfigData](classes/MethodVKConfigData.md) -- [MinaActions](classes/MinaActions.md) -- [MinaActionsHashList](classes/MinaActionsHashList.md) -- [MinaEvents](classes/MinaEvents.md) -- [MinaPrefixedProvableHashList](classes/MinaPrefixedProvableHashList.md) -- [NetworkState](classes/NetworkState.md) -- [NetworkStateSettlementModule](classes/NetworkStateSettlementModule.md) -- [Option](classes/Option.md) -- [OptionBase](classes/OptionBase.md) -- [OutgoingMessageArgument](classes/OutgoingMessageArgument.md) -- [OutgoingMessageArgumentBatch](classes/OutgoingMessageArgumentBatch.md) -- [OutgoingMessageKey](classes/OutgoingMessageKey.md) -- [Path](classes/Path.md) -- [PrefixedProvableHashList](classes/PrefixedProvableHashList.md) -- [PreviousBlock](classes/PreviousBlock.md) -- [Protocol](classes/Protocol.md) -- [ProtocolModule](classes/ProtocolModule.md) -- [ProvableBlockHook](classes/ProvableBlockHook.md) -- [ProvableHashList](classes/ProvableHashList.md) -- [ProvableOption](classes/ProvableOption.md) -- [ProvableReductionHashList](classes/ProvableReductionHashList.md) -- [ProvableSettlementHook](classes/ProvableSettlementHook.md) -- [ProvableStateTransition](classes/ProvableStateTransition.md) -- [ProvableStateTransitionType](classes/ProvableStateTransitionType.md) -- [ProvableTransactionHook](classes/ProvableTransactionHook.md) -- [PublicKeyOption](classes/PublicKeyOption.md) -- [RuntimeMethodExecutionContext](classes/RuntimeMethodExecutionContext.md) -- [RuntimeMethodExecutionDataStruct](classes/RuntimeMethodExecutionDataStruct.md) -- [RuntimeProvableMethodExecutionResult](classes/RuntimeProvableMethodExecutionResult.md) -- [RuntimeTransaction](classes/RuntimeTransaction.md) -- [RuntimeVerificationKeyAttestation](classes/RuntimeVerificationKeyAttestation.md) -- [RuntimeVerificationKeyRootService](classes/RuntimeVerificationKeyRootService.md) -- [SettlementContractModule](classes/SettlementContractModule.md) -- [SettlementContractProtocolModule](classes/SettlementContractProtocolModule.md) -- [SettlementSmartContract](classes/SettlementSmartContract.md) -- [SettlementSmartContractBase](classes/SettlementSmartContractBase.md) -- [SignedTransaction](classes/SignedTransaction.md) -- [State](classes/State.md) -- [StateMap](classes/StateMap.md) -- [StateServiceProvider](classes/StateServiceProvider.md) -- [StateTransition](classes/StateTransition.md) -- [StateTransitionProvableBatch](classes/StateTransitionProvableBatch.md) -- [StateTransitionProver](classes/StateTransitionProver.md) -- [StateTransitionProverProgrammable](classes/StateTransitionProverProgrammable.md) -- [StateTransitionProverPublicInput](classes/StateTransitionProverPublicInput.md) -- [StateTransitionProverPublicOutput](classes/StateTransitionProverPublicOutput.md) -- [StateTransitionReductionList](classes/StateTransitionReductionList.md) -- [StateTransitionType](classes/StateTransitionType.md) -- [TokenBridgeAttestation](classes/TokenBridgeAttestation.md) -- [TokenBridgeDeploymentAuth](classes/TokenBridgeDeploymentAuth.md) -- [TokenBridgeEntry](classes/TokenBridgeEntry.md) -- [TokenBridgeTree](classes/TokenBridgeTree.md) -- [TokenBridgeTreeAddition](classes/TokenBridgeTreeAddition.md) -- [TokenBridgeTreeWitness](classes/TokenBridgeTreeWitness.md) -- [TokenMapping](classes/TokenMapping.md) -- [TransitionMethodExecutionResult](classes/TransitionMethodExecutionResult.md) -- [UInt64Option](classes/UInt64Option.md) -- [UpdateMessagesHashAuth](classes/UpdateMessagesHashAuth.md) -- [VKTree](classes/VKTree.md) -- [VKTreeWitness](classes/VKTreeWitness.md) -- [Withdrawal](classes/Withdrawal.md) -- [WithPath](classes/WithPath.md) -- [WithStateServiceProvider](classes/WithStateServiceProvider.md) - -## Interfaces - -- [BlockProvable](interfaces/BlockProvable.md) -- [BlockProverState](interfaces/BlockProverState.md) -- [BlockProverType](interfaces/BlockProverType.md) -- [ContractAuthorization](interfaces/ContractAuthorization.md) -- [DispatchContractType](interfaces/DispatchContractType.md) -- [MinimalVKTreeService](interfaces/MinimalVKTreeService.md) -- [ProtocolDefinition](interfaces/ProtocolDefinition.md) -- [ProtocolEnvironment](interfaces/ProtocolEnvironment.md) -- [RuntimeLike](interfaces/RuntimeLike.md) -- [RuntimeMethodExecutionData](interfaces/RuntimeMethodExecutionData.md) -- [SettlementContractType](interfaces/SettlementContractType.md) -- [SimpleAsyncStateService](interfaces/SimpleAsyncStateService.md) -- [StateTransitionProvable](interfaces/StateTransitionProvable.md) -- [StateTransitionProverType](interfaces/StateTransitionProverType.md) -- [TransitionMethodExecutionContext](interfaces/TransitionMethodExecutionContext.md) - -## Type Aliases - -- [BlockProof](type-aliases/BlockProof.md) -- [BlockProverProof](type-aliases/BlockProverProof.md) -- [BridgeContractConfig](type-aliases/BridgeContractConfig.md) -- [BridgeContractType](type-aliases/BridgeContractType.md) -- [DispatchContractConfig](type-aliases/DispatchContractConfig.md) -- [InputBlockProof](type-aliases/InputBlockProof.md) -- [MandatoryProtocolModulesRecord](type-aliases/MandatoryProtocolModulesRecord.md) -- [MandatorySettlementModulesRecord](type-aliases/MandatorySettlementModulesRecord.md) -- [ProtocolModulesRecord](type-aliases/ProtocolModulesRecord.md) -- [ReturnType](type-aliases/ReturnType.md) -- [RuntimeMethodIdMapping](type-aliases/RuntimeMethodIdMapping.md) -- [RuntimeMethodInvocationType](type-aliases/RuntimeMethodInvocationType.md) -- [RuntimeProof](type-aliases/RuntimeProof.md) -- [SettlementContractConfig](type-aliases/SettlementContractConfig.md) -- [SettlementHookInputs](type-aliases/SettlementHookInputs.md) -- [SettlementModulesRecord](type-aliases/SettlementModulesRecord.md) -- [SettlementStateRecord](type-aliases/SettlementStateRecord.md) -- [SmartContractClassFromInterface](type-aliases/SmartContractClassFromInterface.md) -- [StateTransitionProof](type-aliases/StateTransitionProof.md) -- [Subclass](type-aliases/Subclass.md) - -## Variables - -- [ACTIONS\_EMPTY\_HASH](variables/ACTIONS_EMPTY_HASH.md) -- [BATCH\_SIGNATURE\_PREFIX](variables/BATCH_SIGNATURE_PREFIX.md) -- [MINA\_EVENT\_PREFIXES](variables/MINA_EVENT_PREFIXES.md) -- [OUTGOING\_MESSAGE\_BATCH\_SIZE](variables/OUTGOING_MESSAGE_BATCH_SIZE.md) -- [ProtocolConstants](variables/ProtocolConstants.md) -- [treeFeeHeight](variables/treeFeeHeight.md) - -## Functions - -- [assert](functions/assert.md) -- [emptyActions](functions/emptyActions.md) -- [emptyEvents](functions/emptyEvents.md) -- [notInCircuit](functions/notInCircuit.md) -- [protocolState](functions/protocolState.md) -- [reduceStateTransitions](functions/reduceStateTransitions.md) -- [singleFieldToString](functions/singleFieldToString.md) -- [stringToField](functions/stringToField.md) diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProvable.md b/src/pages/docs/reference/protocol/interfaces/BlockProvable.md deleted file mode 100644 index ea50578..0000000 --- a/src/pages/docs/reference/protocol/interfaces/BlockProvable.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: BlockProvable ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProvable - -# Interface: BlockProvable - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L75) - -## Extends - -- [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\>.[`CompilableModule`](../../common/interfaces/CompilableModule.md) - -## Extended by - -- [`BlockProverType`](BlockProverType.md) - -## Properties - -### merge() - -> **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L94) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) - -##### proof1 - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -##### proof2 - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -*** - -### proveBlock() - -> **proveBlock**: (`publicInput`, `networkState`, `blockWitness`, `transactionProof`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L86) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) - -##### networkState - -[`NetworkState`](../classes/NetworkState.md) - -##### blockWitness - -[`BlockHashMerkleTreeWitness`](../classes/BlockHashMerkleTreeWitness.md) - -##### transactionProof - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -*** - -### proveTransaction() - -> **proveTransaction**: (`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L78) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) - -##### stateProof - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -##### appProof - -[`DynamicRuntimeProof`](../classes/DynamicRuntimeProof.md) - -##### executionData - -[`BlockProverExecutionData`](../classes/BlockProverExecutionData.md) - -##### verificationKeyAttestation - -[`RuntimeVerificationKeyAttestation`](../classes/RuntimeVerificationKeyAttestation.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -*** - -### zkProgrammable - -> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 - -#### Inherited from - -[`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md).[`zkProgrammable`](../../common/interfaces/WithZkProgrammable.md#zkprogrammable) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -#### Inherited from - -[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProverState.md b/src/pages/docs/reference/protocol/interfaces/BlockProverState.md deleted file mode 100644 index c502d5d..0000000 --- a/src/pages/docs/reference/protocol/interfaces/BlockProverState.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: BlockProverState ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverState - -# Interface: BlockProverState - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:98](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L98) - -## Properties - -### blockHashRoot - -> **blockHashRoot**: `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:120](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L120) - -The root of the merkle tree encoding all block hashes, -see `BlockHashMerkleTree` - -*** - -### eternalTransactionsHash - -> **eternalTransactionsHash**: `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:127](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L127) - -A variant of the transactionsHash that is never reset. -Thought for usage in the sequence state mempool. -In comparison, transactionsHash restarts at 0 for every new block - -*** - -### incomingMessagesHash - -> **incomingMessagesHash**: `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L129) - -*** - -### networkStateHash - -> **networkStateHash**: `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L114) - -The network state which gives access to values such as blockHeight -This value is the same for the whole batch (L2 block) - -*** - -### stateRoot - -> **stateRoot**: `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L102) - -The current state root of the block prover - -*** - -### transactionsHash - -> **transactionsHash**: `Field` - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L108) - -The current commitment of the transaction-list which -will at the end equal the bundle hash diff --git a/src/pages/docs/reference/protocol/interfaces/BlockProverType.md b/src/pages/docs/reference/protocol/interfaces/BlockProverType.md deleted file mode 100644 index c777716..0000000 --- a/src/pages/docs/reference/protocol/interfaces/BlockProverType.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -title: BlockProverType ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverType - -# Interface: BlockProverType - -Defined in: [packages/protocol/src/protocol/Protocol.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L47) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ProtocolModule`](../classes/ProtocolModule.md).[`BlockProvable`](BlockProvable.md) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`currentConfig`](../classes/ProtocolModule.md#currentconfig) - -*** - -### merge() - -> **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L94) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) - -##### proof1 - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -##### proof2 - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -#### Inherited from - -[`BlockProvable`](BlockProvable.md).[`merge`](BlockProvable.md#merge) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`protocol`](../classes/ProtocolModule.md#protocol) - -*** - -### proveBlock() - -> **proveBlock**: (`publicInput`, `networkState`, `blockWitness`, `transactionProof`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L86) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) - -##### networkState - -[`NetworkState`](../classes/NetworkState.md) - -##### blockWitness - -[`BlockHashMerkleTreeWitness`](../classes/BlockHashMerkleTreeWitness.md) - -##### transactionProof - -[`BlockProverProof`](../type-aliases/BlockProverProof.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -#### Inherited from - -[`BlockProvable`](BlockProvable.md).[`proveBlock`](BlockProvable.md#proveblock) - -*** - -### proveTransaction() - -> **proveTransaction**: (`publicInput`, `stateProof`, `appProof`, `executionData`, `verificationKeyAttestation`) => `Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L78) - -#### Parameters - -##### publicInput - -[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md) - -##### stateProof - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -##### appProof - -[`DynamicRuntimeProof`](../classes/DynamicRuntimeProof.md) - -##### executionData - -[`BlockProverExecutionData`](../classes/BlockProverExecutionData.md) - -##### verificationKeyAttestation - -[`RuntimeVerificationKeyAttestation`](../classes/RuntimeVerificationKeyAttestation.md) - -#### Returns - -`Promise`\<[`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -#### Inherited from - -[`BlockProvable`](BlockProvable.md).[`proveTransaction`](BlockProvable.md#provetransaction) - -*** - -### zkProgrammable - -> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 - -#### Inherited from - -[`BlockProvable`](BlockProvable.md).[`zkProgrammable`](BlockProvable.md#zkprogrammable) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`areProofsEnabled`](../classes/ProtocolModule.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`config`](../classes/ProtocolModule.md#config) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -#### Inherited from - -[`BlockProvable`](BlockProvable.md).[`compile`](BlockProvable.md#compile) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`create`](../classes/ProtocolModule.md#create) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`start`](../classes/ProtocolModule.md#start) diff --git a/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md b/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md deleted file mode 100644 index 5570de3..0000000 --- a/src/pages/docs/reference/protocol/interfaces/ContractAuthorization.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ContractAuthorization ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ContractAuthorization - -# Interface: ContractAuthorization - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L7) - -Interface for cross-contract call authorization -See https://github.com/proto-kit/framework/issues/202#issuecomment-2407263173 - -## Properties - -### hash() - -> **hash**: () => `Field` - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L10) - -#### Returns - -`Field` - -*** - -### target - -> **target**: `PublicKey` - -Defined in: [packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/authorizations/ContractAuthorization.ts#L8) diff --git a/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md b/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md deleted file mode 100644 index abaa90a..0000000 --- a/src/pages/docs/reference/protocol/interfaces/DispatchContractType.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: DispatchContractType ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DispatchContractType - -# Interface: DispatchContractType - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L40) - -## Properties - -### enableTokenDeposits() - -> **enableTokenDeposits**: (`tokenId`, `bridgeContractAddress`, `settlementContractAddress`) => `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L46) - -#### Parameters - -##### tokenId - -`Field` - -##### bridgeContractAddress - -`PublicKey` - -##### settlementContractAddress - -`PublicKey` - -#### Returns - -`Promise`\<`void`\> - -*** - -### initialize() - -> **initialize**: (`settlementContract`) => `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L45) - -#### Parameters - -##### settlementContract - -`PublicKey` - -#### Returns - -`Promise`\<`void`\> - -*** - -### promisedMessagesHash - -> **promisedMessagesHash**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L52) - -*** - -### updateMessagesHash() - -> **updateMessagesHash**: (`executedMessagesHash`, `newPromisedMessagesHash`) => `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L41) - -#### Parameters - -##### executedMessagesHash - -`Field` - -##### newPromisedMessagesHash - -`Field` - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md b/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md deleted file mode 100644 index 36e8b56..0000000 --- a/src/pages/docs/reference/protocol/interfaces/MinimalVKTreeService.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: MinimalVKTreeService ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MinimalVKTreeService - -# Interface: MinimalVKTreeService - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L22) - -## Properties - -### getRoot() - -> **getRoot**: () => `bigint` - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L23) - -#### Returns - -`bigint` diff --git a/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md b/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md deleted file mode 100644 index 19352d0..0000000 --- a/src/pages/docs/reference/protocol/interfaces/ProtocolDefinition.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: ProtocolDefinition ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProtocolDefinition - -# Interface: ProtocolDefinition\ - -Defined in: [packages/protocol/src/protocol/Protocol.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L61) - -## Type Parameters - -• **Modules** *extends* [`ProtocolModulesRecord`](../type-aliases/ProtocolModulesRecord.md) - -## Properties - -### config? - -> `optional` **config**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: [packages/protocol/src/protocol/Protocol.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L63) - -*** - -### modules - -> **modules**: `Modules` - -Defined in: [packages/protocol/src/protocol/Protocol.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L62) diff --git a/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md b/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md deleted file mode 100644 index 61b8295..0000000 --- a/src/pages/docs/reference/protocol/interfaces/ProtocolEnvironment.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ProtocolEnvironment ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProtocolEnvironment - -# Interface: ProtocolEnvironment - -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolEnvironment.ts#L6) - -## Accessors - -### stateService - -#### Get Signature - -> **get** **stateService**(): [`SimpleAsyncStateService`](SimpleAsyncStateService.md) - -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolEnvironment.ts#L7) - -##### Returns - -[`SimpleAsyncStateService`](SimpleAsyncStateService.md) - -*** - -### stateServiceProvider - -#### Get Signature - -> **get** **stateServiceProvider**(): [`StateServiceProvider`](../classes/StateServiceProvider.md) - -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolEnvironment.ts#L8) - -##### Returns - -[`StateServiceProvider`](../classes/StateServiceProvider.md) - -## Methods - -### getAreProofsEnabled() - -> **getAreProofsEnabled**(): [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolEnvironment.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolEnvironment.ts#L9) - -#### Returns - -[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) diff --git a/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md b/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md deleted file mode 100644 index f63a18e..0000000 --- a/src/pages/docs/reference/protocol/interfaces/RuntimeLike.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: RuntimeLike ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeLike - -# Interface: RuntimeLike - -Defined in: [packages/protocol/src/model/RuntimeLike.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/RuntimeLike.ts#L8) - -## Accessors - -### methodIdResolver - -#### Get Signature - -> **get** **methodIdResolver**(): `object` - -Defined in: [packages/protocol/src/model/RuntimeLike.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/RuntimeLike.ts#L9) - -##### Returns - -`object` - -###### methodIdMap() - -> **methodIdMap**: () => [`RuntimeMethodIdMapping`](../type-aliases/RuntimeMethodIdMapping.md) - -###### Returns - -[`RuntimeMethodIdMapping`](../type-aliases/RuntimeMethodIdMapping.md) diff --git a/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md b/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md deleted file mode 100644 index 014037a..0000000 --- a/src/pages/docs/reference/protocol/interfaces/RuntimeMethodExecutionData.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: RuntimeMethodExecutionData ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeMethodExecutionData - -# Interface: RuntimeMethodExecutionData - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L36) - -## Properties - -### networkState - -> **networkState**: [`NetworkState`](../classes/NetworkState.md) - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L38) - -*** - -### transaction - -> **transaction**: [`RuntimeTransaction`](../classes/RuntimeTransaction.md) - -Defined in: [packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/RuntimeMethodExecutionContext.ts#L37) diff --git a/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md b/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md deleted file mode 100644 index 4f85ba5..0000000 --- a/src/pages/docs/reference/protocol/interfaces/SettlementContractType.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: SettlementContractType ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementContractType - -# Interface: SettlementContractType - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L65) - -## Properties - -### addTokenBridge() - -> **addTokenBridge**: (`tokenId`, `address`, `dispatchContract`) => `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L84) - -#### Parameters - -##### tokenId - -`Field` - -##### address - -`PublicKey` - -##### dispatchContract - -`PublicKey` - -#### Returns - -`Promise`\<`void`\> - -*** - -### assertStateRoot() - -> **assertStateRoot**: (`root`) => `AccountUpdate` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L74) - -#### Parameters - -##### root - -`Field` - -#### Returns - -`AccountUpdate` - -*** - -### authorizationField - -> **authorizationField**: `State`\<`Field`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L66) - -*** - -### initialize() - -> **initialize**: (`sequencer`, `dispatchContract`, `bridgeContract`, `contractKey`) => `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L68) - -#### Parameters - -##### sequencer - -`PublicKey` - -##### dispatchContract - -`PublicKey` - -##### bridgeContract - -`PublicKey` - -##### contractKey - -`PrivateKey` - -#### Returns - -`Promise`\<`void`\> - -*** - -### settle() - -> **settle**: (`blockProof`, `signature`, `dispatchContractAddress`, `publicKey`, `inputNetworkState`, `outputNetworkState`, `newPromisedMessagesHash`) => `Promise`\<`void`\> - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L75) - -#### Parameters - -##### blockProof - -[`DynamicBlockProof`](../classes/DynamicBlockProof.md) - -##### signature - -`Signature` - -##### dispatchContractAddress - -`PublicKey` - -##### publicKey - -`PublicKey` - -##### inputNetworkState - -[`NetworkState`](../classes/NetworkState.md) - -##### outputNetworkState - -[`NetworkState`](../classes/NetworkState.md) - -##### newPromisedMessagesHash - -`Field` - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md b/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md deleted file mode 100644 index 53c003d..0000000 --- a/src/pages/docs/reference/protocol/interfaces/SimpleAsyncStateService.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: SimpleAsyncStateService ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SimpleAsyncStateService - -# Interface: SimpleAsyncStateService - -Defined in: [packages/protocol/src/state/StateService.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateService.ts#L3) - -## Properties - -### get() - -> **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> - -Defined in: [packages/protocol/src/state/StateService.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateService.ts#L4) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| `Field`[]\> - -*** - -### set() - -> **set**: (`key`, `value`) => `Promise`\<`void`\> - -Defined in: [packages/protocol/src/state/StateService.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/StateService.ts#L5) - -#### Parameters - -##### key - -`Field` - -##### value - -`undefined` | `Field`[] - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md b/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md deleted file mode 100644 index c352d47..0000000 --- a/src/pages/docs/reference/protocol/interfaces/StateTransitionProvable.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: StateTransitionProvable ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProvable - -# Interface: StateTransitionProvable - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L25) - -## Extends - -- [`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md)\<[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\>.[`CompilableModule`](../../common/interfaces/CompilableModule.md) - -## Extended by - -- [`StateTransitionProverType`](StateTransitionProverType.md) - -## Properties - -### merge() - -> **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) - -#### Parameters - -##### publicInput - -[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md) - -##### proof1 - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -##### proof2 - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -#### Returns - -`Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -*** - -### runBatch() - -> **runBatch**: (`publicInput`, `batch`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) - -#### Parameters - -##### publicInput - -[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md) - -##### batch - -[`StateTransitionProvableBatch`](../classes/StateTransitionProvableBatch.md) - -#### Returns - -`Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -*** - -### zkProgrammable - -> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 - -#### Inherited from - -[`WithZkProgrammable`](../../common/interfaces/WithZkProgrammable.md).[`zkProgrammable`](../../common/interfaces/WithZkProgrammable.md#zkprogrammable) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -#### Inherited from - -[`CompilableModule`](../../common/interfaces/CompilableModule.md).[`compile`](../../common/interfaces/CompilableModule.md#compile) diff --git a/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md b/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md deleted file mode 100644 index af2707f..0000000 --- a/src/pages/docs/reference/protocol/interfaces/StateTransitionProverType.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -title: StateTransitionProverType ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProverType - -# Interface: StateTransitionProverType - -Defined in: [packages/protocol/src/protocol/Protocol.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L49) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ProtocolModule`](../classes/ProtocolModule.md).[`StateTransitionProvable`](StateTransitionProvable.md) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`currentConfig`](../classes/ProtocolModule.md#currentconfig) - -*** - -### merge() - -> **merge**: (`publicInput`, `proof1`, `proof2`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L36) - -#### Parameters - -##### publicInput - -[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md) - -##### proof1 - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -##### proof2 - -[`StateTransitionProof`](../type-aliases/StateTransitionProof.md) - -#### Returns - -`Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -#### Inherited from - -[`StateTransitionProvable`](StateTransitionProvable.md).[`merge`](StateTransitionProvable.md#merge) - -*** - -### protocol? - -> `optional` **protocol**: [`ProtocolEnvironment`](ProtocolEnvironment.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L14) - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`protocol`](../classes/ProtocolModule.md#protocol) - -*** - -### runBatch() - -> **runBatch**: (`publicInput`, `batch`) => `Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L31) - -#### Parameters - -##### publicInput - -[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md) - -##### batch - -[`StateTransitionProvableBatch`](../classes/StateTransitionProvableBatch.md) - -#### Returns - -`Promise`\<[`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -#### Inherited from - -[`StateTransitionProvable`](StateTransitionProvable.md).[`runBatch`](StateTransitionProvable.md#runbatch) - -*** - -### zkProgrammable - -> **zkProgrammable**: [`ZkProgrammable`](../../common/classes/ZkProgrammable.md)\<[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -Defined in: packages/common/dist/zkProgrammable/ZkProgrammable.d.ts:38 - -#### Inherited from - -[`StateTransitionProvable`](StateTransitionProvable.md).[`zkProgrammable`](StateTransitionProvable.md#zkprogrammable) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L16) - -##### Returns - -`undefined` \| [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`areProofsEnabled`](../classes/ProtocolModule.md#areproofsenabled) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`config`](../classes/ProtocolModule.md#config) - -## Methods - -### compile() - -> **compile**(`registry`): `Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -Defined in: packages/common/dist/compiling/CompilableModule.d.ts:4 - -#### Parameters - -##### registry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -`Promise`\<`void` \| [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md)\> - -#### Inherited from - -[`StateTransitionProvable`](StateTransitionProvable.md).[`compile`](StateTransitionProvable.md#compile) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L20) - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`create`](../classes/ProtocolModule.md#create) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/protocol/src/protocol/ProtocolModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/ProtocolModule.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`ProtocolModule`](../classes/ProtocolModule.md).[`start`](../classes/ProtocolModule.md#start) diff --git a/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md b/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md deleted file mode 100644 index ed0c462..0000000 --- a/src/pages/docs/reference/protocol/interfaces/TransitionMethodExecutionContext.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: TransitionMethodExecutionContext ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / TransitionMethodExecutionContext - -# Interface: TransitionMethodExecutionContext - -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L7) - -## Properties - -### addStateTransition() - -> **addStateTransition**: \<`Value`\>(`stateTransition`) => `void` - -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L12) - -Adds an in-method generated state transition to the current context - -#### Type Parameters - -• **Value** - -#### Parameters - -##### stateTransition - -[`StateTransition`](../classes/StateTransition.md)\<`Value`\> - -State transition to add to the context - -#### Returns - -`void` - -*** - -### clear() - -> **clear**: () => `void` - -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L17) - -Manually clears/resets the execution context - -#### Returns - -`void` - -*** - -### current() - -> **current**: () => `object` - -Defined in: [packages/protocol/src/state/context/TransitionMethodExecutionContext.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/state/context/TransitionMethodExecutionContext.ts#L23) - -Had to override current() otherwise it would not infer -the type of result correctly (parent type would be reused) - -#### Returns - -`object` - -##### result - -> **result**: [`TransitionMethodExecutionResult`](../classes/TransitionMethodExecutionResult.md) diff --git a/src/pages/docs/reference/protocol/type-aliases/BlockProof.md b/src/pages/docs/reference/protocol/type-aliases/BlockProof.md deleted file mode 100644 index 41d2fb3..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/BlockProof.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: BlockProof ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProof - -# Type Alias: BlockProof - -> **BlockProof**: `Proof`\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L132) diff --git a/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md b/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md deleted file mode 100644 index 4786f7f..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/BlockProverProof.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: BlockProverProof ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BlockProverProof - -# Type Alias: BlockProverProof - -> **BlockProverProof**: `Proof`\<[`BlockProverPublicInput`](../classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../classes/BlockProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProvable.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProvable.ts#L52) diff --git a/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md deleted file mode 100644 index 5921da9..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/BridgeContractConfig.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: BridgeContractConfig ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BridgeContractConfig - -# Type Alias: BridgeContractConfig - -> **BridgeContractConfig**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts#L12) - -## Type declaration - -### withdrawalEventName - -> **withdrawalEventName**: `string` - -### withdrawalStatePath - -> **withdrawalStatePath**: `` `${string}.${string}` `` diff --git a/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md b/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md deleted file mode 100644 index f41445d..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/BridgeContractType.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: BridgeContractType ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BridgeContractType - -# Type Alias: BridgeContractType - -> **BridgeContractType**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/BridgeContract.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/BridgeContract.ts#L29) - -## Type declaration - -### deployProvable() - -> **deployProvable**: (`args`, `signedSettlement`, `permissions`, `settlementContractAddress`) => `Promise`\<`AccountUpdate`\> - -#### Parameters - -##### args - -`VerificationKey` | `undefined` - -##### signedSettlement - -`boolean` - -##### permissions - -`Permissions` - -##### settlementContractAddress - -`PublicKey` - -#### Returns - -`Promise`\<`AccountUpdate`\> - -### outgoingMessageCursor - -> **outgoingMessageCursor**: `State`\<`Field`\> - -### redeem() - -> **redeem**: (`additionUpdate`) => `Promise`\<`void`\> - -#### Parameters - -##### additionUpdate - -`AccountUpdate` - -#### Returns - -`Promise`\<`void`\> - -### rollupOutgoingMessages() - -> **rollupOutgoingMessages**: (`batch`) => `Promise`\<`Field`\> - -#### Parameters - -##### batch - -[`OutgoingMessageArgumentBatch`](../classes/OutgoingMessageArgumentBatch.md) - -#### Returns - -`Promise`\<`Field`\> - -### stateRoot - -> **stateRoot**: `State`\<`Field`\> - -### updateStateRoot() - -> **updateStateRoot**: (`root`) => `Promise`\<`void`\> - -#### Parameters - -##### root - -`Field` - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md deleted file mode 100644 index 2e95f2e..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/DispatchContractConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: DispatchContractConfig ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / DispatchContractConfig - -# Type Alias: DispatchContractConfig - -> **DispatchContractConfig**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts#L17) - -## Type declaration - -### incomingMessagesMethods - -> **incomingMessagesMethods**: `Record`\<`string`, `` `${string}.${string}` ``\> diff --git a/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md b/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md deleted file mode 100644 index c1d64cb..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/InputBlockProof.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: InputBlockProof ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / InputBlockProof - -# Type Alias: InputBlockProof - -> **InputBlockProof**: [`InferProofBase`](../../common/type-aliases/InferProofBase.md)\<[`BlockProof`](BlockProof.md)\> - -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L9) diff --git a/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md deleted file mode 100644 index 26030d4..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/MandatoryProtocolModulesRecord.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: MandatoryProtocolModulesRecord ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MandatoryProtocolModulesRecord - -# Type Alias: MandatoryProtocolModulesRecord - -> **MandatoryProtocolModulesRecord**: `object` - -Defined in: [packages/protocol/src/protocol/Protocol.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L53) - -## Type declaration - -### AccountState - -> **AccountState**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AccountStateHook`](../classes/AccountStateHook.md)\> - -### BlockHeight - -> **BlockHeight**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BlockHeightHook`](../classes/BlockHeightHook.md)\> - -### BlockProver - -> **BlockProver**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`BlockProverType`](../interfaces/BlockProverType.md)\> - -### LastStateRoot - -> **LastStateRoot**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LastStateRootBlockHook`](../classes/LastStateRootBlockHook.md)\> - -### StateTransitionProver - -> **StateTransitionProver**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`StateTransitionProverType`](../interfaces/StateTransitionProverType.md)\> diff --git a/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md deleted file mode 100644 index e4a6800..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/MandatorySettlementModulesRecord.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: MandatorySettlementModulesRecord ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MandatorySettlementModulesRecord - -# Type Alias: MandatorySettlementModulesRecord - -> **MandatorySettlementModulesRecord**: `object` - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L35) - -## Type declaration - -### BridgeContract - -> **BridgeContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ContractModule`](../classes/ContractModule.md)\<[`BridgeContractType`](BridgeContractType.md), [`BridgeContractConfig`](BridgeContractConfig.md)\>\> - -### DispatchContract - -> **DispatchContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ContractModule`](../classes/ContractModule.md)\<[`DispatchContractType`](../interfaces/DispatchContractType.md), `unknown`\>\> - -### SettlementContract - -> **SettlementContract**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ContractModule`](../classes/ContractModule.md)\<[`SettlementContractType`](../interfaces/SettlementContractType.md), [`SettlementContractConfig`](SettlementContractConfig.md)\>\> diff --git a/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md deleted file mode 100644 index 4dff026..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/ProtocolModulesRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: ProtocolModulesRecord ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProtocolModulesRecord - -# Type Alias: ProtocolModulesRecord - -> **ProtocolModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ProtocolModule`](../classes/ProtocolModule.md)\<`unknown`\>\>\> - -Defined in: [packages/protocol/src/protocol/Protocol.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/protocol/Protocol.ts#L43) diff --git a/src/pages/docs/reference/protocol/type-aliases/ReturnType.md b/src/pages/docs/reference/protocol/type-aliases/ReturnType.md deleted file mode 100644 index f56ccd7..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/ReturnType.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: ReturnType ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ReturnType - -# Type Alias: ReturnType\ - -> **ReturnType**\<`FunctionType`\>: `FunctionType` *extends* (...`args`) => infer Return ? `Return` : `any` - -Defined in: [packages/protocol/src/utils/utils.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/utils.ts#L4) - -## Type Parameters - -• **FunctionType** *extends* `Function` diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md deleted file mode 100644 index d7de3c9..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodIdMapping.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: RuntimeMethodIdMapping ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeMethodIdMapping - -# Type Alias: RuntimeMethodIdMapping - -> **RuntimeMethodIdMapping**: `Record`\<`` `${string}.${string}` ``, \{ `methodId`: `bigint`; `type`: [`RuntimeMethodInvocationType`](RuntimeMethodInvocationType.md); \}\> - -Defined in: [packages/protocol/src/model/RuntimeLike.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/RuntimeLike.ts#L3) diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md deleted file mode 100644 index d189de0..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/RuntimeMethodInvocationType.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: RuntimeMethodInvocationType ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeMethodInvocationType - -# Type Alias: RuntimeMethodInvocationType - -> **RuntimeMethodInvocationType**: `"INCOMING_MESSAGE"` \| `"SIGNATURE"` - -Defined in: [packages/protocol/src/model/RuntimeLike.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/model/RuntimeLike.ts#L1) diff --git a/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md b/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md deleted file mode 100644 index 36ec5ce..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/RuntimeProof.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: RuntimeProof ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / RuntimeProof - -# Type Alias: RuntimeProof - -> **RuntimeProof**: `Proof`\<`void`, [`MethodPublicOutput`](../classes/MethodPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/block/BlockProver.ts:133](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/BlockProver.ts#L133) diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md b/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md deleted file mode 100644 index 1f111a7..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementContractConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: SettlementContractConfig ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementContractConfig - -# Type Alias: SettlementContractConfig - -> **SettlementContractConfig**: `object` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementContractProtocolModule.ts#L26) - -## Type declaration - -### escapeHatchSlotsInterval? - -> `optional` **escapeHatchSlotsInterval**: `number` diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md b/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md deleted file mode 100644 index 1ba9815..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementHookInputs.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: SettlementHookInputs ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementHookInputs - -# Type Alias: SettlementHookInputs - -> **SettlementHookInputs**: `object` - -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L20) - -## Type declaration - -### blockProof - -> **blockProof**: [`InputBlockProof`](InputBlockProof.md) - -### contractState - -> **contractState**: [`SettlementStateRecord`](SettlementStateRecord.md) - -### currentL1BlockHeight - -> **currentL1BlockHeight**: `UInt32` - -### fromNetworkState - -> **fromNetworkState**: [`NetworkState`](../classes/NetworkState.md) - -### newPromisedMessagesHash - -> **newPromisedMessagesHash**: `Field` - -### toNetworkState - -> **toNetworkState**: [`NetworkState`](../classes/NetworkState.md) diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md b/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md deleted file mode 100644 index 497405f..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementModulesRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: SettlementModulesRecord ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementModulesRecord - -# Type Alias: SettlementModulesRecord - -> **SettlementModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`ContractModule`](../classes/ContractModule.md)\<`unknown`, `unknown`\>\>\> - -Defined in: [packages/protocol/src/settlement/SettlementContractModule.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/SettlementContractModule.ts#L31) diff --git a/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md b/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md deleted file mode 100644 index 5e53432..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/SettlementStateRecord.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: SettlementStateRecord ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SettlementStateRecord - -# Type Alias: SettlementStateRecord - -> **SettlementStateRecord**: `object` - -Defined in: [packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/modularity/ProvableSettlementHook.ts#L11) - -## Type declaration - -### blockHashRoot - -> **blockHashRoot**: `Field` - -### lastSettlementL1BlockHeight - -> **lastSettlementL1BlockHeight**: `UInt32` - -### networkStateHash - -> **networkStateHash**: `Field` - -### sequencerKey - -> **sequencerKey**: `PublicKey` - -### stateRoot - -> **stateRoot**: `Field` diff --git a/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md b/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md deleted file mode 100644 index 5b09f4a..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/SmartContractClassFromInterface.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: SmartContractClassFromInterface ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / SmartContractClassFromInterface - -# Type Alias: SmartContractClassFromInterface\ - -> **SmartContractClassFromInterface**\<`Type`\>: *typeof* `SmartContract` & [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`Type`\> - -Defined in: [packages/protocol/src/settlement/ContractModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/ContractModule.ts#L11) - -## Type Parameters - -• **Type** diff --git a/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md b/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md deleted file mode 100644 index 4031123..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/StateTransitionProof.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: StateTransitionProof ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / StateTransitionProof - -# Type Alias: StateTransitionProof - -> **StateTransitionProof**: `Proof`\<[`StateTransitionProverPublicInput`](../classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../classes/StateTransitionProverPublicOutput.md)\> - -Defined in: [packages/protocol/src/prover/statetransition/StateTransitionProvable.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/statetransition/StateTransitionProvable.ts#L20) diff --git a/src/pages/docs/reference/protocol/type-aliases/Subclass.md b/src/pages/docs/reference/protocol/type-aliases/Subclass.md deleted file mode 100644 index 17843eb..0000000 --- a/src/pages/docs/reference/protocol/type-aliases/Subclass.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Subclass ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / Subclass - -# Type Alias: Subclass\ - -> **Subclass**\<`Class`\>: (...`args`) => `InstanceType`\<`Class`\> & `{ [Key in keyof Class]: Class[Key] }` & `object` - -Defined in: [packages/protocol/src/utils/utils.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/utils.ts#L10) - -## Type declaration - -### prototype - -> **prototype**: `InstanceType`\<`Class`\> - -## Type Parameters - -• **Class** *extends* (...`args`) => `any` diff --git a/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md b/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md deleted file mode 100644 index dc58e5a..0000000 --- a/src/pages/docs/reference/protocol/variables/ACTIONS_EMPTY_HASH.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: ACTIONS_EMPTY_HASH ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ACTIONS\_EMPTY\_HASH - -# Variable: ACTIONS\_EMPTY\_HASH - -> `const` **ACTIONS\_EMPTY\_HASH**: `Field` = `Reducer.initialActionState` - -Defined in: [packages/protocol/src/settlement/contracts/DispatchSmartContract.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/DispatchSmartContract.ts#L38) diff --git a/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md b/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md deleted file mode 100644 index 268bdeb..0000000 --- a/src/pages/docs/reference/protocol/variables/BATCH_SIGNATURE_PREFIX.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: BATCH_SIGNATURE_PREFIX ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / BATCH\_SIGNATURE\_PREFIX - -# Variable: BATCH\_SIGNATURE\_PREFIX - -> `const` **BATCH\_SIGNATURE\_PREFIX**: `Field` - -Defined in: [packages/protocol/src/settlement/contracts/SettlementSmartContract.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/contracts/SettlementSmartContract.ts#L92) diff --git a/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md b/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md deleted file mode 100644 index dea39bb..0000000 --- a/src/pages/docs/reference/protocol/variables/MINA_EVENT_PREFIXES.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: MINA_EVENT_PREFIXES ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / MINA\_EVENT\_PREFIXES - -# Variable: MINA\_EVENT\_PREFIXES - -> `const` **MINA\_EVENT\_PREFIXES**: `object` - -Defined in: [packages/protocol/src/utils/MinaPrefixedProvableHashList.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/utils/MinaPrefixedProvableHashList.ts#L14) - -## Type declaration - -### event - -> `readonly` **event**: `"MinaZkappEvent******"` = `"MinaZkappEvent******"` - -### events - -> `readonly` **events**: `"MinaZkappEvents*****"` = `"MinaZkappEvents*****"` - -### sequenceEvents - -> `readonly` **sequenceEvents**: `"MinaZkappSeqEvents**"` = `"MinaZkappSeqEvents**"` diff --git a/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md b/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md deleted file mode 100644 index d5b0d30..0000000 --- a/src/pages/docs/reference/protocol/variables/OUTGOING_MESSAGE_BATCH_SIZE.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: OUTGOING_MESSAGE_BATCH_SIZE ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / OUTGOING\_MESSAGE\_BATCH\_SIZE - -# Variable: OUTGOING\_MESSAGE\_BATCH\_SIZE - -> `const` **OUTGOING\_MESSAGE\_BATCH\_SIZE**: `1` = `1` - -Defined in: [packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/settlement/messages/OutgoingMessageArgument.ts#L6) diff --git a/src/pages/docs/reference/protocol/variables/ProtocolConstants.md b/src/pages/docs/reference/protocol/variables/ProtocolConstants.md deleted file mode 100644 index 8237a35..0000000 --- a/src/pages/docs/reference/protocol/variables/ProtocolConstants.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: ProtocolConstants ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / ProtocolConstants - -# Variable: ProtocolConstants - -> `const` **ProtocolConstants**: `object` - -Defined in: [packages/protocol/src/Constants.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/Constants.ts#L1) - -## Type declaration - -### stateTransitionProverBatchSize - -> **stateTransitionProverBatchSize**: `number` = `4` diff --git a/src/pages/docs/reference/protocol/variables/treeFeeHeight.md b/src/pages/docs/reference/protocol/variables/treeFeeHeight.md deleted file mode 100644 index 94061dc..0000000 --- a/src/pages/docs/reference/protocol/variables/treeFeeHeight.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: treeFeeHeight ---- - -[**@proto-kit/protocol**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/protocol](../README.md) / treeFeeHeight - -# Variable: treeFeeHeight - -> `const` **treeFeeHeight**: `10` = `10` - -Defined in: [packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/protocol/src/prover/block/accummulators/RuntimeVerificationKeyTree.ts#L4) diff --git a/src/pages/docs/reference/sdk/README.md b/src/pages/docs/reference/sdk/README.md deleted file mode 100644 index 6056565..0000000 --- a/src/pages/docs/reference/sdk/README.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "@proto-kit/sdk" ---- - -**@proto-kit/sdk** - -*** - -[Documentation](../../README.md) / @proto-kit/sdk - -# YAB: SDK - -SDK for developing privacy enabled application chains. - -To use an appchain, you should use the following syntax as provided by this example: - -```typescript -const appChain = AppChain.from({ - sequencer: Sequencer.from({ - graphql: GraphQLServerModule, - }), - - runtime: Runtime.from({ - runtimeModules: { - admin: Admin, - }, - - state: new InMemoryStateService(), - }), -}); - -appChain.configure({ - sequencer: { - graphql: { - port: 8080, - }, - }, - - runtime: { - admin: { - publicKey: "123", - }, - }, -}); - -await appChain.start(); -``` - -The AppChain takes two arguments, a Runtime and a Sequencer. - -1. The Runtime holds all modules that have provable code. - In a nutshell, all "smart contract" logic that a developer wants to create for their rollup. - For more documentation on Runtime, please refer to @protokit/module - -2. The Sequencer definition. - A sequencer is responsible for all services that interact with the Runtime, but are not provable code itself. - That could be a GraphQL interface, P2P networking layer, database layer, ... diff --git a/src/pages/docs/reference/sdk/_meta.tsx b/src/pages/docs/reference/sdk/_meta.tsx deleted file mode 100644 index c639525..0000000 --- a/src/pages/docs/reference/sdk/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/sdk/classes/AppChain.md b/src/pages/docs/reference/sdk/classes/AppChain.md deleted file mode 100644 index acfa70d..0000000 --- a/src/pages/docs/reference/sdk/classes/AppChain.md +++ /dev/null @@ -1,754 +0,0 @@ ---- -title: AppChain ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChain - -# Class: AppChain\ - -Defined in: [sdk/src/appChain/AppChain.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L112) - -AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer - -## Extends - -- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -## Extended by - -- [`TestingAppChain`](TestingAppChain.md) -- [`ClientAppChain`](ClientAppChain.md) - -## Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) - -## Constructors - -### new AppChain() - -> **new AppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L151) - -#### Parameters - -##### definition - -[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Returns - -[`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) - -*** - -### definition - -> **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L144) - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) - -*** - -### protocol - -#### Get Signature - -> **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L215) - -##### Returns - -[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> - -*** - -### query - -#### Get Signature - -> **get** **query**(): `object` - -Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L176) - -##### Returns - -`object` - -###### network - -> **network**: [`NetworkStateQuery`](../../sequencer/classes/NetworkStateQuery.md) - -###### protocol - -> **protocol**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`ProtocolModule`](../../protocol/classes/ProtocolModule.md)\<`unknown`\>, `ProtocolModules`\> - -###### runtime - -> **runtime**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`RuntimeModule`](../../module/classes/RuntimeModule.md)\<`unknown`\>, `RuntimeModules`\> - -*** - -### runtime - -#### Get Signature - -> **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L207) - -##### Returns - -[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> - -*** - -### sequencer - -#### Get Signature - -> **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L211) - -##### Returns - -[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf>` - -Defined in: common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf>` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) - -*** - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L352) - -#### Returns - -`Promise`\<`void`\> - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:160 - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) - -*** - -### decorateModule() - -> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:134 - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -##### containedModule - -`InstanceType`\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\]\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>[] - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf>` - -Defined in: common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf>` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> - -Defined in: common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) - -*** - -### start() - -> **start**(`proofsEnabled`, `dependencyContainer`): `Promise`\<`void`\> - -Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L309) - -Starts the appchain and cross-registers runtime to sequencer - -#### Parameters - -##### proofsEnabled - -`boolean` = `false` - -##### dependencyContainer - -`DependencyContainer` = `container` - -#### Returns - -`Promise`\<`void`\> - -*** - -### transaction() - -> **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> - -Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L219) - -#### Parameters - -##### sender - -`PublicKey` - -##### callback - -() => `Promise`\<`void`\> - -##### options? - -###### nonce - -`number` - -#### Returns - -`Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L127) - -#### Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) - -#### Parameters - -##### definition - -[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Returns - -[`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> diff --git a/src/pages/docs/reference/sdk/classes/AppChainModule.md b/src/pages/docs/reference/sdk/classes/AppChainModule.md deleted file mode 100644 index c5e752a..0000000 --- a/src/pages/docs/reference/sdk/classes/AppChainModule.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: AppChainModule ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChainModule - -# Class: AppChainModule\ - -Defined in: [sdk/src/appChain/AppChainModule.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L13) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> - -## Extended by - -- [`StateServiceQueryModule`](StateServiceQueryModule.md) -- [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md) -- [`InMemorySigner`](InMemorySigner.md) -- [`TransactionSender`](../interfaces/TransactionSender.md) -- [`InMemoryTransactionSender`](InMemoryTransactionSender.md) -- [`AuroSigner`](AuroSigner.md) -- [`GraphqlClient`](GraphqlClient.md) -- [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md) -- [`GraphqlTransactionSender`](GraphqlTransactionSender.md) -- [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -## Constructors - -### new AppChainModule() - -> **new AppChainModule**\<`Config`\>(): [`AppChainModule`](AppChainModule.md)\<`Config`\> - -#### Returns - -[`AppChainModule`](AppChainModule.md)\<`Config`\> - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) diff --git a/src/pages/docs/reference/sdk/classes/AppChainTransaction.md b/src/pages/docs/reference/sdk/classes/AppChainTransaction.md deleted file mode 100644 index 35b0022..0000000 --- a/src/pages/docs/reference/sdk/classes/AppChainTransaction.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: AppChainTransaction ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChainTransaction - -# Class: AppChainTransaction - -Defined in: [sdk/src/transaction/AppChainTransaction.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L6) - -## Constructors - -### new AppChainTransaction() - -> **new AppChainTransaction**(`signer`, `transactionSender`): [`AppChainTransaction`](AppChainTransaction.md) - -Defined in: [sdk/src/transaction/AppChainTransaction.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L9) - -#### Parameters - -##### signer - -[`Signer`](../interfaces/Signer.md) - -##### transactionSender - -[`TransactionSender`](../interfaces/TransactionSender.md) - -#### Returns - -[`AppChainTransaction`](AppChainTransaction.md) - -## Properties - -### signer - -> **signer**: [`Signer`](../interfaces/Signer.md) - -Defined in: [sdk/src/transaction/AppChainTransaction.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L10) - -*** - -### transaction? - -> `optional` **transaction**: [`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) \| [`UnsignedTransaction`](../../sequencer/classes/UnsignedTransaction.md) - -Defined in: [sdk/src/transaction/AppChainTransaction.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L7) - -*** - -### transactionSender - -> **transactionSender**: [`TransactionSender`](../interfaces/TransactionSender.md) - -Defined in: [sdk/src/transaction/AppChainTransaction.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L11) - -## Methods - -### hasPendingTransaction() - -> **hasPendingTransaction**(`transaction`?): `asserts transaction is PendingTransaction` - -Defined in: [sdk/src/transaction/AppChainTransaction.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L27) - -#### Parameters - -##### transaction? - -[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) | [`UnsignedTransaction`](../../sequencer/classes/UnsignedTransaction.md) - -#### Returns - -`asserts transaction is PendingTransaction` - -*** - -### hasUnsignedTransaction() - -> **hasUnsignedTransaction**(`transaction`?): `asserts transaction is UnsignedTransaction` - -Defined in: [sdk/src/transaction/AppChainTransaction.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L18) - -#### Parameters - -##### transaction? - -[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) | [`UnsignedTransaction`](../../sequencer/classes/UnsignedTransaction.md) - -#### Returns - -`asserts transaction is UnsignedTransaction` - -*** - -### send() - -> **send**(): `Promise`\<`void`\> - -Defined in: [sdk/src/transaction/AppChainTransaction.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L48) - -#### Returns - -`Promise`\<`void`\> - -*** - -### sign() - -> **sign**(): `Promise`\<`void`\> - -Defined in: [sdk/src/transaction/AppChainTransaction.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L36) - -#### Returns - -`Promise`\<`void`\> - -*** - -### withUnsignedTransaction() - -> **withUnsignedTransaction**(`unsignedTransaction`): `void` - -Defined in: [sdk/src/transaction/AppChainTransaction.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AppChainTransaction.ts#L14) - -#### Parameters - -##### unsignedTransaction - -[`UnsignedTransaction`](../../sequencer/classes/UnsignedTransaction.md) - -#### Returns - -`void` diff --git a/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md b/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md deleted file mode 100644 index 50605b6..0000000 --- a/src/pages/docs/reference/sdk/classes/AreProofsEnabledFactory.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: AreProofsEnabledFactory ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AreProofsEnabledFactory - -# Class: AreProofsEnabledFactory - -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L21) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Implements - -- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) - -## Constructors - -### new AreProofsEnabledFactory() - -> **new AreProofsEnabledFactory**(): [`AreProofsEnabledFactory`](AreProofsEnabledFactory.md) - -#### Returns - -[`AreProofsEnabledFactory`](AreProofsEnabledFactory.md) - -## Methods - -### dependencies() - -> **dependencies**(): `object` - -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L22) - -#### Returns - -`object` - -##### areProofsEnabled - -> **areProofsEnabled**: `object` - -###### areProofsEnabled.useClass - -> **areProofsEnabled.useClass**: *typeof* [`InMemoryAreProofsEnabled`](InMemoryAreProofsEnabled.md) = `InMemoryAreProofsEnabled` - -#### Implementation of - -[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) diff --git a/src/pages/docs/reference/sdk/classes/AuroSigner.md b/src/pages/docs/reference/sdk/classes/AuroSigner.md deleted file mode 100644 index ba4ad71..0000000 --- a/src/pages/docs/reference/sdk/classes/AuroSigner.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: AuroSigner ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AuroSigner - -# Class: AuroSigner - -Defined in: [sdk/src/transaction/AuroSigner.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AuroSigner.ts#L9) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`AppChainModule`](AppChainModule.md)\<`unknown`\> - -## Implements - -- [`Signer`](../interfaces/Signer.md) - -## Constructors - -### new AuroSigner() - -> **new AuroSigner**(): [`AuroSigner`](AuroSigner.md) - -#### Returns - -[`AuroSigner`](AuroSigner.md) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) - -*** - -### currentConfig - -> `protected` **currentConfig**: `unknown` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) - -*** - -### sign() - -> **sign**(`message`): `Promise`\<`Signature`\> - -Defined in: [sdk/src/transaction/AuroSigner.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/AuroSigner.ts#L10) - -#### Parameters - -##### message - -`Field`[] - -#### Returns - -`Promise`\<`Signature`\> - -#### Implementation of - -[`Signer`](../interfaces/Signer.md).[`sign`](../interfaces/Signer.md#sign) diff --git a/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md b/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md deleted file mode 100644 index 11f3e6f..0000000 --- a/src/pages/docs/reference/sdk/classes/BlockStorageNetworkStateModule.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -title: BlockStorageNetworkStateModule ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / BlockStorageNetworkStateModule - -# Class: BlockStorageNetworkStateModule - -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L17) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`AppChainModule`](AppChainModule.md)\<`Record`\<`string`, `never`\>\> - -## Implements - -- [`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md) - -## Constructors - -### new BlockStorageNetworkStateModule() - -> **new BlockStorageNetworkStateModule**(`sequencer`): [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md) - -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L21) - -#### Parameters - -##### sequencer - -[`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> - -#### Returns - -[`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md) - -#### Overrides - -[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Record`\<`string`, `never`\> - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) - -*** - -### getProvenNetworkState() - -> **getProvenNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L58) - -#### Returns - -`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -#### Implementation of - -[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getProvenNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getprovennetworkstate) - -*** - -### getStagedNetworkState() - -> **getStagedNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L53) - -Staged network state is the networkstate after the latest unproven block -with afterBundle() hooks executed - -#### Returns - -`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -#### Implementation of - -[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getStagedNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getstagednetworkstate) - -*** - -### getUnprovenNetworkState() - -> **getUnprovenNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [sdk/src/query/BlockStorageNetworkStateModule.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/BlockStorageNetworkStateModule.ts#L44) - -#### Returns - -`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -#### Implementation of - -[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getUnprovenNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getunprovennetworkstate) diff --git a/src/pages/docs/reference/sdk/classes/ClientAppChain.md b/src/pages/docs/reference/sdk/classes/ClientAppChain.md deleted file mode 100644 index b5b7245..0000000 --- a/src/pages/docs/reference/sdk/classes/ClientAppChain.md +++ /dev/null @@ -1,799 +0,0 @@ ---- -title: ClientAppChain ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / ClientAppChain - -# Class: ClientAppChain\ - -Defined in: [sdk/src/appChain/ClientAppChain.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/ClientAppChain.ts#L30) - -AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer - -## Extends - -- [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -## Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) - -## Constructors - -### new ClientAppChain() - -> **new ClientAppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`ClientAppChain`](ClientAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L151) - -#### Parameters - -##### definition - -[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Returns - -[`ClientAppChain`](ClientAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`constructor`](AppChain.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AppChain`](AppChain.md).[`currentConfig`](AppChain.md#currentconfig) - -*** - -### definition - -> **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L144) - -#### Inherited from - -[`AppChain`](AppChain.md).[`definition`](AppChain.md#definition-1) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`config`](AppChain.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`AppChain`](AppChain.md).[`container`](AppChain.md#container) - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`events`](AppChain.md#events) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`AppChain`](AppChain.md).[`moduleNames`](AppChain.md#modulenames) - -*** - -### protocol - -#### Get Signature - -> **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L215) - -##### Returns - -[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`protocol`](AppChain.md#protocol) - -*** - -### query - -#### Get Signature - -> **get** **query**(): `object` - -Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L176) - -##### Returns - -`object` - -###### network - -> **network**: [`NetworkStateQuery`](../../sequencer/classes/NetworkStateQuery.md) - -###### protocol - -> **protocol**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`ProtocolModule`](../../protocol/classes/ProtocolModule.md)\<`unknown`\>, `ProtocolModules`\> - -###### runtime - -> **runtime**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`RuntimeModule`](../../module/classes/RuntimeModule.md)\<`unknown`\>, `RuntimeModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`query`](AppChain.md#query) - -*** - -### runtime - -#### Get Signature - -> **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L207) - -##### Returns - -[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`runtime`](AppChain.md#runtime-1) - -*** - -### sequencer - -#### Get Signature - -> **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L211) - -##### Returns - -[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`sequencer`](AppChain.md#sequencer) - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`AppChain`](AppChain.md).[`assertContainerInitialized`](AppChain.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf>` - -Defined in: common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf>` - -#### Inherited from - -[`AppChain`](AppChain.md).[`assertIsValidModuleName`](AppChain.md#assertisvalidmodulename) - -*** - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L352) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`close`](AppChain.md#close) - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`configure`](AppChain.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`configurePartial`](AppChain.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:160 - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`create`](AppChain.md#create) - -*** - -### decorateModule() - -> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:134 - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -##### containedModule - -`InstanceType`\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\]\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`decorateModule`](AppChain.md#decoratemodule) - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>[] - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`initializeDependencyFactories`](AppChain.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf>` - -Defined in: common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf>` - -#### Inherited from - -[`AppChain`](AppChain.md).[`isValidModuleName`](AppChain.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`onAfterModuleResolution`](AppChain.md#onaftermoduleresolution) - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`registerAliases`](AppChain.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`registerClasses`](AppChain.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`registerModules`](AppChain.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`registerValue`](AppChain.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> - -Defined in: common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`resolve`](AppChain.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`AppChain`](AppChain.md).[`resolveOrFail`](AppChain.md#resolveorfail) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [sdk/src/appChain/ClientAppChain.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/ClientAppChain.ts#L108) - -Starts the appchain and cross-registers runtime to sequencer - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`AppChain`](AppChain.md).[`start`](AppChain.md#start) - -*** - -### transaction() - -> **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> - -Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L219) - -#### Parameters - -##### sender - -`PublicKey` - -##### callback - -() => `Promise`\<`void`\> - -##### options? - -###### nonce - -`number` - -#### Returns - -`Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`transaction`](AppChain.md#transaction) - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`validateModule`](AppChain.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L127) - -#### Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) - -#### Parameters - -##### definition - -[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Returns - -[`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`from`](AppChain.md#from) - -*** - -### fromRuntime() - -> `static` **fromRuntime**\<`RuntimeModules`, `SignerType`\>(`runtimeModules`, `signer`): [`ClientAppChain`](ClientAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{\}, \{ `GraphqlClient`: *typeof* [`GraphqlClient`](GraphqlClient.md); `NetworkStateTransportModule`: *typeof* [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md); `QueryTransportModule`: *typeof* [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md); `Signer`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`SignerType`\>; `TransactionSender`: *typeof* [`GraphqlTransactionSender`](GraphqlTransactionSender.md); \}\> - -Defined in: [sdk/src/appChain/ClientAppChain.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/ClientAppChain.ts#L42) - -#### Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -• **SignerType** *extends* [`Signer`](../interfaces/Signer.md) & [`AppChainModule`](AppChainModule.md)\<`unknown`\> - -#### Parameters - -##### runtimeModules - -`RuntimeModules` - -##### signer - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`SignerType`\> - -#### Returns - -[`ClientAppChain`](ClientAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{\}, \{ `GraphqlClient`: *typeof* [`GraphqlClient`](GraphqlClient.md); `NetworkStateTransportModule`: *typeof* [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md); `QueryTransportModule`: *typeof* [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md); `Signer`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`SignerType`\>; `TransactionSender`: *typeof* [`GraphqlTransactionSender`](GraphqlTransactionSender.md); \}\> diff --git a/src/pages/docs/reference/sdk/classes/GraphqlClient.md b/src/pages/docs/reference/sdk/classes/GraphqlClient.md deleted file mode 100644 index 52f25db..0000000 --- a/src/pages/docs/reference/sdk/classes/GraphqlClient.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: GraphqlClient ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / GraphqlClient - -# Class: GraphqlClient - -Defined in: [sdk/src/graphql/GraphqlClient.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlClient.ts#L9) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`AppChainModule`](AppChainModule.md)\<[`GraphqlClientConfig`](../interfaces/GraphqlClientConfig.md)\> - -## Constructors - -### new GraphqlClient() - -> **new GraphqlClient**(): [`GraphqlClient`](GraphqlClient.md) - -#### Returns - -[`GraphqlClient`](GraphqlClient.md) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`GraphqlClientConfig`](../interfaces/GraphqlClientConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) - -## Accessors - -### client - -#### Get Signature - -> **get** **client**(): `Client` - -Defined in: [sdk/src/graphql/GraphqlClient.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlClient.ts#L20) - -##### Returns - -`Client` - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) diff --git a/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md b/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md deleted file mode 100644 index 1742155..0000000 --- a/src/pages/docs/reference/sdk/classes/GraphqlNetworkStateTransportModule.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -title: GraphqlNetworkStateTransportModule ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / GraphqlNetworkStateTransportModule - -# Class: GraphqlNetworkStateTransportModule - -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L20) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`AppChainModule`](AppChainModule.md)\<`Record`\<`string`, `never`\>\> - -## Implements - -- [`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md) - -## Constructors - -### new GraphqlNetworkStateTransportModule() - -> **new GraphqlNetworkStateTransportModule**(`graphqlClient`): [`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md) - -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L24) - -#### Parameters - -##### graphqlClient - -[`GraphqlClient`](GraphqlClient.md) - -#### Returns - -[`GraphqlNetworkStateTransportModule`](GraphqlNetworkStateTransportModule.md) - -#### Overrides - -[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Record`\<`string`, `never`\> - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) - -*** - -### getProvenNetworkState() - -> **getProvenNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L71) - -#### Returns - -`Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> - -#### Implementation of - -[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getProvenNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getprovennetworkstate) - -*** - -### getStagedNetworkState() - -> **getStagedNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L75) - -#### Returns - -`Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> - -#### Implementation of - -[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getStagedNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getstagednetworkstate) - -*** - -### getUnprovenNetworkState() - -> **getUnprovenNetworkState**(): `Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [sdk/src/graphql/GraphqlNetworkStateTransportModule.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlNetworkStateTransportModule.ts#L79) - -#### Returns - -`Promise`\<[`NetworkState`](../../protocol/classes/NetworkState.md)\> - -#### Implementation of - -[`NetworkStateTransportModule`](../../sequencer/interfaces/NetworkStateTransportModule.md).[`getUnprovenNetworkState`](../../sequencer/interfaces/NetworkStateTransportModule.md#getunprovennetworkstate) diff --git a/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md b/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md deleted file mode 100644 index 9673923..0000000 --- a/src/pages/docs/reference/sdk/classes/GraphqlQueryTransportModule.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -title: GraphqlQueryTransportModule ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / GraphqlQueryTransportModule - -# Class: GraphqlQueryTransportModule - -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L30) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`AppChainModule`](AppChainModule.md) - -## Implements - -- [`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md) - -## Constructors - -### new GraphqlQueryTransportModule() - -> **new GraphqlQueryTransportModule**(`graphqlClient`): [`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md) - -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L34) - -#### Parameters - -##### graphqlClient - -[`GraphqlClient`](GraphqlClient.md) - -#### Returns - -[`GraphqlQueryTransportModule`](GraphqlQueryTransportModule.md) - -#### Overrides - -[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) - -*** - -### get() - -> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> - -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L40) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| `Field`[]\> - -#### Implementation of - -[`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md).[`get`](../../sequencer/interfaces/QueryTransportModule.md#get) - -*** - -### merkleWitness() - -> **merkleWitness**(`key`): `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> - -Defined in: [sdk/src/graphql/GraphqlQueryTransportModule.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlQueryTransportModule.ts#L65) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> - -#### Implementation of - -[`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md).[`merkleWitness`](../../sequencer/interfaces/QueryTransportModule.md#merklewitness) diff --git a/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md b/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md deleted file mode 100644 index d02928e..0000000 --- a/src/pages/docs/reference/sdk/classes/GraphqlTransactionSender.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -title: GraphqlTransactionSender ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / GraphqlTransactionSender - -# Class: GraphqlTransactionSender - -Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L11) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`AppChainModule`](AppChainModule.md) - -## Implements - -- [`TransactionSender`](../interfaces/TransactionSender.md) - -## Constructors - -### new GraphqlTransactionSender() - -> **new GraphqlTransactionSender**(`graphqlClient`): [`GraphqlTransactionSender`](GraphqlTransactionSender.md) - -Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L15) - -#### Parameters - -##### graphqlClient - -[`GraphqlClient`](GraphqlClient.md) - -#### Returns - -[`GraphqlTransactionSender`](GraphqlTransactionSender.md) - -#### Overrides - -[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -#### Implementation of - -[`TransactionSender`](../interfaces/TransactionSender.md).[`appChain`](../interfaces/TransactionSender.md#appchain) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Implementation of - -[`TransactionSender`](../interfaces/TransactionSender.md).[`currentConfig`](../interfaces/TransactionSender.md#currentconfig) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Implementation of - -[`TransactionSender`](../interfaces/TransactionSender.md).[`config`](../interfaces/TransactionSender.md#config) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Implementation of - -[`TransactionSender`](../interfaces/TransactionSender.md).[`create`](../interfaces/TransactionSender.md#create) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) - -*** - -### send() - -> **send**(`transaction`): `Promise`\<`void`\> - -Defined in: [sdk/src/graphql/GraphqlTransactionSender.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlTransactionSender.ts#L21) - -#### Parameters - -##### transaction - -[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`TransactionSender`](../interfaces/TransactionSender.md).[`send`](../interfaces/TransactionSender.md#send) diff --git a/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md b/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md deleted file mode 100644 index a4652a8..0000000 --- a/src/pages/docs/reference/sdk/classes/InMemoryAreProofsEnabled.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: InMemoryAreProofsEnabled ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / InMemoryAreProofsEnabled - -# Class: InMemoryAreProofsEnabled - -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L9) - -## Implements - -- [`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -## Constructors - -### new InMemoryAreProofsEnabled() - -> **new InMemoryAreProofsEnabled**(): [`InMemoryAreProofsEnabled`](InMemoryAreProofsEnabled.md) - -#### Returns - -[`InMemoryAreProofsEnabled`](InMemoryAreProofsEnabled.md) - -## Accessors - -### areProofsEnabled - -#### Get Signature - -> **get** **areProofsEnabled**(): `boolean` - -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L12) - -##### Returns - -`boolean` - -#### Implementation of - -[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md).[`areProofsEnabled`](../../common/interfaces/AreProofsEnabled.md#areproofsenabled) - -## Methods - -### setProofsEnabled() - -> **setProofsEnabled**(`areProofsEnabled`): `void` - -Defined in: [sdk/src/appChain/AreProofsEnabledFactory.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AreProofsEnabledFactory.ts#L16) - -#### Parameters - -##### areProofsEnabled - -`boolean` - -#### Returns - -`void` - -#### Implementation of - -[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md).[`setProofsEnabled`](../../common/interfaces/AreProofsEnabled.md#setproofsenabled) diff --git a/src/pages/docs/reference/sdk/classes/InMemorySigner.md b/src/pages/docs/reference/sdk/classes/InMemorySigner.md deleted file mode 100644 index e0b9c09..0000000 --- a/src/pages/docs/reference/sdk/classes/InMemorySigner.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -title: InMemorySigner ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / InMemorySigner - -# Class: InMemorySigner - -Defined in: [sdk/src/transaction/InMemorySigner.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L15) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`AppChainModule`](AppChainModule.md)\<[`InMemorySignerConfig`](../interfaces/InMemorySignerConfig.md)\> - -## Implements - -- [`Signer`](../interfaces/Signer.md) - -## Constructors - -### new InMemorySigner() - -> **new InMemorySigner**(): [`InMemorySigner`](InMemorySigner.md) - -Defined in: [sdk/src/transaction/InMemorySigner.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L19) - -#### Returns - -[`InMemorySigner`](InMemorySigner.md) - -#### Overrides - -[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`InMemorySignerConfig`](../interfaces/InMemorySignerConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) - -*** - -### sign() - -> **sign**(`signatureData`): `Promise`\<`Signature`\> - -Defined in: [sdk/src/transaction/InMemorySigner.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L23) - -#### Parameters - -##### signatureData - -`Field`[] - -#### Returns - -`Promise`\<`Signature`\> - -#### Implementation of - -[`Signer`](../interfaces/Signer.md).[`sign`](../interfaces/Signer.md#sign) diff --git a/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md b/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md deleted file mode 100644 index a93bbfb..0000000 --- a/src/pages/docs/reference/sdk/classes/InMemoryTransactionSender.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -title: InMemoryTransactionSender ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / InMemoryTransactionSender - -# Class: InMemoryTransactionSender - -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L16) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`AppChainModule`](AppChainModule.md) - -## Implements - -- [`TransactionSender`](../interfaces/TransactionSender.md) - -## Constructors - -### new InMemoryTransactionSender() - -> **new InMemoryTransactionSender**(`sequencer`): [`InMemoryTransactionSender`](InMemoryTransactionSender.md) - -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L22) - -#### Parameters - -##### sequencer - -[`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> - -#### Returns - -[`InMemoryTransactionSender`](InMemoryTransactionSender.md) - -#### Overrides - -[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -#### Implementation of - -[`TransactionSender`](../interfaces/TransactionSender.md).[`appChain`](../interfaces/TransactionSender.md#appchain) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Implementation of - -[`TransactionSender`](../interfaces/TransactionSender.md).[`currentConfig`](../interfaces/TransactionSender.md#currentconfig) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) - -*** - -### mempool - -> **mempool**: [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md) - -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L20) - -*** - -### sequencer - -> **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> - -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L23) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Implementation of - -[`TransactionSender`](../interfaces/TransactionSender.md).[`config`](../interfaces/TransactionSender.md#config) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Implementation of - -[`TransactionSender`](../interfaces/TransactionSender.md).[`create`](../interfaces/TransactionSender.md#create) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) - -*** - -### send() - -> **send**(`transaction`): `Promise`\<`void`\> - -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L30) - -#### Parameters - -##### transaction - -[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`TransactionSender`](../interfaces/TransactionSender.md).[`send`](../interfaces/TransactionSender.md#send) diff --git a/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md b/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md deleted file mode 100644 index ec25407..0000000 --- a/src/pages/docs/reference/sdk/classes/SharedDependencyFactory.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: SharedDependencyFactory ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / SharedDependencyFactory - -# Class: SharedDependencyFactory - -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/SharedDependencyFactory.ts#L14) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Implements - -- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) - -## Constructors - -### new SharedDependencyFactory() - -> **new SharedDependencyFactory**(): [`SharedDependencyFactory`](SharedDependencyFactory.md) - -#### Returns - -[`SharedDependencyFactory`](SharedDependencyFactory.md) - -## Methods - -### dependencies() - -> **dependencies**(): [`SharedDependencyRecord`](../interfaces/SharedDependencyRecord.md) - -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/SharedDependencyFactory.ts#L15) - -#### Returns - -[`SharedDependencyRecord`](../interfaces/SharedDependencyRecord.md) - -#### Implementation of - -[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) diff --git a/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md b/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md deleted file mode 100644 index 19b67c3..0000000 --- a/src/pages/docs/reference/sdk/classes/StateServiceQueryModule.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -title: StateServiceQueryModule ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / StateServiceQueryModule - -# Class: StateServiceQueryModule - -Defined in: [sdk/src/query/StateServiceQueryModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L16) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`AppChainModule`](AppChainModule.md) - -## Implements - -- [`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md) - -## Constructors - -### new StateServiceQueryModule() - -> **new StateServiceQueryModule**(`sequencer`): [`StateServiceQueryModule`](StateServiceQueryModule.md) - -Defined in: [sdk/src/query/StateServiceQueryModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L20) - -#### Parameters - -##### sequencer - -[`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> - -#### Returns - -[`StateServiceQueryModule`](StateServiceQueryModule.md) - -#### Overrides - -[`AppChainModule`](AppChainModule.md).[`constructor`](AppChainModule.md#constructors) - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`appChain`](AppChainModule.md#appchain) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`currentConfig`](AppChainModule.md#currentconfig) - -*** - -### sequencer - -> **sequencer**: [`Sequencer`](../../sequencer/classes/Sequencer.md)\<[`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md)\> - -Defined in: [sdk/src/query/StateServiceQueryModule.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L21) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [sdk/src/appChain/AppChainModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L16) - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`presets`](AppChainModule.md#presets) - -## Accessors - -### asyncStateService - -#### Get Signature - -> **get** **asyncStateService**(): [`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md) - -Defined in: [sdk/src/query/StateServiceQueryModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L26) - -##### Returns - -[`AsyncStateService`](../../sequencer/interfaces/AsyncStateService.md) - -*** - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`config`](AppChainModule.md#config) - -*** - -### treeStore - -#### Get Signature - -> **get** **treeStore**(): [`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md) - -Defined in: [sdk/src/query/StateServiceQueryModule.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L32) - -##### Returns - -[`AsyncMerkleTreeStore`](../../sequencer/interfaces/AsyncMerkleTreeStore.md) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](AppChainModule.md).[`create`](AppChainModule.md#create) - -*** - -### get() - -> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> - -Defined in: [sdk/src/query/StateServiceQueryModule.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L36) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| `Field`[]\> - -#### Implementation of - -[`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md).[`get`](../../sequencer/interfaces/QueryTransportModule.md#get) - -*** - -### merkleWitness() - -> **merkleWitness**(`path`): `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> - -Defined in: [sdk/src/query/StateServiceQueryModule.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/query/StateServiceQueryModule.ts#L40) - -#### Parameters - -##### path - -`Field` - -#### Returns - -`Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> - -#### Implementation of - -[`QueryTransportModule`](../../sequencer/interfaces/QueryTransportModule.md).[`merkleWitness`](../../sequencer/interfaces/QueryTransportModule.md#merklewitness) diff --git a/src/pages/docs/reference/sdk/classes/TestingAppChain.md b/src/pages/docs/reference/sdk/classes/TestingAppChain.md deleted file mode 100644 index 9e6250b..0000000 --- a/src/pages/docs/reference/sdk/classes/TestingAppChain.md +++ /dev/null @@ -1,845 +0,0 @@ ---- -title: TestingAppChain ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / TestingAppChain - -# Class: TestingAppChain\ - -Defined in: [sdk/src/appChain/TestingAppChain.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L58) - -AppChain acts as a wrapper connecting Runtime, Protocol and Sequencer - -## Extends - -- [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -## Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) & [`VanillaRuntimeModulesRecord`](../../library/type-aliases/VanillaRuntimeModulesRecord.md) - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) - -## Constructors - -### new TestingAppChain() - -> **new TestingAppChain**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`TestingAppChain`](TestingAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:151](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L151) - -#### Parameters - -##### definition - -[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Returns - -[`TestingAppChain`](TestingAppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`constructor`](AppChain.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AppChain`](AppChain.md).[`currentConfig`](AppChain.md#currentconfig) - -*** - -### definition - -> **definition**: [`ExpandAppChainDefinition`](../interfaces/ExpandAppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:144](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L144) - -#### Inherited from - -[`AppChain`](AppChain.md).[`definition`](AppChain.md#definition-1) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`config`](AppChain.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`AppChain`](AppChain.md).[`container`](AppChain.md#container) - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`events`](AppChain.md#events) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`AppChain`](AppChain.md).[`moduleNames`](AppChain.md#modulenames) - -*** - -### protocol - -#### Get Signature - -> **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:215](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L215) - -##### Returns - -[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`protocol`](AppChain.md#protocol) - -*** - -### query - -#### Get Signature - -> **get** **query**(): `object` - -Defined in: [sdk/src/appChain/AppChain.ts:176](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L176) - -##### Returns - -`object` - -###### network - -> **network**: [`NetworkStateQuery`](../../sequencer/classes/NetworkStateQuery.md) - -###### protocol - -> **protocol**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`ProtocolModule`](../../protocol/classes/ProtocolModule.md)\<`unknown`\>, `ProtocolModules`\> - -###### runtime - -> **runtime**: [`Query`](../../sequencer/type-aliases/Query.md)\<[`RuntimeModule`](../../module/classes/RuntimeModule.md)\<`unknown`\>, `RuntimeModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`query`](AppChain.md#query) - -*** - -### runtime - -#### Get Signature - -> **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:207](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L207) - -##### Returns - -[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`runtime`](AppChain.md#runtime-1) - -*** - -### sequencer - -#### Get Signature - -> **get** **sequencer**(): [`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:211](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L211) - -##### Returns - -[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`sequencer`](AppChain.md#sequencer) - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`AppChain`](AppChain.md).[`assertContainerInitialized`](AppChain.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf>` - -Defined in: common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf>` - -#### Inherited from - -[`AppChain`](AppChain.md).[`assertIsValidModuleName`](AppChain.md#assertisvalidmodulename) - -*** - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [sdk/src/appChain/AppChain.ts:352](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L352) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`close`](AppChain.md#close) - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`configure`](AppChain.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`configurePartial`](AppChain.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:160 - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`create`](AppChain.md#create) - -*** - -### decorateModule() - -> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:134 - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -##### containedModule - -`InstanceType`\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\]\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`decorateModule`](AppChain.md#decoratemodule) - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>[] - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`initializeDependencyFactories`](AppChain.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf>` - -Defined in: common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf>` - -#### Inherited from - -[`AppChain`](AppChain.md).[`isValidModuleName`](AppChain.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`onAfterModuleResolution`](AppChain.md#onaftermoduleresolution) - -*** - -### produceBlock() - -> **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> - -Defined in: [sdk/src/appChain/TestingAppChain.ts:137](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L137) - -#### Returns - -`Promise`\<`undefined` \| [`Block`](../../sequencer/interfaces/Block.md)\> - -*** - -### produceBlockWithResult() - -> **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> - -Defined in: [sdk/src/appChain/TestingAppChain.ts:146](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L146) - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithResult`](../../sequencer/interfaces/BlockWithResult.md)\> - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`registerAliases`](AppChain.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../../common/type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`registerClasses`](AppChain.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`registerModules`](AppChain.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`registerValue`](AppChain.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> - -Defined in: common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\>\[`KeyType`\]\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`resolve`](AppChain.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../../common/type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`AppChain`](AppChain.md).[`resolveOrFail`](AppChain.md#resolveorfail) - -*** - -### setSigner() - -> **setSigner**(`signer`): `void` - -Defined in: [sdk/src/appChain/TestingAppChain.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L132) - -#### Parameters - -##### signer - -`PrivateKey` - -#### Returns - -`void` - -*** - -### start() - -> **start**(`proofsEnabled`, `dependencyContainer`): `Promise`\<`void`\> - -Defined in: [sdk/src/appChain/AppChain.ts:309](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L309) - -Starts the appchain and cross-registers runtime to sequencer - -#### Parameters - -##### proofsEnabled - -`boolean` = `false` - -##### dependencyContainer - -`DependencyContainer` = `container` - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`start`](AppChain.md#start) - -*** - -### transaction() - -> **transaction**(`sender`, `callback`, `options`?): `Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> - -Defined in: [sdk/src/appChain/AppChain.ts:219](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L219) - -#### Parameters - -##### sender - -`PublicKey` - -##### callback - -() => `Promise`\<`void`\> - -##### options? - -###### nonce - -`number` - -#### Returns - -`Promise`\<[`AppChainTransaction`](AppChainTransaction.md)\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`transaction`](AppChain.md#transaction) - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<[`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`AppChain`](AppChain.md).[`validateModule`](AppChain.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>(`definition`): [`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:127](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L127) - -#### Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) - -#### Parameters - -##### definition - -[`AppChainDefinition`](../interfaces/AppChainDefinition.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Returns - -[`AppChain`](AppChain.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -#### Inherited from - -[`AppChain`](AppChain.md).[`from`](AppChain.md#from) - -*** - -### fromRuntime() - -> `static` **fromRuntime**\<`RuntimeModules`\>(`runtimeModules`): [`TestingAppChain`](TestingAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `FeeStrategy`: *typeof* `ConstantFeeStrategy`; `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `SequencerStartupModule`: *typeof* [`SequencerStartupModule`](../../sequencer/classes/SequencerStartupModule.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](InMemoryTransactionSender.md); \}\> - -Defined in: [sdk/src/appChain/TestingAppChain.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L70) - -#### Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) & [`PartialVanillaRuntimeModulesRecord`](../type-aliases/PartialVanillaRuntimeModulesRecord.md) - -#### Parameters - -##### runtimeModules - -`RuntimeModules` - -#### Returns - -[`TestingAppChain`](TestingAppChain.md)\<`object` & `RuntimeModules`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `FeeStrategy`: *typeof* `ConstantFeeStrategy`; `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `SequencerStartupModule`: *typeof* [`SequencerStartupModule`](../../sequencer/classes/SequencerStartupModule.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](InMemoryTransactionSender.md); \}\> diff --git a/src/pages/docs/reference/sdk/globals.md b/src/pages/docs/reference/sdk/globals.md deleted file mode 100644 index be7f37e..0000000 --- a/src/pages/docs/reference/sdk/globals.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "@proto-kit/sdk" ---- - -[**@proto-kit/sdk**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/sdk - -# @proto-kit/sdk - -## Classes - -- [AppChain](classes/AppChain.md) -- [AppChainModule](classes/AppChainModule.md) -- [AppChainTransaction](classes/AppChainTransaction.md) -- [AreProofsEnabledFactory](classes/AreProofsEnabledFactory.md) -- [AuroSigner](classes/AuroSigner.md) -- [BlockStorageNetworkStateModule](classes/BlockStorageNetworkStateModule.md) -- [ClientAppChain](classes/ClientAppChain.md) -- [GraphqlClient](classes/GraphqlClient.md) -- [GraphqlNetworkStateTransportModule](classes/GraphqlNetworkStateTransportModule.md) -- [GraphqlQueryTransportModule](classes/GraphqlQueryTransportModule.md) -- [GraphqlTransactionSender](classes/GraphqlTransactionSender.md) -- [InMemoryAreProofsEnabled](classes/InMemoryAreProofsEnabled.md) -- [InMemorySigner](classes/InMemorySigner.md) -- [InMemoryTransactionSender](classes/InMemoryTransactionSender.md) -- [SharedDependencyFactory](classes/SharedDependencyFactory.md) -- [StateServiceQueryModule](classes/StateServiceQueryModule.md) -- [TestingAppChain](classes/TestingAppChain.md) - -## Interfaces - -- [AppChainConfig](interfaces/AppChainConfig.md) -- [AppChainDefinition](interfaces/AppChainDefinition.md) -- [ExpandAppChainDefinition](interfaces/ExpandAppChainDefinition.md) -- [GraphqlClientConfig](interfaces/GraphqlClientConfig.md) -- [InMemorySignerConfig](interfaces/InMemorySignerConfig.md) -- [SharedDependencyRecord](interfaces/SharedDependencyRecord.md) -- [Signer](interfaces/Signer.md) -- [TransactionSender](interfaces/TransactionSender.md) - -## Type Aliases - -- [AppChainModulesRecord](type-aliases/AppChainModulesRecord.md) -- [ExpandAppChainModules](type-aliases/ExpandAppChainModules.md) -- [PartialVanillaRuntimeModulesRecord](type-aliases/PartialVanillaRuntimeModulesRecord.md) -- [TestingSequencerModulesRecord](type-aliases/TestingSequencerModulesRecord.md) - -## Variables - -- [randomFeeRecipient](variables/randomFeeRecipient.md) diff --git a/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md b/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md deleted file mode 100644 index ea1dbc4..0000000 --- a/src/pages/docs/reference/sdk/interfaces/AppChainConfig.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: AppChainConfig ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChainConfig - -# Interface: AppChainConfig\ - -Defined in: [sdk/src/appChain/AppChain.ts:96](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L96) - -Definition of required arguments for AppChain - -## Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) - -## Properties - -### AppChain - -> **AppChain**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:106](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L106) - -*** - -### Protocol - -> **Protocol**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`ProtocolModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:104](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L104) - -*** - -### Runtime - -> **Runtime**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`RuntimeModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:103](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L103) - -*** - -### Sequencer - -> **Sequencer**: [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`SequencerModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L105) diff --git a/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md b/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md deleted file mode 100644 index dc62fc1..0000000 --- a/src/pages/docs/reference/sdk/interfaces/AppChainDefinition.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: AppChainDefinition ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChainDefinition - -# Interface: AppChainDefinition\ - -Defined in: [sdk/src/appChain/AppChain.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L53) - -## Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) - -## Properties - -### modules - -> **modules**: `AppChainModules` - -Defined in: [sdk/src/appChain/AppChain.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L63) - -*** - -### Protocol - -> **Protocol**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\>\> - -Defined in: [sdk/src/appChain/AppChain.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L61) - -*** - -### Runtime - -> **Runtime**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\>\> - -Defined in: [sdk/src/appChain/AppChain.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L60) - -*** - -### Sequencer - -> **Sequencer**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\>\> - -Defined in: [sdk/src/appChain/AppChain.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L62) diff --git a/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md b/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md deleted file mode 100644 index a97f219..0000000 --- a/src/pages/docs/reference/sdk/interfaces/ExpandAppChainDefinition.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: ExpandAppChainDefinition ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / ExpandAppChainDefinition - -# Interface: ExpandAppChainDefinition\ - -Defined in: [sdk/src/appChain/AppChain.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L78) - -## Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -• **AppChainModules** *extends* [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md) - -## Properties - -### modules - -> **modules**: [`ExpandAppChainModules`](../type-aliases/ExpandAppChainModules.md)\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\> - -Defined in: [sdk/src/appChain/AppChain.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L85) diff --git a/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md b/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md deleted file mode 100644 index 14cca98..0000000 --- a/src/pages/docs/reference/sdk/interfaces/GraphqlClientConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: GraphqlClientConfig ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / GraphqlClientConfig - -# Interface: GraphqlClientConfig - -Defined in: [sdk/src/graphql/GraphqlClient.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlClient.ts#L5) - -## Properties - -### url - -> **url**: `string` - -Defined in: [sdk/src/graphql/GraphqlClient.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/graphql/GraphqlClient.ts#L6) diff --git a/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md b/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md deleted file mode 100644 index ca46bb1..0000000 --- a/src/pages/docs/reference/sdk/interfaces/InMemorySignerConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: InMemorySignerConfig ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / InMemorySignerConfig - -# Interface: InMemorySignerConfig - -Defined in: [sdk/src/transaction/InMemorySigner.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L10) - -## Properties - -### signer - -> **signer**: `PrivateKey` - -Defined in: [sdk/src/transaction/InMemorySigner.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L11) diff --git a/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md b/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md deleted file mode 100644 index f0728ce..0000000 --- a/src/pages/docs/reference/sdk/interfaces/SharedDependencyRecord.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: SharedDependencyRecord ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / SharedDependencyRecord - -# Interface: SharedDependencyRecord - -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/SharedDependencyFactory.ts#L9) - -## Extends - -- [`DependencyRecord`](../../common/type-aliases/DependencyRecord.md) - -## Indexable - -\[`key`: `string`\]: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<`unknown`\> & `object` - -## Properties - -### methodIdResolver - -> **methodIdResolver**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`MethodIdResolver`](../../module/classes/MethodIdResolver.md)\> - -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/SharedDependencyFactory.ts#L11) - -*** - -### stateServiceProvider - -> **stateServiceProvider**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md)\> - -Defined in: [sdk/src/appChain/SharedDependencyFactory.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/SharedDependencyFactory.ts#L10) diff --git a/src/pages/docs/reference/sdk/interfaces/Signer.md b/src/pages/docs/reference/sdk/interfaces/Signer.md deleted file mode 100644 index c3384e0..0000000 --- a/src/pages/docs/reference/sdk/interfaces/Signer.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Signer ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / Signer - -# Interface: Signer - -Defined in: [sdk/src/transaction/InMemorySigner.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L6) - -## Properties - -### sign() - -> **sign**: (`signatureData`) => `Promise`\<`Signature`\> - -Defined in: [sdk/src/transaction/InMemorySigner.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemorySigner.ts#L7) - -#### Parameters - -##### signatureData - -`Field`[] - -#### Returns - -`Promise`\<`Signature`\> diff --git a/src/pages/docs/reference/sdk/interfaces/TransactionSender.md b/src/pages/docs/reference/sdk/interfaces/TransactionSender.md deleted file mode 100644 index ccf4f0b..0000000 --- a/src/pages/docs/reference/sdk/interfaces/TransactionSender.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: TransactionSender ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / TransactionSender - -# Interface: TransactionSender - -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L11) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`AppChainModule`](../classes/AppChainModule.md)\<`unknown`\> - -## Properties - -### appChain? - -> `optional` **appChain**: [`AppChain`](../classes/AppChain.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md), [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md), [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md), [`AppChainModulesRecord`](../type-aliases/AppChainModulesRecord.md)\> - -Defined in: [sdk/src/appChain/AppChainModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChainModule.ts#L18) - -#### Inherited from - -[`AppChainModule`](../classes/AppChainModule.md).[`appChain`](../classes/AppChainModule.md#appchain) - -*** - -### currentConfig - -> `protected` **currentConfig**: `unknown` - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AppChainModule`](../classes/AppChainModule.md).[`currentConfig`](../classes/AppChainModule.md#currentconfig) - -*** - -### send() - -> **send**: (`transaction`) => `Promise`\<`void`\> - -Defined in: [sdk/src/transaction/InMemoryTransactionSender.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/transaction/InMemoryTransactionSender.ts#L12) - -#### Parameters - -##### transaction - -[`PendingTransaction`](../../sequencer/classes/PendingTransaction.md) - -#### Returns - -`Promise`\<`void`\> - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](../classes/AppChainModule.md).[`config`](../classes/AppChainModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AppChainModule`](../classes/AppChainModule.md).[`create`](../classes/AppChainModule.md#create) diff --git a/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md deleted file mode 100644 index 0b98225..0000000 --- a/src/pages/docs/reference/sdk/type-aliases/AppChainModulesRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: AppChainModulesRecord ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / AppChainModulesRecord - -# Type Alias: AppChainModulesRecord - -> **AppChainModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`AppChainModule`](../classes/AppChainModule.md)\<`unknown`\>\>\> - -Defined in: [sdk/src/appChain/AppChain.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L49) diff --git a/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md b/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md deleted file mode 100644 index f3b9124..0000000 --- a/src/pages/docs/reference/sdk/type-aliases/ExpandAppChainModules.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: ExpandAppChainModules ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / ExpandAppChainModules - -# Type Alias: ExpandAppChainModules\ - -> **ExpandAppChainModules**\<`RuntimeModules`, `ProtocolModules`, `SequencerModules`, `AppChainModules`\>: `AppChainModules` & `object` - -Defined in: [sdk/src/appChain/AppChain.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/AppChain.ts#L66) - -## Type declaration - -### Protocol - -> **Protocol**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\>\> - -### Runtime - -> **Runtime**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\>\> - -### Sequencer - -> **Sequencer**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`Sequencer`](../../sequencer/classes/Sequencer.md)\<`SequencerModules`\>\> - -## Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -• **ProtocolModules** *extends* [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) & [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) - -• **SequencerModules** *extends* [`SequencerModulesRecord`](../../sequencer/type-aliases/SequencerModulesRecord.md) - -• **AppChainModules** *extends* [`AppChainModulesRecord`](AppChainModulesRecord.md) diff --git a/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md deleted file mode 100644 index bb59fb3..0000000 --- a/src/pages/docs/reference/sdk/type-aliases/PartialVanillaRuntimeModulesRecord.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: PartialVanillaRuntimeModulesRecord ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / PartialVanillaRuntimeModulesRecord - -# Type Alias: PartialVanillaRuntimeModulesRecord - -> **PartialVanillaRuntimeModulesRecord**: `object` - -Defined in: [sdk/src/appChain/TestingAppChain.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L52) - -## Type declaration - -### Balances? - -> `optional` **Balances**: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`MinimalBalances`](../../library/type-aliases/MinimalBalances.md)\> diff --git a/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md b/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md deleted file mode 100644 index fd954f4..0000000 --- a/src/pages/docs/reference/sdk/type-aliases/TestingSequencerModulesRecord.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: TestingSequencerModulesRecord ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / TestingSequencerModulesRecord - -# Type Alias: TestingSequencerModulesRecord - -> **TestingSequencerModulesRecord**: `object` - -Defined in: [sdk/src/appChain/TestingAppChain.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L37) - -## Type declaration - -### BaseLayer - -> **BaseLayer**: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md) - -### BatchProducerModule - -> **BatchProducerModule**: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md) - -### BlockProducerModule - -> **BlockProducerModule**: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md) - -### BlockTrigger - -> **BlockTrigger**: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md) - -### Database - -> **Database**: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md) - -### LocalTaskWorkerModule - -> **LocalTaskWorkerModule**: *typeof* [`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md) - -### Mempool - -> **Mempool**: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md) - -### TaskQueue - -> **TaskQueue**: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md) diff --git a/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md b/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md deleted file mode 100644 index 7e17dff..0000000 --- a/src/pages/docs/reference/sdk/variables/randomFeeRecipient.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: randomFeeRecipient ---- - -[**@proto-kit/sdk**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sdk](../README.md) / randomFeeRecipient - -# Variable: randomFeeRecipient - -> `const` **randomFeeRecipient**: `string` - -Defined in: [sdk/src/appChain/TestingAppChain.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sdk/src/appChain/TestingAppChain.ts#L56) diff --git a/src/pages/docs/reference/sequencer/README.md b/src/pages/docs/reference/sequencer/README.md deleted file mode 100644 index a871b11..0000000 --- a/src/pages/docs/reference/sequencer/README.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "@proto-kit/sequencer" ---- - -**@proto-kit/sequencer** - -*** - -[Documentation](../../README.md) / @proto-kit/sequencer - -# YAB: Sequencer - -This package includes everything that is required to run a sequencer - -## Sequencer - -A Sequencer is structure similar to a Runtime. -It is given a list of SequencerModules, that are then dynamically instantiated and resolved by the Sequencer. -When calling `.start()` on a sequencer, the sequencer starts up all the modules and exposes the services provided by them. - -### Sequencer modules - -A Sequencer module is an abstract class that needs to be extended by any concrete sequencer module implementation(s). - -```typescript -export abstract class SequencerModule< - Config -> extends ConfigurableModule { - public abstract start(): Promise; - - // more properties -} -``` - -The generic type parameter `Config` refers to the configuration object a module consumes. -More on that below. - -The `start()` method is called by the sequencer when it gets started. -It returns a Promise that has to resolve after initialization, since it will block in the sequencer startup. -That means that you mustn't `await server.start()` for example. diff --git a/src/pages/docs/reference/sequencer/_meta.tsx b/src/pages/docs/reference/sequencer/_meta.tsx deleted file mode 100644 index 4d63940..0000000 --- a/src/pages/docs/reference/sequencer/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals","interfaces": "Interfaces","type-aliases": "Type Aliases","variables": "Variables" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md b/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md deleted file mode 100644 index 22e17d2..0000000 --- a/src/pages/docs/reference/sequencer/classes/AbstractTaskQueue.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -title: AbstractTaskQueue ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / AbstractTaskQueue - -# Class: `abstract` AbstractTaskQueue\ - -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L5) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](SequencerModule.md)\<`Config`\> - -## Extended by - -- [`LocalTaskQueue`](LocalTaskQueue.md) -- [`BullQueue`](../../deployment/classes/BullQueue.md) - -## Type Parameters - -• **Config** - -## Constructors - -### new AbstractTaskQueue() - -> **new AbstractTaskQueue**\<`Config`\>(): [`AbstractTaskQueue`](AbstractTaskQueue.md)\<`Config`\> - -#### Returns - -[`AbstractTaskQueue`](AbstractTaskQueue.md)\<`Config`\> - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### queues - -> `protected` **queues**: `Record`\<`string`, [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> = `{}` - -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### closeQueues() - -> `protected` **closeQueues**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) - -#### Returns - -`Promise`\<`void`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### createOrGetQueue() - -> `protected` **createOrGetQueue**(`name`, `creator`): [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) - -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) - -#### Parameters - -##### name - -`string` - -##### creator - -(`name`) => [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) - -#### Returns - -[`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) - -*** - -### start() - -> `abstract` **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md b/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md deleted file mode 100644 index dfa4362..0000000 --- a/src/pages/docs/reference/sequencer/classes/ArtifactRecordSerializer.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: ArtifactRecordSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ArtifactRecordSerializer - -# Class: ArtifactRecordSerializer - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L10) - -## Constructors - -### new ArtifactRecordSerializer() - -> **new ArtifactRecordSerializer**(): [`ArtifactRecordSerializer`](ArtifactRecordSerializer.md) - -#### Returns - -[`ArtifactRecordSerializer`](ArtifactRecordSerializer.md) - -## Methods - -### fromJSON() - -> **fromJSON**(`json`): [`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L27) - -#### Parameters - -##### json - -[`SerializedArtifactRecord`](../type-aliases/SerializedArtifactRecord.md) - -#### Returns - -[`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md) - -*** - -### toJSON() - -> **toJSON**(`input`): [`SerializedArtifactRecord`](../type-aliases/SerializedArtifactRecord.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L11) - -#### Parameters - -##### input - -[`ArtifactRecord`](../../common/type-aliases/ArtifactRecord.md) - -#### Returns - -[`SerializedArtifactRecord`](../type-aliases/SerializedArtifactRecord.md) diff --git a/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md b/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md deleted file mode 100644 index 2de6a97..0000000 --- a/src/pages/docs/reference/sequencer/classes/BatchProducerModule.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -title: BatchProducerModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BatchProducerModule - -# Class: BatchProducerModule - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L74) - -The BatchProducerModule has the resposiblity to oversee the block production -and combine all necessary parts for that to happen. The flow roughly follows -the following steps: - -1. BlockTrigger triggers and executes the startup function -2. - -## Extends - -- [`SequencerModule`](SequencerModule.md) - -## Constructors - -### new BatchProducerModule() - -> **new BatchProducerModule**(`asyncStateService`, `merkleStore`, `batchStorage`, `blockTreeStore`, `database`, `traceService`, `blockFlowService`, `blockProofSerializer`, `verificationKeyService`): [`BatchProducerModule`](BatchProducerModule.md) - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:77](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L77) - -#### Parameters - -##### asyncStateService - -[`AsyncStateService`](../interfaces/AsyncStateService.md) - -##### merkleStore - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) - -##### batchStorage - -[`BatchStorage`](../interfaces/BatchStorage.md) - -##### blockTreeStore - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) - -##### database - -[`Database`](../interfaces/Database.md) - -##### traceService - -[`TransactionTraceService`](TransactionTraceService.md) - -##### blockFlowService - -[`BlockTaskFlowService`](BlockTaskFlowService.md) - -##### blockProofSerializer - -[`BlockProofSerializer`](BlockProofSerializer.md) - -##### verificationKeyService - -`VerificationKeyService` - -#### Returns - -[`BatchProducerModule`](BatchProducerModule.md) - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### createBatch() - -> **createBatch**(`blocks`): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L108) - -Main function to call when wanting to create a new block based on the -transactions that are present in the mempool. This function should also -be the one called by BlockTriggers - -#### Parameters - -##### blocks - -[`BlockWithPreviousResult`](../interfaces/BlockWithPreviousResult.md)[] - -#### Returns - -`Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L132) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md b/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md deleted file mode 100644 index 7bea9d1..0000000 --- a/src/pages/docs/reference/sequencer/classes/BlockProducerModule.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -title: BlockProducerModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockProducerModule - -# Class: BlockProducerModule - -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L39) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](SequencerModule.md)\<[`BlockConfig`](../interfaces/BlockConfig.md)\> - -## Constructors - -### new BlockProducerModule() - -> **new BlockProducerModule**(`mempool`, `messageStorage`, `unprovenStateService`, `unprovenMerkleStore`, `blockQueue`, `blockTreeStore`, `productionService`, `resultService`, `methodIdResolver`, `runtime`, `database`): [`BlockProducerModule`](BlockProducerModule.md) - -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L42) - -#### Parameters - -##### mempool - -[`Mempool`](../interfaces/Mempool.md) - -##### messageStorage - -[`MessageStorage`](../interfaces/MessageStorage.md) - -##### unprovenStateService - -[`AsyncStateService`](../interfaces/AsyncStateService.md) - -##### unprovenMerkleStore - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) - -##### blockQueue - -[`BlockQueue`](../interfaces/BlockQueue.md) - -##### blockTreeStore - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) - -##### productionService - -`BlockProductionService` - -##### resultService - -`BlockResultService` - -##### methodIdResolver - -[`MethodIdResolver`](../../module/classes/MethodIdResolver.md) - -##### runtime - -[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> - -##### database - -[`Database`](../interfaces/Database.md) - -#### Returns - -[`BlockProducerModule`](BlockProducerModule.md) - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`BlockConfig`](../interfaces/BlockConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### blockResultCompleteCheck() - -> **blockResultCompleteCheck**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:236](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L236) - -#### Returns - -`Promise`\<`void`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### generateMetadata() - -> **generateMetadata**(`block`): `Promise`\<[`BlockResult`](../interfaces/BlockResult.md)\> - -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:110](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L110) - -#### Parameters - -##### block - -[`Block`](../interfaces/Block.md) - -#### Returns - -`Promise`\<[`BlockResult`](../interfaces/BlockResult.md)\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:251](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L251) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) - -*** - -### tryProduceBlock() - -> **tryProduceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:128](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L128) - -#### Returns - -`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> diff --git a/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md b/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md deleted file mode 100644 index 7636eee..0000000 --- a/src/pages/docs/reference/sequencer/classes/BlockProofSerializer.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: BlockProofSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockProofSerializer - -# Class: BlockProofSerializer - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L13) - -## Constructors - -### new BlockProofSerializer() - -> **new BlockProofSerializer**(`protocol`): [`BlockProofSerializer`](BlockProofSerializer.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L19) - -#### Parameters - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> - -#### Returns - -[`BlockProofSerializer`](BlockProofSerializer.md) - -## Methods - -### getBlockProofSerializer() - -> **getBlockProofSerializer**(): [`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../../protocol/classes/BlockProverPublicOutput.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/BlockProofSerializer.ts#L24) - -#### Returns - -[`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../../protocol/classes/BlockProverPublicOutput.md)\> diff --git a/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md b/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md deleted file mode 100644 index bc128e8..0000000 --- a/src/pages/docs/reference/sequencer/classes/BlockTaskFlowService.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: BlockTaskFlowService ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockTaskFlowService - -# Class: BlockTaskFlowService - -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L56) - -We could rename this into BlockCreationStrategy and enable the injection of -different creation strategies. - -## Constructors - -### new BlockTaskFlowService() - -> **new BlockTaskFlowService**(`taskQueue`, `flowCreator`, `stateTransitionTask`, `stateTransitionReductionTask`, `runtimeProvingTask`, `transactionProvingTask`, `blockProvingTask`, `blockReductionTask`, `protocol`): [`BlockTaskFlowService`](BlockTaskFlowService.md) - -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L57) - -#### Parameters - -##### taskQueue - -[`TaskQueue`](../interfaces/TaskQueue.md) - -##### flowCreator - -[`FlowCreator`](FlowCreator.md) - -##### stateTransitionTask - -[`StateTransitionTask`](StateTransitionTask.md) - -##### stateTransitionReductionTask - -[`StateTransitionReductionTask`](StateTransitionReductionTask.md) - -##### runtimeProvingTask - -[`RuntimeProvingTask`](RuntimeProvingTask.md) - -##### transactionProvingTask - -[`TransactionProvingTask`](TransactionProvingTask.md) - -##### blockProvingTask - -[`NewBlockTask`](NewBlockTask.md) - -##### blockReductionTask - -`BlockReductionTask` - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> - -#### Returns - -[`BlockTaskFlowService`](BlockTaskFlowService.md) - -## Methods - -### executeFlow() - -> **executeFlow**(`blockTraces`, `batchId`): `Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> - -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:142](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L142) - -#### Parameters - -##### blockTraces - -[`BlockTrace`](../interfaces/BlockTrace.md)[] - -##### batchId - -`number` - -#### Returns - -`Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> - -*** - -### pushBlockPairing() - -> **pushBlockPairing**(`flow`, `blockReductionTask`, `index`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:93](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L93) - -#### Parameters - -##### flow - -[`Flow`](Flow.md)\<`BlockProductionFlowState`\> - -##### blockReductionTask - -[`ReductionTaskFlow`](ReductionTaskFlow.md)\<[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md), [`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> - -##### index - -`number` - -#### Returns - -`Promise`\<`void`\> - -*** - -### pushPairing() - -> **pushPairing**(`flow`, `transactionReductionTask`, `blockIndex`, `transactionIndex`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/BlockTaskFlowService.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BlockTaskFlowService.ts#L70) - -#### Parameters - -##### flow - -[`Flow`](Flow.md)\<`BlockProductionFlowState`\> - -##### transactionReductionTask - -[`ReductionTaskFlow`](ReductionTaskFlow.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md), [`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> - -##### blockIndex - -`number` - -##### transactionIndex - -`number` - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md b/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md deleted file mode 100644 index df2b6a2..0000000 --- a/src/pages/docs/reference/sequencer/classes/BlockTriggerBase.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -title: BlockTriggerBase ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockTriggerBase - -# Class: BlockTriggerBase\ - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L35) - -A BlockTrigger is the primary method to start the production of a block and -all associated processes. - -## Extends - -- [`SequencerModule`](SequencerModule.md)\<`Config`\> - -## Extended by - -- [`ManualBlockTrigger`](ManualBlockTrigger.md) -- [`TimedBlockTrigger`](TimedBlockTrigger.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -• **Events** *extends* [`BlockEvents`](../type-aliases/BlockEvents.md) = [`BlockEvents`](../type-aliases/BlockEvents.md) - -## Implements - -- [`BlockTrigger`](../interfaces/BlockTrigger.md) -- [`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md)\<`Events`\> - -## Constructors - -### new BlockTriggerBase() - -> **new BlockTriggerBase**\<`Config`, `Events`\>(`blockProducerModule`, `batchProducerModule`, `settlementModule`, `blockQueue`, `batchQueue`, `settlementStorage`): [`BlockTriggerBase`](BlockTriggerBase.md)\<`Config`, `Events`\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L44) - -#### Parameters - -##### blockProducerModule - -[`BlockProducerModule`](BlockProducerModule.md) - -##### batchProducerModule - -`undefined` | [`BatchProducerModule`](BatchProducerModule.md) - -##### settlementModule - -`undefined` | [`SettlementModule`](SettlementModule.md) - -##### blockQueue - -[`BlockQueue`](../interfaces/BlockQueue.md) - -##### batchQueue - -[`BatchStorage`](../interfaces/BatchStorage.md) - -##### settlementStorage - -`undefined` | [`SettlementStorage`](../interfaces/SettlementStorage.md) - -#### Returns - -[`BlockTriggerBase`](BlockTriggerBase.md)\<`Config`, `Events`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### batchProducerModule - -> `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) - -*** - -### batchQueue - -> `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) - -*** - -### blockProducerModule - -> `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) - -*** - -### blockQueue - -> `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### events - -> `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<`Events`\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) - -#### Implementation of - -[`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md).[`events`](../../common/interfaces/EventEmittingComponent.md#events) - -*** - -### settlementModule - -> `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) - -*** - -### settlementStorage - -> `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### produceBatch() - -> `protected` **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) - -#### Returns - -`Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> - -*** - -### produceBlock() - -> `protected` **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) - -#### Returns - -`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -*** - -### produceBlockWithResult() - -> `protected` **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> - -*** - -### settle() - -> `protected` **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) - -#### Parameters - -##### batch - -[`SettleableBatch`](../interfaces/SettleableBatch.md) - -#### Returns - -`Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md deleted file mode 100644 index 988a8c4..0000000 --- a/src/pages/docs/reference/sequencer/classes/CachedMerkleTreeStore.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -title: CachedMerkleTreeStore ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / CachedMerkleTreeStore - -# Class: CachedMerkleTreeStore - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L14) - -## Extends - -- [`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md) - -## Implements - -- [`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) - -## Constructors - -### new CachedMerkleTreeStore() - -> **new CachedMerkleTreeStore**(`parent`): [`CachedMerkleTreeStore`](CachedMerkleTreeStore.md) - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L32) - -#### Parameters - -##### parent - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) - -#### Returns - -[`CachedMerkleTreeStore`](CachedMerkleTreeStore.md) - -#### Overrides - -[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`constructor`](../../common/classes/InMemoryMerkleTreeStorage.md#constructors) - -## Properties - -### nodes - -> `protected` **nodes**: `object` - -Defined in: packages/common/dist/trees/InMemoryMerkleTreeStorage.d.ts:3 - -#### Index Signature - -\[`key`: `number`\]: `object` - -#### Inherited from - -[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`nodes`](../../common/classes/InMemoryMerkleTreeStorage.md#nodes) - -## Methods - -### commit() - -> **commit**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L28) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`commit`](../interfaces/AsyncMerkleTreeStore.md#commit) - -*** - -### getNode() - -> **getNode**(`key`, `level`): `undefined` \| `bigint` - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L36) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -#### Returns - -`undefined` \| `bigint` - -#### Overrides - -[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`getNode`](../../common/classes/InMemoryMerkleTreeStorage.md#getnode) - -*** - -### getNodesAsync() - -> **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:148](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L148) - -#### Parameters - -##### nodes - -[`MerkleTreeNodeQuery`](../interfaces/MerkleTreeNodeQuery.md)[] - -#### Returns - -`Promise`\<(`undefined` \| `bigint`)[]\> - -#### Implementation of - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`getNodesAsync`](../interfaces/AsyncMerkleTreeStore.md#getnodesasync) - -*** - -### getWrittenNodes() - -> **getWrittenNodes**(): `object` - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L45) - -#### Returns - -`object` - -*** - -### mergeIntoParent() - -> **mergeIntoParent**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L112) - -#### Returns - -`Promise`\<`void`\> - -*** - -### openTransaction() - -> **openTransaction**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L24) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`openTransaction`](../interfaces/AsyncMerkleTreeStore.md#opentransaction) - -*** - -### preloadKey() - -> **preloadKey**(`index`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L108) - -#### Parameters - -##### index - -`bigint` - -#### Returns - -`Promise`\<`void`\> - -*** - -### preloadKeys() - -> **preloadKeys**(`keys`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L94) - -#### Parameters - -##### keys - -`bigint`[] - -#### Returns - -`Promise`\<`void`\> - -*** - -### resetWrittenNodes() - -> **resetWrittenNodes**(): `void` - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L53) - -#### Returns - -`void` - -*** - -### setNode() - -> **setNode**(`key`, `level`, `value`): `void` - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L40) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -##### value - -`bigint` - -#### Returns - -`void` - -#### Overrides - -[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`setNode`](../../common/classes/InMemoryMerkleTreeStorage.md#setnode) - -*** - -### setNodeAsync() - -> **setNodeAsync**(`key`, `level`, `value`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:140](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L140) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -##### value - -`bigint` - -#### Returns - -`Promise`\<`void`\> - -*** - -### writeNodes() - -> **writeNodes**(`nodes`): `void` - -Defined in: [packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts:176](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/CachedMerkleTreeStore.ts#L176) - -#### Parameters - -##### nodes - -[`MerkleTreeNode`](../interfaces/MerkleTreeNode.md)[] - -#### Returns - -`void` - -#### Implementation of - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`writeNodes`](../interfaces/AsyncMerkleTreeStore.md#writenodes) diff --git a/src/pages/docs/reference/sequencer/classes/CachedStateService.md b/src/pages/docs/reference/sequencer/classes/CachedStateService.md deleted file mode 100644 index 4f82f7b..0000000 --- a/src/pages/docs/reference/sequencer/classes/CachedStateService.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -title: CachedStateService ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / CachedStateService - -# Class: CachedStateService - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L12) - -This Interface should be implemented for services that store the state -in an external storage (like a DB). This can be used in conjunction with -CachedStateService to preload keys for In-Circuit usage. - -## Extends - -- [`InMemoryStateService`](../../module/classes/InMemoryStateService.md) - -## Implements - -- [`AsyncStateService`](../interfaces/AsyncStateService.md) -- [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) - -## Constructors - -### new CachedStateService() - -> **new CachedStateService**(`parent`): [`CachedStateService`](CachedStateService.md) - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L18) - -#### Parameters - -##### parent - -`undefined` | [`AsyncStateService`](../interfaces/AsyncStateService.md) - -#### Returns - -[`CachedStateService`](CachedStateService.md) - -#### Overrides - -[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`constructor`](../../module/classes/InMemoryStateService.md#constructors) - -## Properties - -### values - -> **values**: `Record`\<`string`, `null` \| `Field`[]\> - -Defined in: packages/module/dist/state/InMemoryStateService.d.ts:11 - -This mapping container null values if the specific entry has been deleted. -This is used by the CachedState service to keep track of deletions - -#### Inherited from - -[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`values`](../../module/classes/InMemoryStateService.md#values) - -## Methods - -### applyStateTransitions() - -> **applyStateTransitions**(`stateTransitions`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:99](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L99) - -#### Parameters - -##### stateTransitions - -[`StateTransition`](../../protocol/classes/StateTransition.md)\<`any`\>[] - -#### Returns - -`Promise`\<`void`\> - -*** - -### commit() - -> **commit**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L42) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`AsyncStateService`](../interfaces/AsyncStateService.md).[`commit`](../interfaces/AsyncStateService.md#commit) - -*** - -### get() - -> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:94](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L94) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| `Field`[]\> - -#### Implementation of - -[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`get`](../../protocol/interfaces/SimpleAsyncStateService.md#get) - -#### Overrides - -[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`get`](../../module/classes/InMemoryStateService.md#get) - -*** - -### getMany() - -> **getMany**(`keys`): `Promise`\<[`StateEntry`](../interfaces/StateEntry.md)[]\> - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L75) - -#### Parameters - -##### keys - -`Field`[] - -#### Returns - -`Promise`\<[`StateEntry`](../interfaces/StateEntry.md)[]\> - -#### Implementation of - -[`AsyncStateService`](../interfaces/AsyncStateService.md).[`getMany`](../interfaces/AsyncStateService.md#getmany) - -*** - -### mergeIntoParent() - -> **mergeIntoParent**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:118](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L118) - -Merges all caches set() operation into the parent and -resets this instance to the parent's state (by clearing the cache and -defaulting to the parent) - -#### Returns - -`Promise`\<`void`\> - -*** - -### openTransaction() - -> **openTransaction**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L48) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`AsyncStateService`](../interfaces/AsyncStateService.md).[`openTransaction`](../interfaces/AsyncStateService.md#opentransaction) - -*** - -### preloadKey() - -> **preloadKey**(`key`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L52) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`void`\> - -*** - -### preloadKeys() - -> **preloadKeys**(`keys`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L56) - -#### Parameters - -##### keys - -`Field`[] - -#### Returns - -`Promise`\<`void`\> - -*** - -### set() - -> **set**(`key`, `value`): `Promise`\<`void`\> - -Defined in: packages/module/dist/state/InMemoryStateService.d.ts:13 - -#### Parameters - -##### key - -`Field` - -##### value - -`undefined` | `Field`[] - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`set`](../../protocol/interfaces/SimpleAsyncStateService.md#set) - -#### Inherited from - -[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`set`](../../module/classes/InMemoryStateService.md#set) - -*** - -### writeStates() - -> **writeStates**(`entries`): `void` - -Defined in: [packages/sequencer/src/state/state/CachedStateService.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/CachedStateService.ts#L38) - -#### Parameters - -##### entries - -[`StateEntry`](../interfaces/StateEntry.md)[] - -#### Returns - -`void` - -#### Implementation of - -[`AsyncStateService`](../interfaces/AsyncStateService.md).[`writeStates`](../interfaces/AsyncStateService.md#writestates) diff --git a/src/pages/docs/reference/sequencer/classes/CompressedSignature.md b/src/pages/docs/reference/sequencer/classes/CompressedSignature.md deleted file mode 100644 index a47a2ff..0000000 --- a/src/pages/docs/reference/sequencer/classes/CompressedSignature.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: CompressedSignature ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / CompressedSignature - -# Class: CompressedSignature - -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L8) - -CompressedSignature compresses the s scalar of a Signature -(which is expanded to 256 Fields in snarkyjs) to a single string - -## Constructors - -### new CompressedSignature() - -> **new CompressedSignature**(`r`, `s`): [`CompressedSignature`](CompressedSignature.md) - -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L15) - -#### Parameters - -##### r - -`Field` - -##### s - -`string` - -#### Returns - -[`CompressedSignature`](CompressedSignature.md) - -## Properties - -### r - -> `readonly` **r**: `Field` - -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L16) - -*** - -### s - -> `readonly` **s**: `string` - -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L17) - -## Methods - -### toSignature() - -> **toSignature**(): `Signature` - -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L21) - -#### Returns - -`Signature` - -*** - -### fromSignature() - -> `static` **fromSignature**(`sig`): [`CompressedSignature`](CompressedSignature.md) - -Defined in: [packages/sequencer/src/mempool/CompressedSignature.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/CompressedSignature.ts#L10) - -#### Parameters - -##### sig - -`Signature` - -#### Returns - -[`CompressedSignature`](CompressedSignature.md) diff --git a/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md b/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md deleted file mode 100644 index 5fcb8b3..0000000 --- a/src/pages/docs/reference/sequencer/classes/DatabasePruneModule.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: DatabasePruneModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / DatabasePruneModule - -# Class: DatabasePruneModule - -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/DatabasePruneModule.ts#L16) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](SequencerModule.md)\<[`DatabasePruneConfig`](../type-aliases/DatabasePruneConfig.md)\> - -## Constructors - -### new DatabasePruneModule() - -> **new DatabasePruneModule**(`database`): [`DatabasePruneModule`](DatabasePruneModule.md) - -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/DatabasePruneModule.ts#L17) - -#### Parameters - -##### database - -[`Database`](../interfaces/Database.md) - -#### Returns - -[`DatabasePruneModule`](DatabasePruneModule.md) - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`DatabasePruneConfig`](../type-aliases/DatabasePruneConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/DatabasePruneModule.ts#L21) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md b/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md deleted file mode 100644 index 7a6b843..0000000 --- a/src/pages/docs/reference/sequencer/classes/DecodedStateSerializer.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: DecodedStateSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / DecodedStateSerializer - -# Class: DecodedStateSerializer - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L6) - -## Constructors - -### new DecodedStateSerializer() - -> **new DecodedStateSerializer**(): [`DecodedStateSerializer`](DecodedStateSerializer.md) - -#### Returns - -[`DecodedStateSerializer`](DecodedStateSerializer.md) - -## Methods - -### fromJSON() - -> `static` **fromJSON**(`json`): [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L7) - -#### Parameters - -##### json - -[`JSONEncodableState`](../type-aliases/JSONEncodableState.md) - -#### Returns - -[`TaskStateRecord`](../type-aliases/TaskStateRecord.md) - -*** - -### toJSON() - -> `static` **toJSON**(`input`): [`JSONEncodableState`](../type-aliases/JSONEncodableState.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/DecodedStateSerializer.ts#L16) - -#### Parameters - -##### input - -[`TaskStateRecord`](../type-aliases/TaskStateRecord.md) - -#### Returns - -[`JSONEncodableState`](../type-aliases/JSONEncodableState.md) diff --git a/src/pages/docs/reference/sequencer/classes/DummyStateService.md b/src/pages/docs/reference/sequencer/classes/DummyStateService.md deleted file mode 100644 index 65236f8..0000000 --- a/src/pages/docs/reference/sequencer/classes/DummyStateService.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: DummyStateService ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / DummyStateService - -# Class: DummyStateService - -Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/DummyStateService.ts#L5) - -## Implements - -- [`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md) - -## Constructors - -### new DummyStateService() - -> **new DummyStateService**(): [`DummyStateService`](DummyStateService.md) - -#### Returns - -[`DummyStateService`](DummyStateService.md) - -## Methods - -### get() - -> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> - -Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/DummyStateService.ts#L6) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| `Field`[]\> - -#### Implementation of - -[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`get`](../../protocol/interfaces/SimpleAsyncStateService.md#get) - -*** - -### set() - -> **set**(`key`, `value`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/state/DummyStateService.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/state/DummyStateService.ts#L10) - -#### Parameters - -##### key - -`Field` - -##### value - -`undefined` | `Field`[] - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`SimpleAsyncStateService`](../../protocol/interfaces/SimpleAsyncStateService.md).[`set`](../../protocol/interfaces/SimpleAsyncStateService.md#set) diff --git a/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md deleted file mode 100644 index 86fe7a9..0000000 --- a/src/pages/docs/reference/sequencer/classes/DynamicProofTaskSerializer.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -title: DynamicProofTaskSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / DynamicProofTaskSerializer - -# Class: DynamicProofTaskSerializer\ - -Defined in: [packages/sequencer/src/helpers/utils.ts:130](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L130) - -## Extends - -- `ProofTaskSerializerBase`\<`PublicInputType`, `PublicOutputType`\> - -## Type Parameters - -• **PublicInputType** - -• **PublicOutputType** - -## Implements - -- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> - -## Constructors - -### new DynamicProofTaskSerializer() - -> **new DynamicProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`DynamicProofTaskSerializer`](DynamicProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> - -Defined in: [packages/sequencer/src/helpers/utils.ts:134](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L134) - -#### Parameters - -##### proofClass - -[`Subclass`](../../protocol/type-aliases/Subclass.md)\<*typeof* `DynamicProof`\> - -#### Returns - -[`DynamicProofTaskSerializer`](DynamicProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> - -#### Overrides - -`ProofTaskSerializerBase.constructor` - -## Methods - -### fromJSON() - -> **fromJSON**(`json`): `Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> - -Defined in: [packages/sequencer/src/helpers/utils.ts:142](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L142) - -#### Parameters - -##### json - -`string` - -#### Returns - -`Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) - -*** - -### fromJSONProof() - -> **fromJSONProof**(`jsonProof`): `Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> - -Defined in: [packages/sequencer/src/helpers/utils.ts:149](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L149) - -#### Parameters - -##### jsonProof - -`JsonProof` - -#### Returns - -`Promise`\<`DynamicProof`\<`PublicInputType`, `PublicOutputType`\>\> - -*** - -### getDummy() - -> `protected` **getDummy**\<`T`\>(`c`, `jsonProof`): `T` - -Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L41) - -#### Type Parameters - -• **T** *extends* `DynamicProof`\<`PublicInputType`, `PublicOutputType`\> \| `Proof`\<`PublicInputType`, `PublicOutputType`\> - -#### Parameters - -##### c - -[`TypedClass`](../type-aliases/TypedClass.md)\<`T`\> - -##### jsonProof - -`JsonProof` - -#### Returns - -`T` - -#### Inherited from - -`ProofTaskSerializerBase.getDummy` - -*** - -### toJSON() - -> **toJSON**(`proof`): `string` - -Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L65) - -#### Parameters - -##### proof - -`DynamicProof`\<`PublicInputType`, `PublicOutputType`\> | `Proof`\<`PublicInputType`, `PublicOutputType`\> - -#### Returns - -`string` - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) - -#### Inherited from - -`ProofTaskSerializerBase.toJSON` - -*** - -### toJSONProof() - -> **toJSONProof**(`proof`): `JsonProof` - -Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L73) - -#### Parameters - -##### proof - -`DynamicProof`\<`PublicInputType`, `PublicOutputType`\> | `Proof`\<`PublicInputType`, `PublicOutputType`\> - -#### Returns - -`JsonProof` - -#### Inherited from - -`ProofTaskSerializerBase.toJSONProof` diff --git a/src/pages/docs/reference/sequencer/classes/Flow.md b/src/pages/docs/reference/sequencer/classes/Flow.md deleted file mode 100644 index 8f157e5..0000000 --- a/src/pages/docs/reference/sequencer/classes/Flow.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -title: Flow ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Flow - -# Class: Flow\ - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L20) - -## Type Parameters - -• **State** - -## Implements - -- [`Closeable`](../interfaces/Closeable.md) - -## Constructors - -### new Flow() - -> **new Flow**\<`State`\>(`queueImpl`, `flowId`, `state`): [`Flow`](Flow.md)\<`State`\> - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L42) - -#### Parameters - -##### queueImpl - -[`TaskQueue`](../interfaces/TaskQueue.md) - -##### flowId - -`string` - -##### state - -`State` - -#### Returns - -[`Flow`](Flow.md)\<`State`\> - -## Properties - -### flowId - -> `readonly` **flowId**: `string` - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L44) - -*** - -### state - -> **state**: `State` - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L45) - -*** - -### tasksInProgress - -> **tasksInProgress**: `number` = `0` - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L40) - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:166](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L166) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Closeable`](../interfaces/Closeable.md).[`close`](../interfaces/Closeable.md#close) - -*** - -### forEach() - -> **forEach**\<`Type`\>(`inputs`, `fun`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:145](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L145) - -#### Type Parameters - -• **Type** - -#### Parameters - -##### inputs - -`Type`[] - -##### fun - -(`input`, `index`, `array`) => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -*** - -### pushTask() - -> **pushTask**\<`Input`, `Result`\>(`task`, `input`, `completed`?, `overrides`?): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:102](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L102) - -#### Type Parameters - -• **Input** - -• **Result** - -#### Parameters - -##### task - -[`Task`](../interfaces/Task.md)\<`Input`, `Result`\> - -##### input - -`Input` - -##### completed? - -`CompletedCallback`\<`Input`, `Result`\> - -##### overrides? - -###### taskName - -`string` - -#### Returns - -`Promise`\<`void`\> - -*** - -### reject() - -> **reject**(`error`): `void` - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L75) - -#### Parameters - -##### error - -`Error` - -#### Returns - -`void` - -*** - -### resolve() - -> **resolve**\<`Result`\>(`result`): `void` - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L68) - -#### Type Parameters - -• **Result** - -#### Parameters - -##### result - -`Result` - -#### Returns - -`void` - -*** - -### withFlow() - -> **withFlow**\<`Result`\>(`executor`): `Promise`\<`Result`\> - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:153](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L153) - -#### Type Parameters - -• **Result** - -#### Parameters - -##### executor - -(`resolve`, `reject`) => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`Result`\> diff --git a/src/pages/docs/reference/sequencer/classes/FlowCreator.md b/src/pages/docs/reference/sequencer/classes/FlowCreator.md deleted file mode 100644 index 0b1a943..0000000 --- a/src/pages/docs/reference/sequencer/classes/FlowCreator.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: FlowCreator ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / FlowCreator - -# Class: FlowCreator - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:178](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L178) - -## Constructors - -### new FlowCreator() - -> **new FlowCreator**(`queueImpl`): [`FlowCreator`](FlowCreator.md) - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:179](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L179) - -#### Parameters - -##### queueImpl - -[`TaskQueue`](../interfaces/TaskQueue.md) - -#### Returns - -[`FlowCreator`](FlowCreator.md) - -## Methods - -### createFlow() - -> **createFlow**\<`State`\>(`flowId`, `state`): [`Flow`](Flow.md)\<`State`\> - -Defined in: [packages/sequencer/src/worker/flow/Flow.ts:183](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Flow.ts#L183) - -#### Type Parameters - -• **State** - -#### Parameters - -##### flowId - -`string` - -##### state - -`State` - -#### Returns - -[`Flow`](Flow.md)\<`State`\> diff --git a/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md b/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md deleted file mode 100644 index 8cebbf8..0000000 --- a/src/pages/docs/reference/sequencer/classes/FlowTaskWorker.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: FlowTaskWorker ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / FlowTaskWorker - -# Class: FlowTaskWorker\ - -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L15) - -## Type Parameters - -• **Tasks** *extends* [`Task`](../interfaces/Task.md)\<`any`, `any`\>[] - -## Implements - -- [`Closeable`](../interfaces/Closeable.md) - -## Constructors - -### new FlowTaskWorker() - -> **new FlowTaskWorker**\<`Tasks`\>(`mq`, `tasks`): [`FlowTaskWorker`](FlowTaskWorker.md)\<`Tasks`\> - -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L22) - -#### Parameters - -##### mq - -[`TaskQueue`](../interfaces/TaskQueue.md) - -##### tasks - -`Tasks` - -#### Returns - -[`FlowTaskWorker`](FlowTaskWorker.md)\<`Tasks`\> - -## Properties - -### preparePromise? - -> `optional` **preparePromise**: `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L78) - -*** - -### prepareResolve()? - -> `optional` **prepareResolve**: () => `void` - -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L80) - -#### Returns - -`void` - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:165](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L165) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Closeable`](../interfaces/Closeable.md).[`close`](../interfaces/Closeable.md#close) - -*** - -### prepareTasks() - -> **prepareTasks**(`tasks`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L86) - -#### Parameters - -##### tasks - -[`Task`](../interfaces/Task.md)\<`unknown`, `unknown`\>[] - -#### Returns - -`Promise`\<`void`\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L112) - -#### Returns - -`Promise`\<`void`\> - -*** - -### waitForPrepared() - -> **waitForPrepared**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/worker/FlowTaskWorker.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/FlowTaskWorker.ts#L82) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md deleted file mode 100644 index 5496bb8..0000000 --- a/src/pages/docs/reference/sequencer/classes/InMemoryAsyncMerkleTreeStore.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: InMemoryAsyncMerkleTreeStore ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryAsyncMerkleTreeStore - -# Class: InMemoryAsyncMerkleTreeStore - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L9) - -## Implements - -- [`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) - -## Constructors - -### new InMemoryAsyncMerkleTreeStore() - -> **new InMemoryAsyncMerkleTreeStore**(): [`InMemoryAsyncMerkleTreeStore`](InMemoryAsyncMerkleTreeStore.md) - -#### Returns - -[`InMemoryAsyncMerkleTreeStore`](InMemoryAsyncMerkleTreeStore.md) - -## Methods - -### commit() - -> **commit**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L18) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`commit`](../interfaces/AsyncMerkleTreeStore.md#commit) - -*** - -### getNodesAsync() - -> **getNodesAsync**(`nodes`): `Promise`\<(`undefined` \| `bigint`)[]\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L26) - -#### Parameters - -##### nodes - -[`MerkleTreeNodeQuery`](../interfaces/MerkleTreeNodeQuery.md)[] - -#### Returns - -`Promise`\<(`undefined` \| `bigint`)[]\> - -#### Implementation of - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`getNodesAsync`](../interfaces/AsyncMerkleTreeStore.md#getnodesasync) - -*** - -### openTransaction() - -> **openTransaction**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L22) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`openTransaction`](../interfaces/AsyncMerkleTreeStore.md#opentransaction) - -*** - -### writeNodes() - -> **writeNodes**(`nodes`): `void` - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryAsyncMerkleTreeStore.ts#L12) - -#### Parameters - -##### nodes - -[`MerkleTreeNode`](../interfaces/MerkleTreeNode.md)[] - -#### Returns - -`void` - -#### Implementation of - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md).[`writeNodes`](../interfaces/AsyncMerkleTreeStore.md#writenodes) diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md deleted file mode 100644 index f3a4207..0000000 --- a/src/pages/docs/reference/sequencer/classes/InMemoryBatchStorage.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: InMemoryBatchStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryBatchStorage - -# Class: InMemoryBatchStorage - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L9) - -## Implements - -- [`BatchStorage`](../interfaces/BatchStorage.md) -- [`HistoricalBatchStorage`](../interfaces/HistoricalBatchStorage.md) - -## Constructors - -### new InMemoryBatchStorage() - -> **new InMemoryBatchStorage**(): [`InMemoryBatchStorage`](InMemoryBatchStorage.md) - -#### Returns - -[`InMemoryBatchStorage`](InMemoryBatchStorage.md) - -## Methods - -### getBatchAt() - -> **getBatchAt**(`height`): `Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L18) - -#### Parameters - -##### height - -`number` - -#### Returns - -`Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> - -#### Implementation of - -[`HistoricalBatchStorage`](../interfaces/HistoricalBatchStorage.md).[`getBatchAt`](../interfaces/HistoricalBatchStorage.md#getbatchat) - -*** - -### getCurrentBatchHeight() - -> **getCurrentBatchHeight**(): `Promise`\<`number`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L14) - -#### Returns - -`Promise`\<`number`\> - -#### Implementation of - -[`BatchStorage`](../interfaces/BatchStorage.md).[`getCurrentBatchHeight`](../interfaces/BatchStorage.md#getcurrentbatchheight) - -*** - -### getLatestBatch() - -> **getLatestBatch**(): `Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L27) - -#### Returns - -`Promise`\<`undefined` \| [`Batch`](../interfaces/Batch.md)\> - -#### Implementation of - -[`BatchStorage`](../interfaces/BatchStorage.md).[`getLatestBatch`](../interfaces/BatchStorage.md#getlatestbatch) - -*** - -### pushBatch() - -> **pushBatch**(`batch`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBatchStorage.ts#L22) - -#### Parameters - -##### batch - -[`Batch`](../interfaces/Batch.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`BatchStorage`](../interfaces/BatchStorage.md).[`pushBatch`](../interfaces/BatchStorage.md#pushbatch) diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md deleted file mode 100644 index 6d64dc5..0000000 --- a/src/pages/docs/reference/sequencer/classes/InMemoryBlockStorage.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -title: InMemoryBlockStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryBlockStorage - -# Class: InMemoryBlockStorage - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L18) - -## Implements - -- [`BlockStorage`](../interfaces/BlockStorage.md) -- [`HistoricalBlockStorage`](../interfaces/HistoricalBlockStorage.md) -- [`BlockQueue`](../interfaces/BlockQueue.md) - -## Constructors - -### new InMemoryBlockStorage() - -> **new InMemoryBlockStorage**(`batchStorage`): [`InMemoryBlockStorage`](InMemoryBlockStorage.md) - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L21) - -#### Parameters - -##### batchStorage - -[`BatchStorage`](../interfaces/BatchStorage.md) - -#### Returns - -[`InMemoryBlockStorage`](InMemoryBlockStorage.md) - -## Methods - -### getBlock() - -> **getBlock**(`hash`): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L112) - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -#### Implementation of - -[`HistoricalBlockStorage`](../interfaces/HistoricalBlockStorage.md).[`getBlock`](../interfaces/HistoricalBlockStorage.md#getblock) - -*** - -### getBlockAt() - -> **getBlockAt**(`height`): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L29) - -#### Parameters - -##### height - -`number` - -#### Returns - -`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -#### Implementation of - -[`HistoricalBlockStorage`](../interfaces/HistoricalBlockStorage.md).[`getBlockAt`](../interfaces/HistoricalBlockStorage.md#getblockat) - -*** - -### getCurrentBlockHeight() - -> **getCurrentBlockHeight**(): `Promise`\<`number`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L33) - -#### Returns - -`Promise`\<`number`\> - -#### Implementation of - -[`BlockStorage`](../interfaces/BlockStorage.md).[`getCurrentBlockHeight`](../interfaces/BlockStorage.md#getcurrentblockheight) - -*** - -### getLatestBlock() - -> **getLatestBlock**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L52) - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> - -#### Implementation of - -[`BlockStorage`](../interfaces/BlockStorage.md).[`getLatestBlock`](../interfaces/BlockStorage.md#getlatestblock) - -*** - -### getLatestBlockAndResult() - -> **getLatestBlockAndResult**(): `Promise`\<`undefined` \| [`BlockWithMaybeResult`](../interfaces/BlockWithMaybeResult.md)\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L37) - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithMaybeResult`](../interfaces/BlockWithMaybeResult.md)\> - -#### Implementation of - -[`BlockQueue`](../interfaces/BlockQueue.md).[`getLatestBlockAndResult`](../interfaces/BlockQueue.md#getlatestblockandresult) - -*** - -### getNewBlocks() - -> **getNewBlocks**(): `Promise`\<[`BlockWithPreviousResult`](../interfaces/BlockWithPreviousResult.md)[]\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L68) - -#### Returns - -`Promise`\<[`BlockWithPreviousResult`](../interfaces/BlockWithPreviousResult.md)[]\> - -#### Implementation of - -[`BlockQueue`](../interfaces/BlockQueue.md).[`getNewBlocks`](../interfaces/BlockQueue.md#getnewblocks) - -*** - -### getNewestResult() - -> **getNewestResult**(): `Promise`\<`undefined` \| [`BlockResult`](../interfaces/BlockResult.md)\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:104](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L104) - -#### Returns - -`Promise`\<`undefined` \| [`BlockResult`](../interfaces/BlockResult.md)\> - -*** - -### pushBlock() - -> **pushBlock**(`block`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:100](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L100) - -#### Parameters - -##### block - -[`Block`](../interfaces/Block.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`BlockQueue`](../interfaces/BlockQueue.md).[`pushBlock`](../interfaces/BlockQueue.md#pushblock) - -*** - -### pushResult() - -> **pushResult**(`result`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts:108](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryBlockStorage.ts#L108) - -#### Parameters - -##### result - -[`BlockResult`](../interfaces/BlockResult.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`BlockQueue`](../interfaces/BlockQueue.md).[`pushResult`](../interfaces/BlockQueue.md#pushresult) diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md b/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md deleted file mode 100644 index dfee034..0000000 --- a/src/pages/docs/reference/sequencer/classes/InMemoryDatabase.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -title: InMemoryDatabase ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryDatabase - -# Class: InMemoryDatabase - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L21) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](SequencerModule.md) - -## Implements - -- [`Database`](../interfaces/Database.md) - -## Constructors - -### new InMemoryDatabase() - -> **new InMemoryDatabase**(): [`InMemoryDatabase`](InMemoryDatabase.md) - -#### Returns - -[`InMemoryDatabase`](InMemoryDatabase.md) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L64) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Database`](../interfaces/Database.md).[`close`](../interfaces/Database.md#close) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### dependencies() - -> **dependencies**(): [`StorageDependencyMinimumDependencies`](../interfaces/StorageDependencyMinimumDependencies.md) - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L22) - -#### Returns - -[`StorageDependencyMinimumDependencies`](../interfaces/StorageDependencyMinimumDependencies.md) - -#### Implementation of - -[`Database`](../interfaces/Database.md).[`dependencies`](../interfaces/Database.md#dependencies) - -*** - -### executeInTransaction() - -> **executeInTransaction**(`f`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:75](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L75) - -#### Parameters - -##### f - -() => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Database`](../interfaces/Database.md).[`executeInTransaction`](../interfaces/Database.md#executeintransaction) - -*** - -### pruneDatabase() - -> **pruneDatabase**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L68) - -Prunes all data from the database connection. -Note: This function should only be called immediately at startup, -everything else will lead to unexpected behaviour and errors - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Database`](../interfaces/Database.md).[`pruneDatabase`](../interfaces/Database.md#prunedatabase) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryDatabase.ts#L60) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md deleted file mode 100644 index c17ef58..0000000 --- a/src/pages/docs/reference/sequencer/classes/InMemoryMessageStorage.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: InMemoryMessageStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryMessageStorage - -# Class: InMemoryMessageStorage - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L7) - -Interface to store Messages previously fetched by a IncomingMessageadapter - -## Implements - -- [`MessageStorage`](../interfaces/MessageStorage.md) - -## Constructors - -### new InMemoryMessageStorage() - -> **new InMemoryMessageStorage**(): [`InMemoryMessageStorage`](InMemoryMessageStorage.md) - -#### Returns - -[`InMemoryMessageStorage`](InMemoryMessageStorage.md) - -## Methods - -### getMessages() - -> **getMessages**(`fromMessagesHash`): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L10) - -#### Parameters - -##### fromMessagesHash - -`string` - -#### Returns - -`Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> - -#### Implementation of - -[`MessageStorage`](../interfaces/MessageStorage.md).[`getMessages`](../interfaces/MessageStorage.md#getmessages) - -*** - -### pushMessages() - -> **pushMessages**(`fromMessagesHash`, `toMessagesHash`, `messages`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryMessageStorage.ts#L16) - -#### Parameters - -##### fromMessagesHash - -`string` - -##### toMessagesHash - -`string` - -##### messages - -[`PendingTransaction`](PendingTransaction.md)[] - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`MessageStorage`](../interfaces/MessageStorage.md).[`pushMessages`](../interfaces/MessageStorage.md#pushmessages) diff --git a/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md b/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md deleted file mode 100644 index 5cf2443..0000000 --- a/src/pages/docs/reference/sequencer/classes/InMemorySettlementStorage.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: InMemorySettlementStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemorySettlementStorage - -# Class: InMemorySettlementStorage - -Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L7) - -## Implements - -- [`SettlementStorage`](../interfaces/SettlementStorage.md) - -## Constructors - -### new InMemorySettlementStorage() - -> **new InMemorySettlementStorage**(): [`InMemorySettlementStorage`](InMemorySettlementStorage.md) - -#### Returns - -[`InMemorySettlementStorage`](InMemorySettlementStorage.md) - -## Properties - -### settlements - -> **settlements**: [`Settlement`](../interfaces/Settlement.md)[] = `[]` - -Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L8) - -## Methods - -### pushSettlement() - -> **pushSettlement**(`settlement`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemorySettlementStorage.ts#L10) - -#### Parameters - -##### settlement - -[`Settlement`](../interfaces/Settlement.md) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`SettlementStorage`](../interfaces/SettlementStorage.md).[`pushSettlement`](../interfaces/SettlementStorage.md#pushsettlement) diff --git a/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md b/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md deleted file mode 100644 index 9a55a15..0000000 --- a/src/pages/docs/reference/sequencer/classes/InMemoryTransactionStorage.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: InMemoryTransactionStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InMemoryTransactionStorage - -# Class: InMemoryTransactionStorage - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L14) - -## Implements - -- [`TransactionStorage`](../interfaces/TransactionStorage.md) - -## Constructors - -### new InMemoryTransactionStorage() - -> **new InMemoryTransactionStorage**(`blockStorage`, `batchStorage`): [`InMemoryTransactionStorage`](InMemoryTransactionStorage.md) - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L19) - -#### Parameters - -##### blockStorage - -[`BlockStorage`](../interfaces/BlockStorage.md) & [`HistoricalBlockStorage`](../interfaces/HistoricalBlockStorage.md) - -##### batchStorage - -[`InMemoryBatchStorage`](InMemoryBatchStorage.md) - -#### Returns - -[`InMemoryTransactionStorage`](InMemoryTransactionStorage.md) - -## Methods - -### findTransaction() - -> **findTransaction**(`hash`): `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](PendingTransaction.md); \}\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L73) - -Finds a transaction by its hash. -It returns both pending transaction and already included transactions -In case the transaction has been included, it also returns the block hash -and batch number where applicable. - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](PendingTransaction.md); \}\> - -#### Implementation of - -[`TransactionStorage`](../interfaces/TransactionStorage.md).[`findTransaction`](../interfaces/TransactionStorage.md#findtransaction) - -*** - -### getPendingUserTransactions() - -> **getPendingUserTransactions**(): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L25) - -#### Returns - -`Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> - -#### Implementation of - -[`TransactionStorage`](../interfaces/TransactionStorage.md).[`getPendingUserTransactions`](../interfaces/TransactionStorage.md#getpendingusertransactions) - -*** - -### pushUserTransaction() - -> **pushUserTransaction**(`tx`): `Promise`\<`boolean`\> - -Defined in: [packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/inmemory/InMemoryTransactionStorage.ts#L46) - -#### Parameters - -##### tx - -[`PendingTransaction`](PendingTransaction.md) - -#### Returns - -`Promise`\<`boolean`\> - -#### Implementation of - -[`TransactionStorage`](../interfaces/TransactionStorage.md).[`pushUserTransaction`](../interfaces/TransactionStorage.md#pushusertransaction) diff --git a/src/pages/docs/reference/sequencer/classes/ListenerList.md b/src/pages/docs/reference/sequencer/classes/ListenerList.md deleted file mode 100644 index 2718b7e..0000000 --- a/src/pages/docs/reference/sequencer/classes/ListenerList.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: ListenerList ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ListenerList - -# Class: ListenerList\ - -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/ListenerList.ts#L3) - -## Type Parameters - -• **T** - -## Constructors - -### new ListenerList() - -> **new ListenerList**\<`T`\>(): [`ListenerList`](ListenerList.md)\<`T`\> - -#### Returns - -[`ListenerList`](ListenerList.md)\<`T`\> - -## Methods - -### executeListeners() - -> **executeListeners**(`payload`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/ListenerList.ts#L15) - -#### Parameters - -##### payload - -`T` - -#### Returns - -`Promise`\<`void`\> - -*** - -### getListeners() - -> **getListeners**(): `object`[] - -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/ListenerList.ts#L11) - -#### Returns - -`object`[] - -*** - -### pushListener() - -> **pushListener**(`listener`): `number` - -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/ListenerList.ts#L22) - -#### Parameters - -##### listener - -(`payload`) => `Promise`\<`void`\> - -#### Returns - -`number` - -*** - -### removeListener() - -> **removeListener**(`listenerId`): `void` - -Defined in: [packages/sequencer/src/worker/queue/ListenerList.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/ListenerList.ts#L34) - -#### Parameters - -##### listenerId - -`number` - -#### Returns - -`void` diff --git a/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md b/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md deleted file mode 100644 index dbe2253..0000000 --- a/src/pages/docs/reference/sequencer/classes/LocalTaskQueue.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -title: LocalTaskQueue ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / LocalTaskQueue - -# Class: LocalTaskQueue - -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L74) - -Definition of a connection-object that can generate queues and workers -for a specific connection type (e.g. BullMQ, In-memory) - -## Extends - -- [`AbstractTaskQueue`](AbstractTaskQueue.md)\<[`LocalTaskQueueConfig`](../interfaces/LocalTaskQueueConfig.md)\> - -## Implements - -- [`TaskQueue`](../interfaces/TaskQueue.md) - -## Constructors - -### new LocalTaskQueue() - -> **new LocalTaskQueue**(): [`LocalTaskQueue`](LocalTaskQueue.md) - -#### Returns - -[`LocalTaskQueue`](LocalTaskQueue.md) - -#### Inherited from - -[`AbstractTaskQueue`](AbstractTaskQueue.md).[`constructor`](AbstractTaskQueue.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`LocalTaskQueueConfig`](../interfaces/LocalTaskQueueConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`AbstractTaskQueue`](AbstractTaskQueue.md).[`currentConfig`](AbstractTaskQueue.md#currentconfig) - -*** - -### listeners - -> `readonly` **listeners**: `object` = `{}` - -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L92) - -#### Index Signature - -\[`key`: `string`\]: `undefined` \| `QueueListener`[] - -*** - -### queuedTasks - -> **queuedTasks**: `object` = `{}` - -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L78) - -#### Index Signature - -\[`key`: `string`\]: `object`[] - -*** - -### queues - -> `protected` **queues**: `Record`\<`string`, [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> = `{}` - -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L8) - -#### Inherited from - -[`AbstractTaskQueue`](AbstractTaskQueue.md).[`queues`](AbstractTaskQueue.md#queues) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`AbstractTaskQueue`](AbstractTaskQueue.md).[`presets`](AbstractTaskQueue.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`AbstractTaskQueue`](AbstractTaskQueue.md).[`config`](AbstractTaskQueue.md#config) - -## Methods - -### closeQueues() - -> `protected` **closeQueues**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L20) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`AbstractTaskQueue`](AbstractTaskQueue.md).[`closeQueues`](AbstractTaskQueue.md#closequeues) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`AbstractTaskQueue`](AbstractTaskQueue.md).[`create`](AbstractTaskQueue.md#create) - -*** - -### createOrGetQueue() - -> `protected` **createOrGetQueue**(`name`, `creator`): [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) - -Defined in: [packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/AbstractTaskQueue.ts#L10) - -#### Parameters - -##### name - -`string` - -##### creator - -(`name`) => [`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) - -#### Returns - -[`InstantiatedQueue`](../interfaces/InstantiatedQueue.md) - -#### Inherited from - -[`AbstractTaskQueue`](AbstractTaskQueue.md).[`createOrGetQueue`](AbstractTaskQueue.md#createorgetqueue) - -*** - -### createWorker() - -> **createWorker**(`queueName`, `executor`, `options`?): [`Closeable`](../interfaces/Closeable.md) - -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:149](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L149) - -#### Parameters - -##### queueName - -`string` - -##### executor - -(`data`) => `Promise`\<[`TaskPayload`](../interfaces/TaskPayload.md)\> - -##### options? - -###### concurrency - -`number` - -###### singleUse - -`boolean` - -#### Returns - -[`Closeable`](../interfaces/Closeable.md) - -#### Implementation of - -[`TaskQueue`](../interfaces/TaskQueue.md).[`createWorker`](../interfaces/TaskQueue.md#createworker) - -*** - -### getQueue() - -> **getQueue**(`queueName`): `Promise`\<[`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> - -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:189](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L189) - -#### Parameters - -##### queueName - -`string` - -#### Returns - -`Promise`\<[`InstantiatedQueue`](../interfaces/InstantiatedQueue.md)\> - -#### Implementation of - -[`TaskQueue`](../interfaces/TaskQueue.md).[`getQueue`](../interfaces/TaskQueue.md#getqueue) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:196](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L196) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`AbstractTaskQueue`](AbstractTaskQueue.md).[`start`](AbstractTaskQueue.md#start) - -*** - -### workNextTasks() - -> **workNextTasks**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:98](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L98) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md b/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md deleted file mode 100644 index ed4c09a..0000000 --- a/src/pages/docs/reference/sequencer/classes/LocalTaskWorkerModule.md +++ /dev/null @@ -1,682 +0,0 @@ ---- -title: LocalTaskWorkerModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / LocalTaskWorkerModule - -# Class: LocalTaskWorkerModule\ - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L56) - -This module spins up a worker in the current local node instance. -This should only be used for local testing/development and not in a -production setup. Use the proper worker execution method for spinning up -cloud workers. - -## Extends - -- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Tasks`\> - -## Type Parameters - -• **Tasks** *extends* [`TaskWorkerModulesRecord`](../type-aliases/TaskWorkerModulesRecord.md) - -## Implements - -- [`SequencerModule`](SequencerModule.md) -- [`EventEmittingContainer`](../../common/interfaces/EventEmittingContainer.md)\<`LocalTaskWorkerModuleEvents`\> - -## Constructors - -### new LocalTaskWorkerModule() - -> **new LocalTaskWorkerModule**\<`Tasks`\>(`modules`): [`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\> - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L80) - -#### Parameters - -##### modules - -`Tasks` - -#### Returns - -[`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\> - -#### Overrides - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) - -## Properties - -### containerEvents - -> **containerEvents**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<`LocalTaskWorkerModuleEvents`\> - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L64) - -#### Implementation of - -[`EventEmittingContainer`](../../common/interfaces/EventEmittingContainer.md).[`containerEvents`](../../common/interfaces/EventEmittingContainer.md#containerevents) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Tasks`\> - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Implementation of - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) - -*** - -### definition - -> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Tasks`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L62) - -#### Implementation of - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Implementation of - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) - -*** - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:124](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L124) - -#### Returns - -`Promise`\<`void`\> - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Tasks`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Tasks`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:160 - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Implementation of - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) - -*** - -### decorateModule() - -> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:134 - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Tasks`\> - -##### containedModule - -`InstanceType`\<`Tasks`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Tasks`\>\]\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Tasks`\>[] - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -`Tasks` - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Tasks`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -`Tasks` - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Tasks`\>\[`KeyType`\]\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Tasks`\>\[`KeyType`\]\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:100](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L100) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Tasks`\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`Tasks`\>(`modules`): [`TypedClass`](../type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\>\> - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L70) - -#### Type Parameters - -• **Tasks** *extends* [`TaskWorkerModulesRecord`](../type-aliases/TaskWorkerModulesRecord.md) - -#### Parameters - -##### modules - -`Tasks` - -#### Returns - -[`TypedClass`](../type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`Tasks`\>\> diff --git a/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md b/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md deleted file mode 100644 index 996f339..0000000 --- a/src/pages/docs/reference/sequencer/classes/ManualBlockTrigger.md +++ /dev/null @@ -1,339 +0,0 @@ ---- -title: ManualBlockTrigger ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ManualBlockTrigger - -# Class: ManualBlockTrigger - -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L17) - -A BlockTrigger is the primary method to start the production of a block and -all associated processes. - -## Extends - -- [`BlockTriggerBase`](BlockTriggerBase.md) - -## Implements - -- [`BlockTrigger`](../interfaces/BlockTrigger.md) - -## Constructors - -### new ManualBlockTrigger() - -> **new ManualBlockTrigger**(`batchProducerModule`, `blockProducerModule`, `settlementModule`, `blockQueue`, `batchStorage`, `settlementStorage`): [`ManualBlockTrigger`](ManualBlockTrigger.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L21) - -#### Parameters - -##### batchProducerModule - -[`BatchProducerModule`](BatchProducerModule.md) - -##### blockProducerModule - -[`BlockProducerModule`](BlockProducerModule.md) - -##### settlementModule - -`undefined` | [`SettlementModule`](SettlementModule.md) - -##### blockQueue - -[`BlockQueue`](../interfaces/BlockQueue.md) - -##### batchStorage - -[`BatchStorage`](../interfaces/BatchStorage.md) - -##### settlementStorage - -`undefined` | [`SettlementStorage`](../interfaces/SettlementStorage.md) - -#### Returns - -[`ManualBlockTrigger`](ManualBlockTrigger.md) - -#### Overrides - -[`BlockTriggerBase`](BlockTriggerBase.md).[`constructor`](BlockTriggerBase.md#constructors) - -## Properties - -### batchProducerModule - -> `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`batchProducerModule`](BlockTriggerBase.md#batchproducermodule-1) - -*** - -### batchQueue - -> `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`batchQueue`](BlockTriggerBase.md#batchqueue-1) - -*** - -### blockProducerModule - -> `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`blockProducerModule`](BlockTriggerBase.md#blockproducermodule-1) - -*** - -### blockQueue - -> `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`blockQueue`](BlockTriggerBase.md#blockqueue-1) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`currentConfig`](BlockTriggerBase.md#currentconfig) - -*** - -### events - -> `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`BlockEvents`](../type-aliases/BlockEvents.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`events`](BlockTriggerBase.md#events) - -*** - -### settlementModule - -> `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`settlementModule`](BlockTriggerBase.md#settlementmodule-1) - -*** - -### settlementStorage - -> `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`settlementStorage`](BlockTriggerBase.md#settlementstorage-1) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`presets`](BlockTriggerBase.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`config`](BlockTriggerBase.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`create`](BlockTriggerBase.md#create) - -*** - -### produceBatch() - -> **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L57) - -#### Returns - -`Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> - -#### Overrides - -[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBatch`](BlockTriggerBase.md#producebatch) - -*** - -### produceBlock() - -> **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L65) - -#### Returns - -`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -#### Overrides - -[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBlock`](BlockTriggerBase.md#produceblock) - -*** - -### produceBlockAndBatch() - -> **produceBlockAndBatch**(): `Promise`\<\[`undefined` \| [`Block`](../interfaces/Block.md), `undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\]\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L50) - -Produces both an unproven block and immediately produce a -settlement block proof - -#### Returns - -`Promise`\<\[`undefined` \| [`Block`](../interfaces/Block.md), `undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\]\> - -*** - -### produceBlockWithResult() - -> **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L69) - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> - -#### Overrides - -[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBlockWithResult`](BlockTriggerBase.md#produceblockwithresult) - -*** - -### settle() - -> **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/ManualBlockTrigger.ts#L61) - -#### Parameters - -##### batch - -[`SettleableBatch`](../interfaces/SettleableBatch.md) - -#### Returns - -`Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> - -#### Overrides - -[`BlockTriggerBase`](BlockTriggerBase.md).[`settle`](BlockTriggerBase.md#settle) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L112) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`start`](BlockTriggerBase.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md b/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md deleted file mode 100644 index a416d6a..0000000 --- a/src/pages/docs/reference/sequencer/classes/MinaBaseLayer.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -title: MinaBaseLayer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaBaseLayer - -# Class: MinaBaseLayer - -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L35) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](SequencerModule.md)\<[`MinaBaseLayerConfig`](../interfaces/MinaBaseLayerConfig.md)\> - -## Implements - -- [`BaseLayer`](../interfaces/BaseLayer.md) -- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) - -## Constructors - -### new MinaBaseLayer() - -> **new MinaBaseLayer**(`areProofsEnabled`): [`MinaBaseLayer`](MinaBaseLayer.md) - -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L43) - -#### Parameters - -##### areProofsEnabled - -[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Returns - -[`MinaBaseLayer`](MinaBaseLayer.md) - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`MinaBaseLayerConfig`](../interfaces/MinaBaseLayerConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### network? - -> `optional` **network**: `Mina` - -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L39) - -*** - -### originalNetwork? - -> `optional` **originalNetwork**: `Mina` - -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L41) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### dependencies() - -> **dependencies**(): `object` - -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L50) - -#### Returns - -`object` - -##### IncomingMessageAdapter - -> **IncomingMessageAdapter**: `object` - -###### IncomingMessageAdapter.useClass - -> **IncomingMessageAdapter.useClass**: *typeof* [`MinaIncomingMessageAdapter`](MinaIncomingMessageAdapter.md) = `MinaIncomingMessageAdapter` - -##### OutgoingMessageQueue - -> **OutgoingMessageQueue**: `object` - -###### OutgoingMessageQueue.useClass - -> **OutgoingMessageQueue.useClass**: *typeof* [`WithdrawalQueue`](WithdrawalQueue.md) = `WithdrawalQueue` - -##### TransactionSender - -> **TransactionSender**: `object` - -###### TransactionSender.useClass - -> **TransactionSender.useClass**: *typeof* [`MinaTransactionSender`](MinaTransactionSender.md) = `MinaTransactionSender` - -#### Implementation of - -[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) - -*** - -### isLocalBlockChain() - -> **isLocalBlockChain**(): `boolean` - -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L66) - -#### Returns - -`boolean` - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L70) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md b/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md deleted file mode 100644 index 6a312c0..0000000 --- a/src/pages/docs/reference/sequencer/classes/MinaIncomingMessageAdapter.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: MinaIncomingMessageAdapter ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaIncomingMessageAdapter - -# Class: MinaIncomingMessageAdapter - -Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L34) - -IncomingMessageAdapter implementation for a Mina Baselayer -based on decoding L1-dispatched actions - -## Implements - -- [`IncomingMessageAdapter`](../interfaces/IncomingMessageAdapter.md) - -## Constructors - -### new MinaIncomingMessageAdapter() - -> **new MinaIncomingMessageAdapter**(`baseLayer`, `runtime`, `protocol`): [`MinaIncomingMessageAdapter`](MinaIncomingMessageAdapter.md) - -Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L35) - -#### Parameters - -##### baseLayer - -[`MinaBaseLayer`](MinaBaseLayer.md) - -##### runtime - -[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<`any`\> - -#### Returns - -[`MinaIncomingMessageAdapter`](MinaIncomingMessageAdapter.md) - -## Methods - -### getPendingMessages() - -> **getPendingMessages**(`address`, `params`): `Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](PendingTransaction.md)[]; `to`: `string`; \}\> - -Defined in: [packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts:99](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts#L99) - -#### Parameters - -##### address - -`PublicKey` - -##### params - -###### fromActionHash - -`string` - -###### fromL1BlockHeight - -`number` - -###### toActionHash - -`string` - -#### Returns - -`Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](PendingTransaction.md)[]; `to`: `string`; \}\> - -#### Implementation of - -[`IncomingMessageAdapter`](../interfaces/IncomingMessageAdapter.md).[`getPendingMessages`](../interfaces/IncomingMessageAdapter.md#getpendingmessages) diff --git a/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md b/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md deleted file mode 100644 index f09ae81..0000000 --- a/src/pages/docs/reference/sequencer/classes/MinaSimulationService.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: MinaSimulationService ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaSimulationService - -# Class: MinaSimulationService - -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L17) - -## Constructors - -### new MinaSimulationService() - -> **new MinaSimulationService**(`baseLayer`): [`MinaSimulationService`](MinaSimulationService.md) - -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L18) - -#### Parameters - -##### baseLayer - -[`MinaBaseLayer`](MinaBaseLayer.md) - -#### Returns - -[`MinaSimulationService`](MinaSimulationService.md) - -## Methods - -### applyTransaction() - -> **applyTransaction**(`tx`): `void` - -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L65) - -#### Parameters - -##### tx - -`Transaction`\<`boolean`, `boolean`\> - -#### Returns - -`void` - -*** - -### updateAccount() - -> **updateAccount**(`publicKey`, `tokenId`?): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L41) - -#### Parameters - -##### publicKey - -`PublicKey` - -##### tokenId? - -`Field` - -#### Returns - -`Promise`\<`void`\> - -*** - -### updateNetworkState() - -> **updateNetworkState**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/settlement/transactions/MinaSimulationService.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaSimulationService.ts#L36) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md b/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md deleted file mode 100644 index d4eccc8..0000000 --- a/src/pages/docs/reference/sequencer/classes/MinaTransactionSender.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: MinaTransactionSender ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaTransactionSender - -# Class: MinaTransactionSender - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L29) - -## Constructors - -### new MinaTransactionSender() - -> **new MinaTransactionSender**(`creator`, `provingTask`, `simulator`, `baseLayer`): [`MinaTransactionSender`](MinaTransactionSender.md) - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L39) - -#### Parameters - -##### creator - -[`FlowCreator`](FlowCreator.md) - -##### provingTask - -[`SettlementProvingTask`](SettlementProvingTask.md) - -##### simulator - -[`MinaTransactionSimulator`](MinaTransactionSimulator.md) - -##### baseLayer - -[`MinaBaseLayer`](MinaBaseLayer.md) - -#### Returns - -[`MinaTransactionSender`](MinaTransactionSender.md) - -## Methods - -### proveAndSendTransaction() - -> **proveAndSendTransaction**(`transaction`, `waitOnStatus`): `Promise`\<[`EventListenable`](../../common/type-aliases/EventListenable.md)\<[`TxEvents`](../interfaces/TxEvents.md)\>\> - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:116](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L116) - -#### Parameters - -##### transaction - -`Transaction`\<`false`, `true`\> - -##### waitOnStatus - -`"sent"` | `"included"` | `"none"` - -#### Returns - -`Promise`\<[`EventListenable`](../../common/type-aliases/EventListenable.md)\<[`TxEvents`](../interfaces/TxEvents.md)\>\> diff --git a/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md b/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md deleted file mode 100644 index e36b10b..0000000 --- a/src/pages/docs/reference/sequencer/classes/MinaTransactionSimulator.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -title: MinaTransactionSimulator ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaTransactionSimulator - -# Class: MinaTransactionSimulator - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L32) - -Custom variant of the ocaml ledger implementation that applies account updates -to a ledger state. It isn't feature complete and is mainly used to update the -o1js internal account cache to create batched transactions - -## Constructors - -### new MinaTransactionSimulator() - -> **new MinaTransactionSimulator**(`baseLayer`): [`MinaTransactionSimulator`](MinaTransactionSimulator.md) - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L37) - -#### Parameters - -##### baseLayer - -[`MinaBaseLayer`](MinaBaseLayer.md) - -#### Returns - -[`MinaTransactionSimulator`](MinaTransactionSimulator.md) - -## Methods - -### apply() - -> **apply**(`account`, `au`): `void` - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:247](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L247) - -#### Parameters - -##### account - -`Account` - -##### au - -`AccountUpdate` - -#### Returns - -`void` - -*** - -### applyFeepayer() - -> **applyFeepayer**(`account`, `feepayer`): `void` - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:242](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L242) - -#### Parameters - -##### account - -`Account` - -##### feepayer - -`FeePayerUnsigned` - -#### Returns - -`void` - -*** - -### applyTransaction() - -> **applyTransaction**(`tx`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L86) - -#### Parameters - -##### tx - -`Transaction`\<`boolean`, `boolean`\> - -#### Returns - -`Promise`\<`void`\> - -*** - -### checkFeePayer() - -> **checkFeePayer**(`account`, `feepayer`): `boolean` - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:199](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L199) - -#### Parameters - -##### account - -`Account` - -##### feepayer - -`FeePayerUnsigned` - -#### Returns - -`boolean` - -*** - -### checkPreconditions() - -> **checkPreconditions**(`account`, `au`): `string`[] - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:206](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L206) - -#### Parameters - -##### account - -`Account` - -##### au - -`AccountUpdate` - -#### Returns - -`string`[] - -*** - -### getAccount() - -> **getAccount**(`publicKey`, `tokenId`?): `Promise`\<`Account`\> - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:142](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L142) - -#### Parameters - -##### publicKey - -`PublicKey` - -##### tokenId? - -`Field` - -#### Returns - -`Promise`\<`Account`\> - -*** - -### getAccounts() - -> **getAccounts**(`tx`): `Promise`\<`Account`[]\> - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L80) - -#### Parameters - -##### tx - -`Transaction`\<`boolean`, `boolean`\> - -#### Returns - -`Promise`\<`Account`[]\> - -*** - -### reloadAccount() - -> **reloadAccount**(`publicKey`, `tokenId`?): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts:163](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSimulator.ts#L163) - -#### Parameters - -##### publicKey - -`PublicKey` - -##### tokenId? - -`Field` - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md b/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md deleted file mode 100644 index ec4485e..0000000 --- a/src/pages/docs/reference/sequencer/classes/NetworkStateQuery.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: NetworkStateQuery ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NetworkStateQuery - -# Class: NetworkStateQuery - -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L5) - -## Constructors - -### new NetworkStateQuery() - -> **new NetworkStateQuery**(`transportModule`): [`NetworkStateQuery`](NetworkStateQuery.md) - -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L6) - -#### Parameters - -##### transportModule - -[`NetworkStateTransportModule`](../interfaces/NetworkStateTransportModule.md) - -#### Returns - -[`NetworkStateQuery`](NetworkStateQuery.md) - -## Accessors - -### proven - -#### Get Signature - -> **get** **proven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L18) - -##### Returns - -`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -*** - -### stagedUnproven - -#### Get Signature - -> **get** **stagedUnproven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L14) - -##### Returns - -`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -*** - -### unproven - -#### Get Signature - -> **get** **unproven**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [packages/sequencer/src/helpers/query/NetworkStateQuery.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateQuery.ts#L10) - -##### Returns - -`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> diff --git a/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md deleted file mode 100644 index e2e5a0f..0000000 --- a/src/pages/docs/reference/sequencer/classes/NewBlockProvingParametersSerializer.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: NewBlockProvingParametersSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NewBlockProvingParametersSerializer - -# Class: NewBlockProvingParametersSerializer - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L38) - -## Implements - -- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`NewBlockPayload`\> - -## Constructors - -### new NewBlockProvingParametersSerializer() - -> **new NewBlockProvingParametersSerializer**(`stProofSerializer`, `blockProofSerializer`): [`NewBlockProvingParametersSerializer`](NewBlockProvingParametersSerializer.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L41) - -#### Parameters - -##### stProofSerializer - -[`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`StateTransitionProverPublicInput`](../../protocol/classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../../protocol/classes/StateTransitionProverPublicOutput.md)\> - -##### blockProofSerializer - -[`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md), [`BlockProverPublicOutput`](../../protocol/classes/BlockProverPublicOutput.md)\> - -#### Returns - -[`NewBlockProvingParametersSerializer`](NewBlockProvingParametersSerializer.md) - -## Methods - -### fromJSON() - -> **fromJSON**(`json`): `Promise`\<`NewBlockPayload`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L73) - -#### Parameters - -##### json - -`string` - -#### Returns - -`Promise`\<`NewBlockPayload`\> - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) - -*** - -### toJSON() - -> **toJSON**(`input`): `string` - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/NewBlockProvingParametersSerializer.ts#L52) - -#### Parameters - -##### input - -`NewBlockPayload` - -#### Returns - -`string` - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) diff --git a/src/pages/docs/reference/sequencer/classes/NewBlockTask.md b/src/pages/docs/reference/sequencer/classes/NewBlockTask.md deleted file mode 100644 index d5faebf..0000000 --- a/src/pages/docs/reference/sequencer/classes/NewBlockTask.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -title: NewBlockTask ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NewBlockTask - -# Class: NewBlockTask - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L45) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`TaskWorkerModule`](TaskWorkerModule.md) - -## Implements - -- [`Task`](../interfaces/Task.md)\<[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md), `BlockProof`\> - -## Constructors - -### new NewBlockTask() - -> **new NewBlockTask**(`protocol`, `executionContext`, `compileRegistry`): [`NewBlockTask`](NewBlockTask.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L55) - -#### Parameters - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> - -##### executionContext - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md) - -##### compileRegistry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -[`NewBlockTask`](NewBlockTask.md) - -#### Overrides - -[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) - -*** - -### name - -> `readonly` **name**: `"newBlock"` = `"newBlock"` - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L53) - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) - -## Methods - -### compute() - -> **compute**(`input`): `Promise`\<`BlockProof`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:105](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L105) - -#### Parameters - -##### input - -[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md) - -#### Returns - -`Promise`\<`BlockProof`\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) - -*** - -### inputSerializer() - -> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L66) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`NewBlockProvingParameters`](../type-aliases/NewBlockProvingParameters.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) - -*** - -### prepare() - -> **prepare**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:129](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L129) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) - -*** - -### resultSerializer() - -> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`BlockProof`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:81](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L81) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<`BlockProof`\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md b/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md deleted file mode 100644 index 9ab5bc1..0000000 --- a/src/pages/docs/reference/sequencer/classes/NoopBaseLayer.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: NoopBaseLayer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NoopBaseLayer - -# Class: NoopBaseLayer - -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L53) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](SequencerModule.md) - -## Implements - -- [`BaseLayer`](../interfaces/BaseLayer.md) - -## Constructors - -### new NoopBaseLayer() - -> **new NoopBaseLayer**(): [`NoopBaseLayer`](NoopBaseLayer.md) - -#### Returns - -[`NoopBaseLayer`](NoopBaseLayer.md) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### blockProduced() - -> **blockProduced**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L54) - -#### Returns - -`Promise`\<`void`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### dependencies() - -> **dependencies**(): [`BaseLayerDependencyRecord`](../interfaces/BaseLayerDependencyRecord.md) - -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L62) - -#### Returns - -[`BaseLayerDependencyRecord`](../interfaces/BaseLayerDependencyRecord.md) - -#### Implementation of - -[`BaseLayer`](../interfaces/BaseLayer.md).[`dependencies`](../interfaces/BaseLayer.md#dependencies) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/NoopBaseLayer.ts#L58) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md deleted file mode 100644 index 0d1f7db..0000000 --- a/src/pages/docs/reference/sequencer/classes/PairProofTaskSerializer.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: PairProofTaskSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PairProofTaskSerializer - -# Class: PairProofTaskSerializer\ - -Defined in: [packages/sequencer/src/helpers/utils.ts:164](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L164) - -## Type Parameters - -• **PublicInputType** - -• **PublicOutputType** - -## Implements - -- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\>\> - -## Constructors - -### new PairProofTaskSerializer() - -> **new PairProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`PairProofTaskSerializer`](PairProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> - -Defined in: [packages/sequencer/src/helpers/utils.ts:170](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L170) - -#### Parameters - -##### proofClass - -[`Subclass`](../../protocol/type-aliases/Subclass.md)\<*typeof* `Proof`\> - -#### Returns - -[`PairProofTaskSerializer`](PairProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> - -## Methods - -### fromJSON() - -> **fromJSON**(`json`): `Promise`\<[`PairTuple`](../type-aliases/PairTuple.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\>\> - -Defined in: [packages/sequencer/src/helpers/utils.ts:176](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L176) - -#### Parameters - -##### json - -`string` - -#### Returns - -`Promise`\<[`PairTuple`](../type-aliases/PairTuple.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\>\> - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) - -*** - -### toJSON() - -> **toJSON**(`input`): `string` - -Defined in: [packages/sequencer/src/helpers/utils.ts:187](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L187) - -#### Parameters - -##### input - -[`PairTuple`](../type-aliases/PairTuple.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> - -#### Returns - -`string` - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) diff --git a/src/pages/docs/reference/sequencer/classes/PendingTransaction.md b/src/pages/docs/reference/sequencer/classes/PendingTransaction.md deleted file mode 100644 index 6327e0d..0000000 --- a/src/pages/docs/reference/sequencer/classes/PendingTransaction.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -title: PendingTransaction ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PendingTransaction - -# Class: PendingTransaction - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:123](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L123) - -## Extends - -- [`UnsignedTransaction`](UnsignedTransaction.md) - -## Constructors - -### new PendingTransaction() - -> **new PendingTransaction**(`data`): [`PendingTransaction`](PendingTransaction.md) - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:140](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L140) - -#### Parameters - -##### data - -###### argsFields - -`Field`[] - -###### auxiliaryData - -`string`[] - -###### isMessage - -`boolean` - -###### methodId - -`Field` - -###### nonce - -`UInt64` - -###### sender - -`PublicKey` - -###### signature - -`Signature` - -#### Returns - -[`PendingTransaction`](PendingTransaction.md) - -#### Overrides - -[`UnsignedTransaction`](UnsignedTransaction.md).[`constructor`](UnsignedTransaction.md#constructors) - -## Properties - -### argsFields - -> **argsFields**: `Field`[] - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L37) - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`argsFields`](UnsignedTransaction.md#argsfields-1) - -*** - -### auxiliaryData - -> **auxiliaryData**: `string`[] - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L39) - -Used to transport non-provable data, mainly proof data for now -These values will not be part of the signature message or transaction hash - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`auxiliaryData`](UnsignedTransaction.md#auxiliarydata-1) - -*** - -### isMessage - -> **isMessage**: `boolean` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L41) - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`isMessage`](UnsignedTransaction.md#ismessage-1) - -*** - -### methodId - -> **methodId**: `Field` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L31) - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`methodId`](UnsignedTransaction.md#methodid-1) - -*** - -### nonce - -> **nonce**: `UInt64` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L33) - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`nonce`](UnsignedTransaction.md#nonce-1) - -*** - -### sender - -> **sender**: `PublicKey` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L35) - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`sender`](UnsignedTransaction.md#sender-1) - -*** - -### signature - -> **signature**: `Signature` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:138](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L138) - -## Methods - -### argsHash() - -> **argsHash**(): `Field` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L59) - -#### Returns - -`Field` - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`argsHash`](UnsignedTransaction.md#argshash) - -*** - -### getSignatureData() - -> **getSignatureData**(): `Field`[] - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L72) - -#### Returns - -`Field`[] - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`getSignatureData`](UnsignedTransaction.md#getsignaturedata) - -*** - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L63) - -#### Returns - -`Field` - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`hash`](UnsignedTransaction.md#hash) - -*** - -### sign() - -> **sign**(`privateKey`): [`PendingTransaction`](PendingTransaction.md) - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L80) - -#### Parameters - -##### privateKey - -`PrivateKey` - -#### Returns - -[`PendingTransaction`](PendingTransaction.md) - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`sign`](UnsignedTransaction.md#sign) - -*** - -### signed() - -> **signed**(`signature`): [`PendingTransaction`](PendingTransaction.md) - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L95) - -#### Parameters - -##### signature - -`Signature` - -#### Returns - -[`PendingTransaction`](PendingTransaction.md) - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`signed`](UnsignedTransaction.md#signed) - -*** - -### toJSON() - -> **toJSON**(): `PendingTransactionJSONType` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:153](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L153) - -#### Returns - -`PendingTransactionJSONType` - -*** - -### toProtocolTransaction() - -> **toProtocolTransaction**(): [`SignedTransaction`](../../protocol/classes/SignedTransaction.md) - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:171](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L171) - -#### Returns - -[`SignedTransaction`](../../protocol/classes/SignedTransaction.md) - -*** - -### toRuntimeTransaction() - -> **toRuntimeTransaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L85) - -#### Returns - -[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -#### Inherited from - -[`UnsignedTransaction`](UnsignedTransaction.md).[`toRuntimeTransaction`](UnsignedTransaction.md#toruntimetransaction) - -*** - -### fromJSON() - -> `static` **fromJSON**(`object`): [`PendingTransaction`](PendingTransaction.md) - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:124](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L124) - -#### Parameters - -##### object - -`PendingTransactionJSONType` - -#### Returns - -[`PendingTransaction`](PendingTransaction.md) diff --git a/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md b/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md deleted file mode 100644 index e9f7569..0000000 --- a/src/pages/docs/reference/sequencer/classes/PreFilledStateService.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: PreFilledStateService ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PreFilledStateService - -# Class: PreFilledStateService - -Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L4) - -Naive implementation of an in-memory variant of the StateService interface - -## Extends - -- [`InMemoryStateService`](../../module/classes/InMemoryStateService.md) - -## Constructors - -### new PreFilledStateService() - -> **new PreFilledStateService**(`values`): [`PreFilledStateService`](PreFilledStateService.md) - -Defined in: [packages/sequencer/src/state/prefilled/PreFilledStateService.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/prefilled/PreFilledStateService.ts#L5) - -#### Parameters - -##### values - -#### Returns - -[`PreFilledStateService`](PreFilledStateService.md) - -#### Overrides - -[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`constructor`](../../module/classes/InMemoryStateService.md#constructors) - -## Properties - -### values - -> **values**: `Record`\<`string`, `null` \| `Field`[]\> - -Defined in: packages/module/dist/state/InMemoryStateService.d.ts:11 - -This mapping container null values if the specific entry has been deleted. -This is used by the CachedState service to keep track of deletions - -#### Inherited from - -[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`values`](../../module/classes/InMemoryStateService.md#values) - -## Methods - -### get() - -> **get**(`key`): `Promise`\<`undefined` \| `Field`[]\> - -Defined in: packages/module/dist/state/InMemoryStateService.d.ts:12 - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| `Field`[]\> - -#### Inherited from - -[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`get`](../../module/classes/InMemoryStateService.md#get) - -*** - -### set() - -> **set**(`key`, `value`): `Promise`\<`void`\> - -Defined in: packages/module/dist/state/InMemoryStateService.d.ts:13 - -#### Parameters - -##### key - -`Field` - -##### value - -`undefined` | `Field`[] - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`InMemoryStateService`](../../module/classes/InMemoryStateService.md).[`set`](../../module/classes/InMemoryStateService.md#set) diff --git a/src/pages/docs/reference/sequencer/classes/PrivateMempool.md b/src/pages/docs/reference/sequencer/classes/PrivateMempool.md deleted file mode 100644 index 7739489..0000000 --- a/src/pages/docs/reference/sequencer/classes/PrivateMempool.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -title: PrivateMempool ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PrivateMempool - -# Class: PrivateMempool - -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L36) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](SequencerModule.md) - -## Implements - -- [`Mempool`](../interfaces/Mempool.md) - -## Constructors - -### new PrivateMempool() - -> **new PrivateMempool**(`transactionValidator`, `transactionStorage`, `protocol`, `sequencer`, `stateService`): [`PrivateMempool`](PrivateMempool.md) - -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L41) - -#### Parameters - -##### transactionValidator - -`TransactionValidator` - -##### transactionStorage - -[`TransactionStorage`](../interfaces/TransactionStorage.md) - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> - -##### sequencer - -[`Sequencer`](Sequencer.md)\<[`SequencerModulesRecord`](../type-aliases/SequencerModulesRecord.md)\> - -##### stateService - -[`AsyncStateService`](../interfaces/AsyncStateService.md) - -#### Returns - -[`PrivateMempool`](PrivateMempool.md) - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### events - -> `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`MempoolEvents`](../type-aliases/MempoolEvents.md)\> - -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L37) - -#### Implementation of - -[`Mempool`](../interfaces/Mempool.md).[`events`](../interfaces/Mempool.md#events) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### add() - -> **add**(`tx`): `Promise`\<`boolean`\> - -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L57) - -Add a transaction to the mempool - -#### Parameters - -##### tx - -[`PendingTransaction`](PendingTransaction.md) - -#### Returns - -`Promise`\<`boolean`\> - -The new commitment to the mempool - -#### Implementation of - -[`Mempool`](../interfaces/Mempool.md).[`add`](../interfaces/Mempool.md#add) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### getStagedNetworkState() - -> **getStagedNetworkState**(): `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:91](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L91) - -#### Returns - -`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -*** - -### getTxs() - -> **getTxs**(`limit`?): `Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> - -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:96](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L96) - -Retrieve all transactions that are currently in the mempool - -#### Parameters - -##### limit? - -`number` - -#### Returns - -`Promise`\<[`PendingTransaction`](PendingTransaction.md)[]\> - -#### Implementation of - -[`Mempool`](../interfaces/Mempool.md).[`getTxs`](../interfaces/Mempool.md#gettxs) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/mempool/private/PrivateMempool.ts:200](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/private/PrivateMempool.ts#L200) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md b/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md deleted file mode 100644 index 4c335a7..0000000 --- a/src/pages/docs/reference/sequencer/classes/ProofTaskSerializer.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -title: ProofTaskSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ProofTaskSerializer - -# Class: ProofTaskSerializer\ - -Defined in: [packages/sequencer/src/helpers/utils.ts:100](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L100) - -## Extends - -- `ProofTaskSerializerBase`\<`PublicInputType`, `PublicOutputType`\> - -## Type Parameters - -• **PublicInputType** - -• **PublicOutputType** - -## Implements - -- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> - -## Constructors - -### new ProofTaskSerializer() - -> **new ProofTaskSerializer**\<`PublicInputType`, `PublicOutputType`\>(`proofClass`): [`ProofTaskSerializer`](ProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> - -Defined in: [packages/sequencer/src/helpers/utils.ts:104](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L104) - -#### Parameters - -##### proofClass - -[`Subclass`](../../protocol/type-aliases/Subclass.md)\<*typeof* `Proof`\> - -#### Returns - -[`ProofTaskSerializer`](ProofTaskSerializer.md)\<`PublicInputType`, `PublicOutputType`\> - -#### Overrides - -`ProofTaskSerializerBase.constructor` - -## Methods - -### fromJSON() - -> **fromJSON**(`json`): `Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> - -Defined in: [packages/sequencer/src/helpers/utils.ts:112](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L112) - -#### Parameters - -##### json - -`string` - -#### Returns - -`Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) - -*** - -### fromJSONProof() - -> **fromJSONProof**(`jsonProof`): `Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> - -Defined in: [packages/sequencer/src/helpers/utils.ts:119](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L119) - -#### Parameters - -##### jsonProof - -`JsonProof` - -#### Returns - -`Promise`\<`Proof`\<`PublicInputType`, `PublicOutputType`\>\> - -*** - -### getDummy() - -> `protected` **getDummy**\<`T`\>(`c`, `jsonProof`): `T` - -Defined in: [packages/sequencer/src/helpers/utils.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L41) - -#### Type Parameters - -• **T** *extends* `Proof`\<`PublicInputType`, `PublicOutputType`\> \| `DynamicProof`\<`PublicInputType`, `PublicOutputType`\> - -#### Parameters - -##### c - -[`TypedClass`](../type-aliases/TypedClass.md)\<`T`\> - -##### jsonProof - -`JsonProof` - -#### Returns - -`T` - -#### Inherited from - -`ProofTaskSerializerBase.getDummy` - -*** - -### toJSON() - -> **toJSON**(`proof`): `string` - -Defined in: [packages/sequencer/src/helpers/utils.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L65) - -#### Parameters - -##### proof - -`Proof`\<`PublicInputType`, `PublicOutputType`\> | `DynamicProof`\<`PublicInputType`, `PublicOutputType`\> - -#### Returns - -`string` - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) - -#### Inherited from - -`ProofTaskSerializerBase.toJSON` - -*** - -### toJSONProof() - -> **toJSONProof**(`proof`): `JsonProof` - -Defined in: [packages/sequencer/src/helpers/utils.ts:73](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L73) - -#### Parameters - -##### proof - -`Proof`\<`PublicInputType`, `PublicOutputType`\> | `DynamicProof`\<`PublicInputType`, `PublicOutputType`\> - -#### Returns - -`JsonProof` - -#### Inherited from - -`ProofTaskSerializerBase.toJSONProof` diff --git a/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md b/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md deleted file mode 100644 index 3887dc7..0000000 --- a/src/pages/docs/reference/sequencer/classes/ProvenSettlementPermissions.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: ProvenSettlementPermissions ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ProvenSettlementPermissions - -# Class: ProvenSettlementPermissions - -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L5) - -## Implements - -- [`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md) - -## Constructors - -### new ProvenSettlementPermissions() - -> **new ProvenSettlementPermissions**(): [`ProvenSettlementPermissions`](ProvenSettlementPermissions.md) - -#### Returns - -[`ProvenSettlementPermissions`](ProvenSettlementPermissions.md) - -## Methods - -### bridgeContractMina() - -> **bridgeContractMina**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L35) - -#### Returns - -`Permissions` - -#### Implementation of - -[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`bridgeContractMina`](../interfaces/BaseLayerContractPermissions.md#bridgecontractmina) - -*** - -### bridgeContractToken() - -> **bridgeContractToken**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L39) - -#### Returns - -`Permissions` - -#### Implementation of - -[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`bridgeContractToken`](../interfaces/BaseLayerContractPermissions.md#bridgecontracttoken) - -*** - -### dispatchContract() - -> **dispatchContract**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L31) - -#### Returns - -`Permissions` - -#### Implementation of - -[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`dispatchContract`](../interfaces/BaseLayerContractPermissions.md#dispatchcontract) - -*** - -### settlementContract() - -> **settlementContract**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/ProvenSettlementPermissions.ts#L27) - -#### Returns - -`Permissions` - -#### Implementation of - -[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`settlementContract`](../interfaces/BaseLayerContractPermissions.md#settlementcontract) diff --git a/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md b/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md deleted file mode 100644 index 31be168..0000000 --- a/src/pages/docs/reference/sequencer/classes/ReductionTaskFlow.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: ReductionTaskFlow ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ReductionTaskFlow - -# Class: ReductionTaskFlow\ - -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L30) - -This class builds and executes a flow that follows the map-reduce pattern. -This works in 2 steps: -1. Mapping: Execute the mappingTask to transform from Input -> Output -2. Reduction: Find suitable pairs and merge them [Output, Output] -> Output - -We use this pattern extensively in our pipeline, - -## Type Parameters - -• **Input** - -• **Output** - -## Constructors - -### new ReductionTaskFlow() - -> **new ReductionTaskFlow**\<`Input`, `Output`\>(`options`, `flowCreator`): [`ReductionTaskFlow`](ReductionTaskFlow.md)\<`Input`, `Output`\> - -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L37) - -#### Parameters - -##### options - -###### inputLength - -`number` - -###### mappingTask - -[`Task`](../interfaces/Task.md)\<`Input`, `Output`\> - -###### mergableFunction - -(`a`, `b`) => `boolean` - -###### name - -`string` - -###### reductionTask - -[`Task`](../interfaces/Task.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<`Output`\>, `Output`\> - -##### flowCreator - -[`FlowCreator`](FlowCreator.md) - -#### Returns - -[`ReductionTaskFlow`](ReductionTaskFlow.md)\<`Input`, `Output`\> - -## Methods - -### deferErrorsTo() - -> **deferErrorsTo**(`flow`): `void` - -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:184](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L184) - -To be used in conjunction with onCompletion -It allows errors from this flow to be "defered" to another parent -flow which might be properly awaited and therefore will throw the -error up to the user - -#### Parameters - -##### flow - -[`Flow`](Flow.md)\<`unknown`\> - -#### Returns - -`void` - -*** - -### execute() - -> **execute**(`inputs`): `Promise`\<`Output`\> - -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:193](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L193) - -Execute the flow using the returned Promise that resolved when -the flow is finished - -#### Parameters - -##### inputs - -`Input`[] = `[]` - -initial inputs - doesnt have to be the complete set of inputs - -#### Returns - -`Promise`\<`Output`\> - -*** - -### onCompletion() - -> **onCompletion**(`callback`): `void` - -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:173](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L173) - -Execute the flow using a callback method that is invoked upon -completion of the flow. -Push inputs using pushInput() - -#### Parameters - -##### callback - -(`output`) => `Promise`\<`void`\> - -#### Returns - -`void` - -*** - -### pushInput() - -> **pushInput**(`input`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:205](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L205) - -#### Parameters - -##### input - -`Input` - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md deleted file mode 100644 index cad1c8f..0000000 --- a/src/pages/docs/reference/sequencer/classes/RuntimeProofParametersSerializer.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: RuntimeProofParametersSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / RuntimeProofParametersSerializer - -# Class: RuntimeProofParametersSerializer - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L11) - -## Implements - -- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md)\> - -## Constructors - -### new RuntimeProofParametersSerializer() - -> **new RuntimeProofParametersSerializer**(): [`RuntimeProofParametersSerializer`](RuntimeProofParametersSerializer.md) - -#### Returns - -[`RuntimeProofParametersSerializer`](RuntimeProofParametersSerializer.md) - -## Methods - -### fromJSON() - -> **fromJSON**(`json`): [`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L29) - -#### Parameters - -##### json - -`string` - -#### Returns - -[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md) - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) - -*** - -### toJSON() - -> **toJSON**(`parameters`): `string` - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeProofParametersSerializer.ts#L14) - -#### Parameters - -##### parameters - -[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md) - -#### Returns - -`string` - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md b/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md deleted file mode 100644 index 01d3cb0..0000000 --- a/src/pages/docs/reference/sequencer/classes/RuntimeProvingTask.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -title: RuntimeProvingTask ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / RuntimeProvingTask - -# Class: RuntimeProvingTask - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L36) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`TaskWorkerModule`](TaskWorkerModule.md) - -## Implements - -- [`Task`](../interfaces/Task.md)\<[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md), `RuntimeProof`\> - -## Constructors - -### new RuntimeProvingTask() - -> **new RuntimeProvingTask**(`runtime`, `executionContext`, `compileRegistry`): [`RuntimeProvingTask`](RuntimeProvingTask.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L45) - -#### Parameters - -##### runtime - -[`Runtime`](../../module/classes/Runtime.md)\<`never`\> - -##### executionContext - -[`RuntimeMethodExecutionContext`](../../protocol/classes/RuntimeMethodExecutionContext.md) - -##### compileRegistry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -[`RuntimeProvingTask`](RuntimeProvingTask.md) - -#### Overrides - -[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) - -*** - -### name - -> **name**: `string` = `"runtimeProof"` - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L43) - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) - -*** - -### runtime - -> `protected` `readonly` **runtime**: [`Runtime`](../../module/classes/Runtime.md)\<`never`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L46) - -*** - -### runtimeZkProgrammable - -> `protected` `readonly` **runtimeZkProgrammable**: [`PlainZkProgram`](../../common/interfaces/PlainZkProgram.md)\<[`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\>[] - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L40) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) - -## Methods - -### compute() - -> **compute**(`input`): `Promise`\<`RuntimeProof`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L61) - -#### Parameters - -##### input - -[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md) - -#### Returns - -`Promise`\<`RuntimeProof`\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) - -*** - -### inputSerializer() - -> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L53) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`RuntimeProofParameters`](../interfaces/RuntimeProofParameters.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) - -*** - -### prepare() - -> **prepare**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:107](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L107) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) - -*** - -### resultSerializer() - -> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<`RuntimeProof`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L57) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<`RuntimeProof`\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md b/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md deleted file mode 100644 index 46c6709..0000000 --- a/src/pages/docs/reference/sequencer/classes/RuntimeVerificationKeyAttestationSerializer.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: RuntimeVerificationKeyAttestationSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / RuntimeVerificationKeyAttestationSerializer - -# Class: RuntimeVerificationKeyAttestationSerializer - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L9) - -## Constructors - -### new RuntimeVerificationKeyAttestationSerializer() - -> **new RuntimeVerificationKeyAttestationSerializer**(): [`RuntimeVerificationKeyAttestationSerializer`](RuntimeVerificationKeyAttestationSerializer.md) - -#### Returns - -[`RuntimeVerificationKeyAttestationSerializer`](RuntimeVerificationKeyAttestationSerializer.md) - -## Methods - -### fromJSON() - -> `static` **fromJSON**(`json`): [`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L10) - -#### Parameters - -##### json - -###### verificationKey - -\{ `data`: `string`; `hash`: `string`; \} - -###### verificationKey.data - -`string` - -###### verificationKey.hash - -`string` - -###### witness - -\{ `isLeft`: `boolean`[]; `path`: `string`[]; \} - -###### witness.isLeft - -`boolean`[] - -###### witness.path - -`string`[] - -#### Returns - -[`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) - -*** - -### toJSON() - -> `static` **toJSON**(`attestation`): `object` - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/RuntimeVerificationKeyAttestationSerializer.ts#L20) - -#### Parameters - -##### attestation - -[`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) - -#### Returns - -`object` - -##### verificationKey - -> **verificationKey**: [`VerificationKeyJSON`](../type-aliases/VerificationKeyJSON.md) - -##### witness - -> **witness**: `object` - -###### witness.isLeft - -> **witness.isLeft**: `boolean`[] - -###### witness.path - -> **witness.path**: `string`[] diff --git a/src/pages/docs/reference/sequencer/classes/Sequencer.md b/src/pages/docs/reference/sequencer/classes/Sequencer.md deleted file mode 100644 index bd55ea3..0000000 --- a/src/pages/docs/reference/sequencer/classes/Sequencer.md +++ /dev/null @@ -1,687 +0,0 @@ ---- -title: Sequencer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Sequencer - -# Class: Sequencer\ - -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L30) - -Reusable module container facilitating registration, resolution -configuration, decoration and validation of modules - -## Extends - -- [`ModuleContainer`](../../common/classes/ModuleContainer.md)\<`Modules`\> - -## Type Parameters - -• **Modules** *extends* [`SequencerModulesRecord`](../type-aliases/SequencerModulesRecord.md) - -## Implements - -- [`Sequenceable`](../interfaces/Sequenceable.md) - -## Constructors - -### new Sequencer() - -> **new Sequencer**\<`Modules`\>(`definition`): [`Sequencer`](Sequencer.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:68 - -#### Parameters - -##### definition - -[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -#### Returns - -[`Sequencer`](Sequencer.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`constructor`](../../common/classes/ModuleContainer.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`currentConfig`](../../common/classes/ModuleContainer.md#currentconfig) - -*** - -### definition - -> **definition**: [`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:60 - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`definition`](../../common/classes/ModuleContainer.md#definition-1) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): [`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:116 - -##### Returns - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:117 - -##### Parameters - -###### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -##### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`config`](../../common/classes/ModuleContainer.md#config) - -*** - -### container - -#### Get Signature - -> **get** `protected` **container**(): `DependencyContainer` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:81 - -##### Returns - -`DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`container`](../../common/classes/ModuleContainer.md#container) - -*** - -### dependencyContainer - -#### Get Signature - -> **get** **dependencyContainer**(): `DependencyContainer` - -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L61) - -##### Returns - -`DependencyContainer` - -*** - -### events - -#### Get Signature - -> **get** **events**(): [`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:99 - -##### Returns - -[`EventEmitterProxy`](../../common/classes/EventEmitterProxy.md)\<`Modules`\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`events`](../../common/classes/ModuleContainer.md#events) - -*** - -### moduleNames - -#### Get Signature - -> **get** **moduleNames**(): `string`[] - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:72 - -##### Returns - -`string`[] - -list of module names - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`moduleNames`](../../common/classes/ModuleContainer.md#modulenames) - -*** - -### protocol - -#### Get Signature - -> **get** **protocol**(): [`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> - -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L53) - -##### Returns - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> - -*** - -### runtime - -#### Get Signature - -> **get** **runtime**(): [`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> - -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L49) - -##### Returns - -[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> - -## Methods - -### assertContainerInitialized() - -> **assertContainerInitialized**(`container`): `asserts container is DependencyContainer` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:89 - -#### Parameters - -##### container - -`undefined` | `DependencyContainer` - -#### Returns - -`asserts container is DependencyContainer` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertContainerInitialized`](../../common/classes/ModuleContainer.md#assertcontainerinitialized) - -*** - -### assertIsValidModuleName() - -> **assertIsValidModuleName**(`moduleName`): `asserts moduleName is StringKeyOf` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:87 - -Assert that the iterated `moduleName` is of ModuleName type, -otherwise it may be just string e.g. when modules are iterated over -using e.g. a for loop. - -#### Parameters - -##### moduleName - -`string` - -#### Returns - -`asserts moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`assertIsValidModuleName`](../../common/classes/ModuleContainer.md#assertisvalidmodulename) - -*** - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:128](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L128) - -#### Returns - -`Promise`\<`void`\> - -*** - -### configure() - -> **configure**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:114 - -Provide additional configuration after the ModuleContainer was created. - -Keep in mind that modules are only decorated once after they are resolved, -therefore applying any configuration must happen -before the first resolution. - -#### Parameters - -##### config - -[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configure`](../../common/classes/ModuleContainer.md#configure) - -*** - -### configurePartial() - -> **configurePartial**(`config`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:115 - -#### Parameters - -##### config - -[`RecursivePartial`](../../common/type-aliases/RecursivePartial.md)\<[`ModulesConfig`](../../common/type-aliases/ModulesConfig.md)\<`Modules`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`configurePartial`](../../common/classes/ModuleContainer.md#configurepartial) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:160 - -This is a placeholder for individual modules to override. -This method will be called whenever the underlying container fully -initialized - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`create`](../../common/classes/ModuleContainer.md#create) - -*** - -### decorateModule() - -> `protected` **decorateModule**(`moduleName`, `containedModule`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:134 - -Override this in the child class to provide custom -features or module checks - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -`InstanceType`\<`Modules`\[[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>\]\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`decorateModule`](../../common/classes/ModuleContainer.md#decoratemodule) - -*** - -### initializeDependencyFactories() - -> `protected` **initializeDependencyFactories**(`factories`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:140 - -Inject a set of dependencies using the given list of DependencyFactories -This method should be called during startup - -#### Parameters - -##### factories - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\>[] - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`initializeDependencyFactories`](../../common/classes/ModuleContainer.md#initializedependencyfactories) - -*** - -### isValidModuleName() - -> **isValidModuleName**(`modules`, `moduleName`): `moduleName is StringKeyOf` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:88 - -#### Parameters - -##### modules - -`Modules` - -##### moduleName - -`string` | `number` | `symbol` - -#### Returns - -`moduleName is StringKeyOf` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`isValidModuleName`](../../common/classes/ModuleContainer.md#isvalidmodulename) - -*** - -### onAfterModuleResolution() - -> `protected` **onAfterModuleResolution**(`moduleName`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:154 - -Handle module resolution, e.g. by decorating resolved modules - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`onAfterModuleResolution`](../../common/classes/ModuleContainer.md#onaftermoduleresolution) - -*** - -### registerAliases() - -> `protected` **registerAliases**(`originalToken`, `clas`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:90 - -#### Parameters - -##### originalToken - -`string` - -##### clas - -[`TypedClass`](../type-aliases/TypedClass.md)\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerAliases`](../../common/classes/ModuleContainer.md#registeraliases) - -*** - -### registerClasses() - -> `protected` **registerClasses**(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:105 - -#### Parameters - -##### modules - -`Record`\<`string`, [`TypedClass`](../type-aliases/TypedClass.md)\<`unknown`\>\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerClasses`](../../common/classes/ModuleContainer.md#registerclasses) - -*** - -### registerModules() - -> `protected` **registerModules**(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:98 - -Register modules into the current container, and registers -a respective resolution hook in order to decorate the module -upon/after resolution. - -#### Parameters - -##### modules - -`Modules` - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerModules`](../../common/classes/ModuleContainer.md#registermodules) - -*** - -### registerValue() - -> **registerValue**\<`Value`\>(`modules`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:104 - -Register a non-module value into the current container - -#### Type Parameters - -• **Value** - -#### Parameters - -##### modules - -`Record`\<`string`, `Value`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`registerValue`](../../common/classes/ModuleContainer.md#registervalue) - -*** - -### resolve() - -> **resolve**\<`KeyType`\>(`moduleName`): `InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:128 - -Resolves a module from the current module container - -We have to narrow down the `ModuleName` type here to -`ResolvableModuleName`, otherwise the resolved value might -be any module instance, not the one specifically requested as argument. - -#### Type Parameters - -• **KeyType** *extends* `string` - -#### Parameters - -##### moduleName - -`KeyType` - -#### Returns - -`InstanceType`\<[`ResolvableModules`](../../common/type-aliases/ResolvableModules.md)\<`Modules`\>\[`KeyType`\]\> - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolve`](../../common/classes/ModuleContainer.md#resolve) - -*** - -### resolveOrFail() - -> **resolveOrFail**\<`ModuleType`\>(`moduleName`, `moduleType`): `ModuleType` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:129 - -#### Type Parameters - -• **ModuleType** - -#### Parameters - -##### moduleName - -`string` - -##### moduleType - -[`TypedClass`](../type-aliases/TypedClass.md)\<`ModuleType`\> - -#### Returns - -`ModuleType` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`resolveOrFail`](../../common/classes/ModuleContainer.md#resolveorfail) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:69](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L69) - -Starts the sequencer by iterating over all provided -modules to start each - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Sequenceable`](../interfaces/Sequenceable.md).[`start`](../interfaces/Sequenceable.md#start) - -*** - -### validateModule() - -> `protected` **validateModule**(`moduleName`, `containedModule`): `void` - -Defined in: packages/common/dist/config/ModuleContainer.d.ts:80 - -Check if the provided module satisfies the container requirements, -such as only injecting other known modules. - -#### Parameters - -##### moduleName - -[`StringKeyOf`](../../common/type-aliases/StringKeyOf.md)\<`Modules`\> - -##### containedModule - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`unknown`\> - -#### Returns - -`void` - -#### Inherited from - -[`ModuleContainer`](../../common/classes/ModuleContainer.md).[`validateModule`](../../common/classes/ModuleContainer.md#validatemodule) - -*** - -### from() - -> `static` **from**\<`Modules`\>(`definition`): [`TypedClass`](../type-aliases/TypedClass.md)\<[`Sequencer`](Sequencer.md)\<`Modules`\>\> - -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L39) - -Alternative constructor for Sequencer - -#### Type Parameters - -• **Modules** *extends* [`SequencerModulesRecord`](../type-aliases/SequencerModulesRecord.md) - -#### Parameters - -##### definition - -[`ModuleContainerDefinition`](../../common/interfaces/ModuleContainerDefinition.md)\<`Modules`\> - -#### Returns - -[`TypedClass`](../type-aliases/TypedClass.md)\<[`Sequencer`](Sequencer.md)\<`Modules`\>\> - -Sequencer diff --git a/src/pages/docs/reference/sequencer/classes/SequencerModule.md b/src/pages/docs/reference/sequencer/classes/SequencerModule.md deleted file mode 100644 index e4c4f05..0000000 --- a/src/pages/docs/reference/sequencer/classes/SequencerModule.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: SequencerModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SequencerModule - -# Class: `abstract` SequencerModule\ - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L15) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<`Config`\> - -## Extended by - -- [`PrivateMempool`](PrivateMempool.md) -- [`AbstractTaskQueue`](AbstractTaskQueue.md) -- [`MinaBaseLayer`](MinaBaseLayer.md) -- [`NoopBaseLayer`](NoopBaseLayer.md) -- [`BlockTriggerBase`](BlockTriggerBase.md) -- [`BatchProducerModule`](BatchProducerModule.md) -- [`BlockProducerModule`](BlockProducerModule.md) -- [`SequencerStartupModule`](SequencerStartupModule.md) -- [`InMemoryDatabase`](InMemoryDatabase.md) -- [`DatabasePruneModule`](DatabasePruneModule.md) -- [`SettlementModule`](SettlementModule.md) -- [`WithdrawalQueue`](WithdrawalQueue.md) -- [`GraphqlServer`](../../api/classes/GraphqlServer.md) -- [`IndexerNotifier`](../../indexer/classes/IndexerNotifier.md) -- [`PrismaDatabaseConnection`](../../persistance/classes/PrismaDatabaseConnection.md) -- [`PrismaRedisDatabase`](../../persistance/classes/PrismaRedisDatabase.md) -- [`RedisConnectionModule`](../../persistance/classes/RedisConnectionModule.md) - -## Type Parameters - -• **Config** = [`NoConfig`](../../common/type-aliases/NoConfig.md) - -## Constructors - -### new SequencerModule() - -> **new SequencerModule**\<`Config`\>(): [`SequencerModule`](SequencerModule.md)\<`Config`\> - -#### Returns - -[`SequencerModule`](SequencerModule.md)\<`Config`\> - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) - -*** - -### start() - -> `abstract` **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L26) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md b/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md deleted file mode 100644 index 8ff9424..0000000 --- a/src/pages/docs/reference/sequencer/classes/SequencerStartupModule.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -title: SequencerStartupModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SequencerStartupModule - -# Class: SequencerStartupModule - -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L28) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](SequencerModule.md) - -## Implements - -- [`Closeable`](../interfaces/Closeable.md) - -## Constructors - -### new SequencerStartupModule() - -> **new SequencerStartupModule**(`flowCreator`, `protocol`, `compileTask`, `verificationKeyService`, `registrationFlow`, `compileRegistry`): [`SequencerStartupModule`](SequencerStartupModule.md) - -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L32) - -#### Parameters - -##### flowCreator - -[`FlowCreator`](FlowCreator.md) - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> - -##### compileTask - -`CircuitCompilerTask` - -##### verificationKeyService - -`VerificationKeyService` - -##### registrationFlow - -`WorkerRegistrationFlow` - -##### compileRegistry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -[`SequencerStartupModule`](SequencerStartupModule.md) - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:153](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L153) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Closeable`](../interfaces/Closeable.md).[`close`](../interfaces/Closeable.md#close) - -*** - -### compileRuntime() - -> **compileRuntime**(`flow`): `Promise`\<`bigint`\> - -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L55) - -#### Parameters - -##### flow - -[`Flow`](Flow.md)\<\{\}\> - -#### Returns - -`Promise`\<`bigint`\> - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/sequencer/SequencerStartupModule.ts:122](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/SequencerStartupModule.ts#L122) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/SettlementModule.md b/src/pages/docs/reference/sequencer/classes/SettlementModule.md deleted file mode 100644 index 3d86039..0000000 --- a/src/pages/docs/reference/sequencer/classes/SettlementModule.md +++ /dev/null @@ -1,422 +0,0 @@ ---- -title: SettlementModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettlementModule - -# Class: SettlementModule - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L62) - -Lifecycle of a SequencerModule - -start(): Executed to execute any logic required to start the module - -## Extends - -- [`SequencerModule`](SequencerModule.md)\<[`SettlementModuleConfig`](../interfaces/SettlementModuleConfig.md)\> - -## Implements - -- [`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md)\<[`SettlementModuleEvents`](../type-aliases/SettlementModuleEvents.md)\> -- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) - -## Constructors - -### new SettlementModule() - -> **new SettlementModule**(`baseLayer`, `protocol`, `incomingMessagesAdapter`, `messageStorage`, `blockProofSerializer`, `transactionSender`, `areProofsEnabled`, `feeStrategy`, `settlementStartupModule`): [`SettlementModule`](SettlementModule.md) - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:86](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L86) - -#### Parameters - -##### baseLayer - -[`MinaBaseLayer`](MinaBaseLayer.md) - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> - -##### incomingMessagesAdapter - -[`IncomingMessageAdapter`](../interfaces/IncomingMessageAdapter.md) - -##### messageStorage - -[`MessageStorage`](../interfaces/MessageStorage.md) - -##### blockProofSerializer - -[`BlockProofSerializer`](BlockProofSerializer.md) - -##### transactionSender - -[`MinaTransactionSender`](MinaTransactionSender.md) - -##### areProofsEnabled - -[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -##### feeStrategy - -`FeeStrategy` - -##### settlementStartupModule - -`SettlementStartupModule` - -#### Returns - -[`SettlementModule`](SettlementModule.md) - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### addresses? - -> `optional` **addresses**: `object` - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L71) - -#### dispatch - -> **dispatch**: `PublicKey` - -#### settlement - -> **settlement**: `PublicKey` - -*** - -### contracts? - -> `protected` `optional` **contracts**: `object` - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L66) - -#### dispatch - -> **dispatch**: [`DispatchSmartContract`](../../protocol/classes/DispatchSmartContract.md) - -#### settlement - -> **settlement**: [`SettlementSmartContract`](../../protocol/classes/SettlementSmartContract.md) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`SettlementModuleConfig`](../interfaces/SettlementModuleConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### events - -> **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`SettlementModuleEvents`](../type-aliases/SettlementModuleEvents.md)\> - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L84) - -#### Implementation of - -[`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md).[`events`](../../common/interfaces/EventEmittingComponent.md#events) - -*** - -### keys? - -> `optional` **keys**: `object` - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:76](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L76) - -#### dispatch - -> **dispatch**: `PrivateKey` - -#### minaBridge - -> **minaBridge**: `PrivateKey` - -#### settlement - -> **settlement**: `PrivateKey` - -*** - -### utils - -> **utils**: `SettlementUtils` - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:82](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L82) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### dependencies() - -> **dependencies**(): `object` - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:106](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L106) - -#### Returns - -`object` - -##### BridgingModule - -> **BridgingModule**: `object` - -###### BridgingModule.useClass - -> **BridgingModule.useClass**: *typeof* `BridgingModule` = `BridgingModule` - -#### Implementation of - -[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) - -*** - -### deploy() - -> **deploy**(`settlementKey`, `dispatchKey`, `minaBridgeKey`, `options`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:243](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L243) - -#### Parameters - -##### settlementKey - -`PrivateKey` - -##### dispatchKey - -`PrivateKey` - -##### minaBridgeKey - -`PrivateKey` - -##### options - -###### nonce - -`number` - -#### Returns - -`Promise`\<`void`\> - -*** - -### deployTokenBridge() - -> **deployTokenBridge**(`owner`, `ownerKey`, `contractKey`, `options`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:343](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L343) - -#### Parameters - -##### owner - -`TokenContractV2` - -##### ownerKey - -`PrivateKey` - -##### contractKey - -`PrivateKey` - -##### options - -###### nonce - -`number` - -#### Returns - -`Promise`\<`void`\> - -*** - -### getContracts() - -> **getContracts**(): `object` - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:127](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L127) - -#### Returns - -`object` - -##### dispatch - -> **dispatch**: [`DispatchSmartContract`](../../protocol/classes/DispatchSmartContract.md) - -##### settlement - -> **settlement**: [`SettlementSmartContract`](../../protocol/classes/SettlementSmartContract.md) - -*** - -### settleBatch() - -> **settleBatch**(`batch`, `options`): `Promise`\<[`Settlement`](../interfaces/Settlement.md)\> - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:164](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L164) - -#### Parameters - -##### batch - -[`SettleableBatch`](../interfaces/SettleableBatch.md) - -##### options - -###### nonce - -`number` - -#### Returns - -`Promise`\<[`Settlement`](../interfaces/Settlement.md)\> - -*** - -### settlementContractModule() - -> `protected` **settlementContractModule**(): [`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md)\<[`MandatorySettlementModulesRecord`](../../protocol/type-aliases/MandatorySettlementModulesRecord.md)\> - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L114) - -#### Returns - -[`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md)\<[`MandatorySettlementModulesRecord`](../../protocol/type-aliases/MandatorySettlementModulesRecord.md)\> - -*** - -### signTransaction() - -> **signTransaction**(`tx`, `pks`): `Transaction`\<`false`, `true`\> - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:149](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L149) - -#### Parameters - -##### tx - -`Transaction`\<`false`, `false`\> - -##### pks - -`PrivateKey`[] - -#### Returns - -`Transaction`\<`false`, `true`\> - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:387](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L387) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md b/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md deleted file mode 100644 index 938dca4..0000000 --- a/src/pages/docs/reference/sequencer/classes/SettlementProvingTask.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -title: SettlementProvingTask ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettlementProvingTask - -# Class: SettlementProvingTask - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L72) - -Implementation of a task to prove any Mina transaction. -The o1js-internal account state is configurable via the task args. -It also dynamically retrieves the proof generation parameters from -the provided AccountUpdate - -## Extends - -- [`TaskWorkerModule`](TaskWorkerModule.md) - -## Implements - -- [`Task`](../interfaces/Task.md)\<[`TransactionTaskArgs`](../type-aliases/TransactionTaskArgs.md), [`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> - -## Constructors - -### new SettlementProvingTask() - -> **new SettlementProvingTask**(`protocol`, `compileRegistry`, `areProofsEnabled`): [`SettlementProvingTask`](SettlementProvingTask.md) - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:84](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L84) - -#### Parameters - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md)\> - -##### compileRegistry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -##### areProofsEnabled - -[`AreProofsEnabled`](../../common/interfaces/AreProofsEnabled.md) - -#### Returns - -[`SettlementProvingTask`](SettlementProvingTask.md) - -#### Overrides - -[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) - -*** - -### name - -> **name**: `string` = `"settlementTransactions"` - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:76](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L76) - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) - -*** - -### settlementContractModule - -> **settlementContractModule**: `undefined` \| [`SettlementContractModule`](../../protocol/classes/SettlementContractModule.md)\<[`MandatorySettlementModulesRecord`](../../protocol/type-aliases/MandatorySettlementModulesRecord.md)\> = `undefined` - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L78) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) - -## Methods - -### compute() - -> **compute**(`input`): `Promise`\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:125](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L125) - -#### Parameters - -##### input - -[`TransactionTaskArgs`](../type-aliases/TransactionTaskArgs.md) - -#### Returns - -`Promise`\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) - -*** - -### inputSerializer() - -> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskArgs`](../type-aliases/TransactionTaskArgs.md)\> - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:158](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L158) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskArgs`](../type-aliases/TransactionTaskArgs.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) - -*** - -### prepare() - -> **prepare**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:395](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L395) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) - -*** - -### resultSerializer() - -> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:432](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L432) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionTaskResult`](../type-aliases/TransactionTaskResult.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md b/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md deleted file mode 100644 index 5e68a50..0000000 --- a/src/pages/docs/reference/sequencer/classes/SignedSettlementPermissions.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: SignedSettlementPermissions ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SignedSettlementPermissions - -# Class: SignedSettlementPermissions - -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L5) - -## Implements - -- [`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md) - -## Constructors - -### new SignedSettlementPermissions() - -> **new SignedSettlementPermissions**(): [`SignedSettlementPermissions`](SignedSettlementPermissions.md) - -#### Returns - -[`SignedSettlementPermissions`](SignedSettlementPermissions.md) - -## Methods - -### bridgeContractMina() - -> **bridgeContractMina**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L28) - -#### Returns - -`Permissions` - -#### Implementation of - -[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`bridgeContractMina`](../interfaces/BaseLayerContractPermissions.md#bridgecontractmina) - -*** - -### bridgeContractToken() - -> **bridgeContractToken**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L32) - -#### Returns - -`Permissions` - -#### Implementation of - -[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`bridgeContractToken`](../interfaces/BaseLayerContractPermissions.md#bridgecontracttoken) - -*** - -### dispatchContract() - -> **dispatchContract**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L20) - -#### Returns - -`Permissions` - -#### Implementation of - -[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`dispatchContract`](../interfaces/BaseLayerContractPermissions.md#dispatchcontract) - -*** - -### settlementContract() - -> **settlementContract**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/SignedSettlementPermissions.ts#L24) - -#### Returns - -`Permissions` - -#### Implementation of - -[`BaseLayerContractPermissions`](../interfaces/BaseLayerContractPermissions.md).[`settlementContract`](../interfaces/BaseLayerContractPermissions.md#settlementcontract) diff --git a/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md b/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md deleted file mode 100644 index 9b392a1..0000000 --- a/src/pages/docs/reference/sequencer/classes/SomeProofSubclass.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -title: SomeProofSubclass ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SomeProofSubclass - -# Class: SomeProofSubclass - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L58) - -## Extends - -- `Proof`\<`Field`, `Void`\> - -## Constructors - -### new SomeProofSubclass() - -> **new SomeProofSubclass**(`__namedParameters`): [`SomeProofSubclass`](SomeProofSubclass.md) - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:94 - -#### Parameters - -##### \_\_namedParameters - -###### maxProofsVerified - -`0` \| `1` \| `2` - -###### proof - -`unknown` - -###### publicInput - -`Field` - -###### publicOutput - -`undefined` - -#### Returns - -[`SomeProofSubclass`](SomeProofSubclass.md) - -#### Inherited from - -`Proof.constructor` - -## Properties - -### maxProofsVerified - -> **maxProofsVerified**: `0` \| `1` \| `2` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:91 - -#### Inherited from - -`Proof.maxProofsVerified` - -*** - -### proof - -> **proof**: `unknown` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:90 - -#### Inherited from - -`Proof.proof` - -*** - -### publicInput - -> **publicInput**: `Field` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:88 - -#### Inherited from - -`Proof.publicInput` - -*** - -### publicOutput - -> **publicOutput**: `undefined` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:89 - -#### Inherited from - -`Proof.publicOutput` - -*** - -### shouldVerify - -> **shouldVerify**: `Bool` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:92 - -#### Inherited from - -`Proof.shouldVerify` - -*** - -### publicInputType - -> `static` **publicInputType**: *typeof* `Field` & (`x`) => `Field` = `Field` - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L59) - -#### Overrides - -`Proof.publicInputType` - -*** - -### publicOutputType - -> `static` **publicOutputType**: `ProvablePureExtended`\<`void`, `void`, `null`\> = `Void` - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L61) - -#### Overrides - -`Proof.publicOutputType` - -*** - -### tag() - -> `static` **tag**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:85 - -#### Returns - -`object` - -##### name - -> **name**: `string` - -#### Inherited from - -`Proof.tag` - -## Methods - -### toJSON() - -> **toJSON**(): `JsonProof` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:93 - -#### Returns - -`JsonProof` - -#### Inherited from - -`Proof.toJSON` - -*** - -### verify() - -> **verify**(): `void` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:102 - -#### Returns - -`void` - -#### Inherited from - -`Proof.verify` - -*** - -### verifyIf() - -> **verifyIf**(`condition`): `void` - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:103 - -#### Parameters - -##### condition - -`Bool` - -#### Returns - -`void` - -#### Inherited from - -`Proof.verifyIf` - -*** - -### dummy() - -> `static` **dummy**\<`Input`, `OutPut`\>(`publicInput`, `publicOutput`, `maxProofsVerified`, `domainLog2`?): `Promise`\<`Proof`\<`Input`, `OutPut`\>\> - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:126 - -Dummy proof. This can be useful for ZkPrograms that handle the base case in the same -method as the inductive case, using a pattern like this: - -```ts -method(proof: SelfProof, isRecursive: Bool) { - proof.verifyIf(isRecursive); - // ... -} -``` - -To use such a method in the base case, you need a dummy proof: - -```ts -let dummy = await MyProof.dummy(publicInput, publicOutput, 1); -await myProgram.myMethod(dummy, Bool(false)); -``` - -**Note**: The types of `publicInput` and `publicOutput`, as well as the `maxProofsVerified` parameter, -must match your ZkProgram. `maxProofsVerified` is the maximum number of proofs that any of your methods take as arguments. - -#### Type Parameters - -• **Input** - -• **OutPut** - -#### Parameters - -##### publicInput - -`Input` - -##### publicOutput - -`OutPut` - -##### maxProofsVerified - -`0` | `1` | `2` - -##### domainLog2? - -`number` - -#### Returns - -`Promise`\<`Proof`\<`Input`, `OutPut`\>\> - -#### Inherited from - -`Proof.dummy` - -*** - -### fromJSON() - -> `static` **fromJSON**\<`S`\>(`this`, `__namedParameters`): `Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -Defined in: node\_modules/o1js/dist/node/lib/proof-system/zkprogram.d.ts:104 - -#### Type Parameters - -• **S** *extends* `Subclass`\<*typeof* `Proof`\> - -#### Parameters - -##### this - -`S` - -##### \_\_namedParameters - -`JsonProof` - -#### Returns - -`Promise`\<`Proof`\<`InferProvable`\<`S`\[`"publicInputType"`\]\>, `InferProvable`\<`S`\[`"publicOutputType"`\]\>\>\> - -#### Inherited from - -`Proof.fromJSON` diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md b/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md deleted file mode 100644 index 2a5b4bd..0000000 --- a/src/pages/docs/reference/sequencer/classes/StateTransitionParametersSerializer.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: StateTransitionParametersSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateTransitionParametersSerializer - -# Class: StateTransitionParametersSerializer - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L21) - -## Implements - -- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md)\> - -## Constructors - -### new StateTransitionParametersSerializer() - -> **new StateTransitionParametersSerializer**(): [`StateTransitionParametersSerializer`](StateTransitionParametersSerializer.md) - -#### Returns - -[`StateTransitionParametersSerializer`](StateTransitionParametersSerializer.md) - -## Methods - -### fromJSON() - -> **fromJSON**(`json`): [`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L43) - -#### Parameters - -##### json - -`string` - -#### Returns - -[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md) - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) - -*** - -### toJSON() - -> **toJSON**(`parameters`): `string` - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/StateTransitionParametersSerializer.ts#L24) - -#### Parameters - -##### parameters - -[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md) - -#### Returns - -`string` - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md b/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md deleted file mode 100644 index be06999..0000000 --- a/src/pages/docs/reference/sequencer/classes/StateTransitionReductionTask.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -title: StateTransitionReductionTask ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateTransitionReductionTask - -# Class: StateTransitionReductionTask - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L24) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`TaskWorkerModule`](TaskWorkerModule.md) - -## Implements - -- [`Task`](../interfaces/Task.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\>, [`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -## Constructors - -### new StateTransitionReductionTask() - -> **new StateTransitionReductionTask**(`protocol`, `executionContext`, `compileRegistry`): [`StateTransitionReductionTask`](StateTransitionReductionTask.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L32) - -#### Parameters - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> - -##### executionContext - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md) - -##### compileRegistry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -[`StateTransitionReductionTask`](StateTransitionReductionTask.md) - -#### Overrides - -[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) - -*** - -### name - -> **name**: `string` = `"stateTransitionReduction"` - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L30) - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) - -*** - -### stateTransitionProver - -> `protected` `readonly` **stateTransitionProver**: [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L28) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) - -## Methods - -### compute() - -> **compute**(`input`): `Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L56) - -#### Parameters - -##### input - -[`PairTuple`](../type-aliases/PairTuple.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -#### Returns - -`Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) - -*** - -### inputSerializer() - -> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\>\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L44) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`PairTuple`](../type-aliases/PairTuple.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\>\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) - -*** - -### prepare() - -> **prepare**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L66) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) - -*** - -### resultSerializer() - -> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionReductionTask.ts#L50) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md b/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md deleted file mode 100644 index 552fffe..0000000 --- a/src/pages/docs/reference/sequencer/classes/StateTransitionTask.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -title: StateTransitionTask ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateTransitionTask - -# Class: StateTransitionTask - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L38) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`TaskWorkerModule`](TaskWorkerModule.md) - -## Implements - -- [`Task`](../interfaces/Task.md)\<[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md), [`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -## Constructors - -### new StateTransitionTask() - -> **new StateTransitionTask**(`protocol`, `executionContext`, `compileRegistry`): [`StateTransitionTask`](StateTransitionTask.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L46) - -#### Parameters - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> - -##### executionContext - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md) - -##### compileRegistry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -[`StateTransitionTask`](StateTransitionTask.md) - -#### Overrides - -[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) - -*** - -### name - -> **name**: `string` = `"stateTransitionProof"` - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L44) - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) - -*** - -### stateTransitionProver - -> `protected` `readonly` **stateTransitionProver**: [`StateTransitionProvable`](../../protocol/interfaces/StateTransitionProvable.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L42) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) - -## Methods - -### compute() - -> **compute**(`input`): `Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L68) - -#### Parameters - -##### input - -[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md) - -#### Returns - -`Promise`\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) - -*** - -### inputSerializer() - -> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L58) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProofParameters`](../interfaces/StateTransitionProofParameters.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) - -*** - -### prepare() - -> **prepare**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L88) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) - -*** - -### resultSerializer() - -> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L62) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md b/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md deleted file mode 100644 index cfa0b5b..0000000 --- a/src/pages/docs/reference/sequencer/classes/SyncCachedMerkleTreeStore.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: SyncCachedMerkleTreeStore ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SyncCachedMerkleTreeStore - -# Class: SyncCachedMerkleTreeStore - -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L7) - -## Extends - -- [`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md) - -## Constructors - -### new SyncCachedMerkleTreeStore() - -> **new SyncCachedMerkleTreeStore**(`parent`): [`SyncCachedMerkleTreeStore`](SyncCachedMerkleTreeStore.md) - -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L8) - -#### Parameters - -##### parent - -[`MerkleTreeStore`](../../common/interfaces/MerkleTreeStore.md) - -#### Returns - -[`SyncCachedMerkleTreeStore`](SyncCachedMerkleTreeStore.md) - -#### Overrides - -[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`constructor`](../../common/classes/InMemoryMerkleTreeStorage.md#constructors) - -## Properties - -### nodes - -> `protected` **nodes**: `object` - -Defined in: packages/common/dist/trees/InMemoryMerkleTreeStorage.d.ts:3 - -#### Index Signature - -\[`key`: `number`\]: `object` - -#### Inherited from - -[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`nodes`](../../common/classes/InMemoryMerkleTreeStorage.md#nodes) - -## Methods - -### getNode() - -> **getNode**(`key`, `level`): `undefined` \| `bigint` - -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L12) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -#### Returns - -`undefined` \| `bigint` - -#### Overrides - -[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`getNode`](../../common/classes/InMemoryMerkleTreeStorage.md#getnode) - -*** - -### mergeIntoParent() - -> **mergeIntoParent**(): `void` - -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L20) - -#### Returns - -`void` - -*** - -### setNode() - -> **setNode**(`key`, `level`, `value`): `void` - -Defined in: [packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/merkle/SyncCachedMerkleTreeStore.ts#L16) - -#### Parameters - -##### key - -`bigint` - -##### level - -`number` - -##### value - -`bigint` - -#### Returns - -`void` - -#### Overrides - -[`InMemoryMerkleTreeStorage`](../../common/classes/InMemoryMerkleTreeStorage.md).[`setNode`](../../common/classes/InMemoryMerkleTreeStorage.md#setnode) diff --git a/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md b/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md deleted file mode 100644 index 36335cf..0000000 --- a/src/pages/docs/reference/sequencer/classes/TaskWorkerModule.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: TaskWorkerModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskWorkerModule - -# Class: `abstract` TaskWorkerModule - -Defined in: [packages/sequencer/src/worker/worker/TaskWorkerModule.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/TaskWorkerModule.ts#L3) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`ConfigurableModule`](../../common/classes/ConfigurableModule.md)\<[`NoConfig`](../../common/type-aliases/NoConfig.md)\> - -## Extended by - -- [`TransactionProvingTask`](TransactionProvingTask.md) -- [`RuntimeProvingTask`](RuntimeProvingTask.md) -- [`StateTransitionTask`](StateTransitionTask.md) -- [`StateTransitionReductionTask`](StateTransitionReductionTask.md) -- [`NewBlockTask`](NewBlockTask.md) -- [`SettlementProvingTask`](SettlementProvingTask.md) -- [`IndexBlockTask`](../../indexer/classes/IndexBlockTask.md) - -## Constructors - -### new TaskWorkerModule() - -> **new TaskWorkerModule**(): [`TaskWorkerModule`](TaskWorkerModule.md) - -#### Returns - -[`TaskWorkerModule`](TaskWorkerModule.md) - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`constructor`](../../common/classes/ConfigurableModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`currentConfig`](../../common/classes/ConfigurableModule.md#currentconfig) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`config`](../../common/classes/ConfigurableModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`ConfigurableModule`](../../common/classes/ConfigurableModule.md).[`create`](../../common/classes/ConfigurableModule.md#create) diff --git a/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md b/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md deleted file mode 100644 index 71edb16..0000000 --- a/src/pages/docs/reference/sequencer/classes/TimedBlockTrigger.md +++ /dev/null @@ -1,345 +0,0 @@ ---- -title: TimedBlockTrigger ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TimedBlockTrigger - -# Class: TimedBlockTrigger - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L36) - -A BlockTrigger is the primary method to start the production of a block and -all associated processes. - -## Extends - -- [`BlockTriggerBase`](BlockTriggerBase.md)\<[`TimedBlockTriggerConfig`](../interfaces/TimedBlockTriggerConfig.md), [`TimedBlockTriggerEvent`](../interfaces/TimedBlockTriggerEvent.md)\> - -## Implements - -- [`BlockTrigger`](../interfaces/BlockTrigger.md) -- [`Closeable`](../interfaces/Closeable.md) - -## Constructors - -### new TimedBlockTrigger() - -> **new TimedBlockTrigger**(`batchProducerModule`, `blockProducerModule`, `settlementModule`, `blockQueue`, `batchStorage`, `settlementStorage`, `mempool`): [`TimedBlockTrigger`](TimedBlockTrigger.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L44) - -#### Parameters - -##### batchProducerModule - -`undefined` | [`BatchProducerModule`](BatchProducerModule.md) - -##### blockProducerModule - -[`BlockProducerModule`](BlockProducerModule.md) - -##### settlementModule - -`undefined` | [`SettlementModule`](SettlementModule.md) - -##### blockQueue - -[`BlockQueue`](../interfaces/BlockQueue.md) - -##### batchStorage - -[`BatchStorage`](../interfaces/BatchStorage.md) - -##### settlementStorage - -`undefined` | [`SettlementStorage`](../interfaces/SettlementStorage.md) - -##### mempool - -[`Mempool`](../interfaces/Mempool.md) - -#### Returns - -[`TimedBlockTrigger`](TimedBlockTrigger.md) - -#### Overrides - -[`BlockTriggerBase`](BlockTriggerBase.md).[`constructor`](BlockTriggerBase.md#constructors) - -## Properties - -### batchProducerModule - -> `protected` `readonly` **batchProducerModule**: `undefined` \| [`BatchProducerModule`](BatchProducerModule.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L46) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`batchProducerModule`](BlockTriggerBase.md#batchproducermodule-1) - -*** - -### batchQueue - -> `protected` `readonly` **batchQueue**: [`BatchStorage`](../interfaces/BatchStorage.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L49) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`batchQueue`](BlockTriggerBase.md#batchqueue-1) - -*** - -### blockProducerModule - -> `protected` `readonly` **blockProducerModule**: [`BlockProducerModule`](BlockProducerModule.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L45) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`blockProducerModule`](BlockTriggerBase.md#blockproducermodule-1) - -*** - -### blockQueue - -> `protected` `readonly` **blockQueue**: [`BlockQueue`](../interfaces/BlockQueue.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L48) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`blockQueue`](BlockTriggerBase.md#blockqueue-1) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`TimedBlockTriggerConfig`](../interfaces/TimedBlockTriggerConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`currentConfig`](BlockTriggerBase.md#currentconfig) - -*** - -### events - -> `readonly` **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<[`TimedBlockTriggerEvent`](../interfaces/TimedBlockTriggerEvent.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L42) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`events`](BlockTriggerBase.md#events) - -*** - -### settlementModule - -> `protected` `readonly` **settlementModule**: `undefined` \| [`SettlementModule`](SettlementModule.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L47) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`settlementModule`](BlockTriggerBase.md#settlementmodule-1) - -*** - -### settlementStorage - -> `protected` `readonly` **settlementStorage**: `undefined` \| [`SettlementStorage`](../interfaces/SettlementStorage.md) - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L50) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`settlementStorage`](BlockTriggerBase.md#settlementstorage-1) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`presets`](BlockTriggerBase.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`config`](BlockTriggerBase.md#config) - -## Methods - -### close() - -> **close**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:137](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L137) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Closeable`](../interfaces/Closeable.md).[`close`](../interfaces/Closeable.md#close) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`create`](BlockTriggerBase.md#create) - -*** - -### produceBatch() - -> `protected` **produceBatch**(): `Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L55) - -#### Returns - -`Promise`\<`undefined` \| [`SettleableBatch`](../interfaces/SettleableBatch.md)\> - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBatch`](BlockTriggerBase.md#producebatch) - -*** - -### produceBlock() - -> `protected` **produceBlock**(): `Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L89) - -#### Returns - -`Promise`\<`undefined` \| [`Block`](../interfaces/Block.md)\> - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBlock`](BlockTriggerBase.md#produceblock) - -*** - -### produceBlockWithResult() - -> `protected` **produceBlockWithResult**(): `Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L68) - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithResult`](../interfaces/BlockWithResult.md)\> - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`produceBlockWithResult`](BlockTriggerBase.md#produceblockwithresult) - -*** - -### settle() - -> `protected` **settle**(`batch`): `Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L95) - -#### Parameters - -##### batch - -[`SettleableBatch`](../interfaces/SettleableBatch.md) - -#### Returns - -`Promise`\<`undefined` \| [`Settlement`](../interfaces/Settlement.md)\> - -#### Inherited from - -[`BlockTriggerBase`](BlockTriggerBase.md).[`settle`](BlockTriggerBase.md#settle) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:90](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L90) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`BlockTriggerBase`](BlockTriggerBase.md).[`start`](BlockTriggerBase.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md b/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md deleted file mode 100644 index 281579a..0000000 --- a/src/pages/docs/reference/sequencer/classes/TransactionExecutionService.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: TransactionExecutionService ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionExecutionService - -# Class: TransactionExecutionService - -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:153](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L153) - -## Constructors - -### new TransactionExecutionService() - -> **new TransactionExecutionService**(`runtime`, `protocol`, `stateServiceProvider`): [`TransactionExecutionService`](TransactionExecutionService.md) - -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:156](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L156) - -#### Parameters - -##### runtime - -[`Runtime`](../../module/classes/Runtime.md)\<[`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md)\> - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> - -##### stateServiceProvider - -[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) - -#### Returns - -[`TransactionExecutionService`](TransactionExecutionService.md) - -## Methods - -### createExecutionTrace() - -> **createExecutionTrace**(`asyncStateService`, `tx`, `networkState`): `Promise`\<[`TransactionExecutionResult`](../interfaces/TransactionExecutionResult.md)\> - -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:209](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L209) - -#### Parameters - -##### asyncStateService - -[`CachedStateService`](CachedStateService.md) - -##### tx - -[`PendingTransaction`](PendingTransaction.md) - -##### networkState - -[`NetworkState`](../../protocol/classes/NetworkState.md) - -#### Returns - -`Promise`\<[`TransactionExecutionResult`](../interfaces/TransactionExecutionResult.md)\> diff --git a/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md b/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md deleted file mode 100644 index f0a10bd..0000000 --- a/src/pages/docs/reference/sequencer/classes/TransactionProvingTask.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -title: TransactionProvingTask ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionProvingTask - -# Class: TransactionProvingTask - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L50) - -Used by various module sub-types that may need to be configured - -## Extends - -- [`TaskWorkerModule`](TaskWorkerModule.md) - -## Implements - -- [`Task`](../interfaces/Task.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md), [`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> - -## Constructors - -### new TransactionProvingTask() - -> **new TransactionProvingTask**(`protocol`, `runtime`, `stateServiceProvider`, `executionContext`, `compileRegistry`): [`TransactionProvingTask`](TransactionProvingTask.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L63) - -#### Parameters - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<[`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md)\> - -##### runtime - -[`Runtime`](../../module/classes/Runtime.md)\<`never`\> - -##### stateServiceProvider - -[`StateServiceProvider`](../../protocol/classes/StateServiceProvider.md) - -##### executionContext - -[`ProvableMethodExecutionContext`](../../common/classes/ProvableMethodExecutionContext.md) - -##### compileRegistry - -[`CompileRegistry`](../../common/classes/CompileRegistry.md) - -#### Returns - -[`TransactionProvingTask`](TransactionProvingTask.md) - -#### Overrides - -[`TaskWorkerModule`](TaskWorkerModule.md).[`constructor`](TaskWorkerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`currentConfig`](TaskWorkerModule.md#currentconfig) - -*** - -### name - -> **name**: `string` = `"block"` - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L61) - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`name`](../interfaces/Task.md#name) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`config`](TaskWorkerModule.md#config) - -## Methods - -### compute() - -> **compute**(`input`): `Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:114](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L114) - -#### Parameters - -##### input - -[`PairingDerivedInput`](../interfaces/PairingDerivedInput.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md), `RuntimeProof`, [`BlockProverParameters`](../interfaces/BlockProverParameters.md)\> - -#### Returns - -`Promise`\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`compute`](../interfaces/Task.md#compute) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`TaskWorkerModule`](TaskWorkerModule.md).[`create`](TaskWorkerModule.md#create) - -*** - -### inputSerializer() - -> **inputSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:79](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L79) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`inputSerializer`](../interfaces/Task.md#inputserializer) - -*** - -### prepare() - -> **prepare**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:144](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L144) - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`prepare`](../interfaces/Task.md#prepare) - -*** - -### resultSerializer() - -> **resultSerializer**(): [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:92](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L92) - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`BlockProof`](../../protocol/type-aliases/BlockProof.md)\> - -#### Implementation of - -[`Task`](../interfaces/Task.md).[`resultSerializer`](../interfaces/Task.md#resultserializer) diff --git a/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md b/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md deleted file mode 100644 index 4ebd3ed..0000000 --- a/src/pages/docs/reference/sequencer/classes/TransactionProvingTaskParameterSerializer.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: TransactionProvingTaskParameterSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionProvingTaskParameterSerializer - -# Class: TransactionProvingTaskParameterSerializer - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L18) - -## Implements - -- [`TaskSerializer`](../interfaces/TaskSerializer.md)\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> - -## Constructors - -### new TransactionProvingTaskParameterSerializer() - -> **new TransactionProvingTaskParameterSerializer**(`stProofSerializer`, `runtimeProofSerializer`): [`TransactionProvingTaskParameterSerializer`](TransactionProvingTaskParameterSerializer.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L21) - -#### Parameters - -##### stProofSerializer - -[`ProofTaskSerializer`](ProofTaskSerializer.md)\<[`StateTransitionProverPublicInput`](../../protocol/classes/StateTransitionProverPublicInput.md), [`StateTransitionProverPublicOutput`](../../protocol/classes/StateTransitionProverPublicOutput.md)\> - -##### runtimeProofSerializer - -[`ProofTaskSerializer`](ProofTaskSerializer.md)\<`undefined`, [`MethodPublicOutput`](../../protocol/classes/MethodPublicOutput.md)\> - -#### Returns - -[`TransactionProvingTaskParameterSerializer`](TransactionProvingTaskParameterSerializer.md) - -## Methods - -### fromJSON() - -> **fromJSON**(`json`): `Promise`\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L57) - -#### Parameters - -##### json - -`string` - -#### Returns - -`Promise`\<[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md)\> - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`fromJSON`](../interfaces/TaskSerializer.md#fromjson) - -*** - -### toJSON() - -> **toJSON**(`input`): `string` - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/TransactionProvingTaskParameterSerializer.ts#L32) - -#### Parameters - -##### input - -[`TransactionProvingTaskParameters`](../type-aliases/TransactionProvingTaskParameters.md) - -#### Returns - -`string` - -#### Implementation of - -[`TaskSerializer`](../interfaces/TaskSerializer.md).[`toJSON`](../interfaces/TaskSerializer.md#tojson) diff --git a/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md b/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md deleted file mode 100644 index 13ff214..0000000 --- a/src/pages/docs/reference/sequencer/classes/TransactionTraceService.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: TransactionTraceService ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionTraceService - -# Class: TransactionTraceService - -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L36) - -## Constructors - -### new TransactionTraceService() - -> **new TransactionTraceService**(): [`TransactionTraceService`](TransactionTraceService.md) - -#### Returns - -[`TransactionTraceService`](TransactionTraceService.md) - -## Methods - -### createBlockTrace() - -> **createBlockTrace**(`traces`, `stateServices`, `blockHashTreeStore`, `beforeBlockStateRoot`, `block`): `Promise`\<[`BlockTrace`](../interfaces/BlockTrace.md)\> - -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L78) - -#### Parameters - -##### traces - -[`TransactionTrace`](../interfaces/TransactionTrace.md)[] - -##### stateServices - -###### merkleStore - -[`CachedMerkleTreeStore`](CachedMerkleTreeStore.md) - -###### stateService - -[`CachedStateService`](CachedStateService.md) - -##### blockHashTreeStore - -[`AsyncMerkleTreeStore`](../interfaces/AsyncMerkleTreeStore.md) - -##### beforeBlockStateRoot - -`Field` - -##### block - -[`BlockWithResult`](../interfaces/BlockWithResult.md) - -#### Returns - -`Promise`\<[`BlockTrace`](../interfaces/BlockTrace.md)\> - -*** - -### createTransactionTrace() - -> **createTransactionTrace**(`executionResult`, `stateServices`, `verificationKeyService`, `networkState`, `bundleTracker`, `eternalBundleTracker`, `messageTracker`): `Promise`\<[`TransactionTrace`](../interfaces/TransactionTrace.md)\> - -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:172](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L172) - -What is in a trace? -A trace has two parts: -1. start values of storage keys accessed by all state transitions -2. Merkle Witnesses of the keys accessed by the state transitions - -How do we create a trace? - -1. We execute the transaction and create the stateTransitions -The first execution is done with a DummyStateService to find out the -accessed keys that can then be cached for the actual run, which generates -the correct state transitions and has to be done for the next -transactions to be based on the correct state. - -2. We extract the accessed keys, download the state and put it into -AppChainProveParams - -3. We retrieve merkle witnesses for each step and put them into -StateTransitionProveParams - -#### Parameters - -##### executionResult - -[`TransactionExecutionResult`](../interfaces/TransactionExecutionResult.md) - -##### stateServices - -###### merkleStore - -[`CachedMerkleTreeStore`](CachedMerkleTreeStore.md) - -###### stateService - -[`CachedStateService`](CachedStateService.md) - -##### verificationKeyService - -`VerificationKeyService` - -##### networkState - -[`NetworkState`](../../protocol/classes/NetworkState.md) - -##### bundleTracker - -[`ProvableHashList`](../../protocol/classes/ProvableHashList.md)\<`Field`\> - -##### eternalBundleTracker - -[`ProvableHashList`](../../protocol/classes/ProvableHashList.md)\<`Field`\> - -##### messageTracker - -[`ProvableHashList`](../../protocol/classes/ProvableHashList.md)\<`Field`\> - -#### Returns - -`Promise`\<[`TransactionTrace`](../interfaces/TransactionTrace.md)\> diff --git a/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md b/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md deleted file mode 100644 index cbcbb2b..0000000 --- a/src/pages/docs/reference/sequencer/classes/UnsignedTransaction.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -title: UnsignedTransaction ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / UnsignedTransaction - -# Class: UnsignedTransaction - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L30) - -## Extended by - -- [`PendingTransaction`](PendingTransaction.md) - -## Implements - -- [`UnsignedTransactionBody`](../type-aliases/UnsignedTransactionBody.md) - -## Constructors - -### new UnsignedTransaction() - -> **new UnsignedTransaction**(`data`): [`UnsignedTransaction`](UnsignedTransaction.md) - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L43) - -#### Parameters - -##### data - -###### argsFields - -`Field`[] - -###### auxiliaryData - -`string`[] - -###### isMessage - -`boolean` - -###### methodId - -`Field` - -###### nonce - -`UInt64` - -###### sender - -`PublicKey` - -#### Returns - -[`UnsignedTransaction`](UnsignedTransaction.md) - -## Properties - -### argsFields - -> **argsFields**: `Field`[] - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L37) - -#### Implementation of - -`UnsignedTransactionBody.argsFields` - -*** - -### auxiliaryData - -> **auxiliaryData**: `string`[] - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L39) - -Used to transport non-provable data, mainly proof data for now -These values will not be part of the signature message or transaction hash - -#### Implementation of - -`UnsignedTransactionBody.auxiliaryData` - -*** - -### isMessage - -> **isMessage**: `boolean` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L41) - -#### Implementation of - -`UnsignedTransactionBody.isMessage` - -*** - -### methodId - -> **methodId**: `Field` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L31) - -#### Implementation of - -`UnsignedTransactionBody.methodId` - -*** - -### nonce - -> **nonce**: `UInt64` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L33) - -#### Implementation of - -`UnsignedTransactionBody.nonce` - -*** - -### sender - -> **sender**: `PublicKey` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L35) - -#### Implementation of - -`UnsignedTransactionBody.sender` - -## Methods - -### argsHash() - -> **argsHash**(): `Field` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L59) - -#### Returns - -`Field` - -*** - -### getSignatureData() - -> **getSignatureData**(): `Field`[] - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:72](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L72) - -#### Returns - -`Field`[] - -*** - -### hash() - -> **hash**(): `Field` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L63) - -#### Returns - -`Field` - -*** - -### sign() - -> **sign**(`privateKey`): [`PendingTransaction`](PendingTransaction.md) - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:80](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L80) - -#### Parameters - -##### privateKey - -`PrivateKey` - -#### Returns - -[`PendingTransaction`](PendingTransaction.md) - -*** - -### signed() - -> **signed**(`signature`): [`PendingTransaction`](PendingTransaction.md) - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:95](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L95) - -#### Parameters - -##### signature - -`Signature` - -#### Returns - -[`PendingTransaction`](PendingTransaction.md) - -*** - -### toRuntimeTransaction() - -> **toRuntimeTransaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:85](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L85) - -#### Returns - -[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) diff --git a/src/pages/docs/reference/sequencer/classes/UntypedOption.md b/src/pages/docs/reference/sequencer/classes/UntypedOption.md deleted file mode 100644 index 93154af..0000000 --- a/src/pages/docs/reference/sequencer/classes/UntypedOption.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: UntypedOption ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / UntypedOption - -# Class: UntypedOption - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L7) - -Option facilitating in-circuit values that may or may not exist. - -## Extends - -- [`OptionBase`](../../protocol/classes/OptionBase.md) - -## Constructors - -### new UntypedOption() - -> **new UntypedOption**(`isSome`, `value`, `enforceEmpty`): [`UntypedOption`](UntypedOption.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L32) - -#### Parameters - -##### isSome - -`Bool` - -##### value - -`Field`[] - -##### enforceEmpty - -`Bool` - -#### Returns - -[`UntypedOption`](UntypedOption.md) - -#### Overrides - -[`OptionBase`](../../protocol/classes/OptionBase.md).[`constructor`](../../protocol/classes/OptionBase.md#constructors) - -## Properties - -### isForcedSome - -> **isForcedSome**: `Bool` - -Defined in: packages/protocol/dist/model/Option.d.ts:60 - -#### Inherited from - -[`OptionBase`](../../protocol/classes/OptionBase.md).[`isForcedSome`](../../protocol/classes/OptionBase.md#isforcedsome-1) - -*** - -### isSome - -> **isSome**: `Bool` - -Defined in: packages/protocol/dist/model/Option.d.ts:59 - -#### Inherited from - -[`OptionBase`](../../protocol/classes/OptionBase.md).[`isSome`](../../protocol/classes/OptionBase.md#issome-1) - -*** - -### value - -> **value**: `Field`[] - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L34) - -## Accessors - -### treeValue - -#### Get Signature - -> **get** **treeValue**(): `Field` - -Defined in: packages/protocol/dist/model/Option.d.ts:67 - -##### Returns - -`Field` - -Tree representation of the current value - -#### Inherited from - -[`OptionBase`](../../protocol/classes/OptionBase.md).[`treeValue`](../../protocol/classes/OptionBase.md#treevalue) - -## Methods - -### clone() - -> **clone**(): [`UntypedOption`](UntypedOption.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L40) - -#### Returns - -[`UntypedOption`](UntypedOption.md) - -#### Overrides - -[`OptionBase`](../../protocol/classes/OptionBase.md).[`clone`](../../protocol/classes/OptionBase.md#clone) - -*** - -### encodeValueToFields() - -> `protected` **encodeValueToFields**(): `Field`[] - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L44) - -#### Returns - -`Field`[] - -#### Overrides - -[`OptionBase`](../../protocol/classes/OptionBase.md).[`encodeValueToFields`](../../protocol/classes/OptionBase.md#encodevaluetofields) - -*** - -### forceSome() - -> **forceSome**(): `void` - -Defined in: packages/protocol/dist/model/Option.d.ts:68 - -#### Returns - -`void` - -#### Inherited from - -[`OptionBase`](../../protocol/classes/OptionBase.md).[`forceSome`](../../protocol/classes/OptionBase.md#forcesome) - -*** - -### toFields() - -> **toFields**(): `Field`[] - -Defined in: packages/protocol/dist/model/Option.d.ts:73 - -Returns the `to`-value as decoded as a list of fields -Not in circuit - -#### Returns - -`Field`[] - -#### Inherited from - -[`OptionBase`](../../protocol/classes/OptionBase.md).[`toFields`](../../protocol/classes/OptionBase.md#tofields) - -*** - -### toJSON() - -> **toJSON**(): `object` - -Defined in: packages/protocol/dist/model/Option.d.ts:78 - -#### Returns - -`object` - -##### isForcedSome - -> **isForcedSome**: `boolean` - -##### isSome - -> **isSome**: `boolean` - -##### value - -> **value**: `string`[] - -#### Inherited from - -[`OptionBase`](../../protocol/classes/OptionBase.md).[`toJSON`](../../protocol/classes/OptionBase.md#tojson) - -*** - -### toProvable() - -> **toProvable**(): [`ProvableOption`](../../protocol/classes/ProvableOption.md) - -Defined in: packages/protocol/dist/model/Option.d.ts:77 - -#### Returns - -[`ProvableOption`](../../protocol/classes/ProvableOption.md) - -Provable representation of the current option. - -#### Inherited from - -[`OptionBase`](../../protocol/classes/OptionBase.md).[`toProvable`](../../protocol/classes/OptionBase.md#toprovable) - -*** - -### fromJSON() - -> `static` **fromJSON**(`__namedParameters`): [`UntypedOption`](UntypedOption.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L16) - -#### Parameters - -##### \_\_namedParameters - -###### isForcedSome - -`boolean` - -###### isSome - -`boolean` - -###### value - -`string`[] - -#### Returns - -[`UntypedOption`](UntypedOption.md) - -*** - -### fromOption() - -> `static` **fromOption**\<`Value`\>(`option`): [`UntypedOption`](UntypedOption.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedOption.ts#L8) - -#### Type Parameters - -• **Value** - -#### Parameters - -##### option - -[`Option`](../../protocol/classes/Option.md)\<`Field`\> | [`Option`](../../protocol/classes/Option.md)\<`Value`\> - -#### Returns - -[`UntypedOption`](UntypedOption.md) diff --git a/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md b/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md deleted file mode 100644 index f8b37db..0000000 --- a/src/pages/docs/reference/sequencer/classes/UntypedStateTransition.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -title: UntypedStateTransition ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / UntypedStateTransition - -# Class: UntypedStateTransition - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L10) - -Generic state transition that constraints the current method circuit -to external state, by providing a state anchor. - -## Constructors - -### new UntypedStateTransition() - -> **new UntypedStateTransition**(`path`, `fromValue`, `toValue`): [`UntypedStateTransition`](UntypedStateTransition.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L35) - -#### Parameters - -##### path - -`Field` - -##### fromValue - -[`UntypedOption`](UntypedOption.md) - -##### toValue - -[`UntypedOption`](UntypedOption.md) - -#### Returns - -[`UntypedStateTransition`](UntypedStateTransition.md) - -## Properties - -### fromValue - -> **fromValue**: [`UntypedOption`](UntypedOption.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L37) - -*** - -### path - -> **path**: `Field` - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L36) - -*** - -### toValue - -> **toValue**: [`UntypedOption`](UntypedOption.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L38) - -## Accessors - -### from - -#### Get Signature - -> **get** **from**(): [`UntypedOption`](UntypedOption.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L41) - -##### Returns - -[`UntypedOption`](UntypedOption.md) - -*** - -### to - -#### Get Signature - -> **get** **to**(): [`UntypedOption`](UntypedOption.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:47](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L47) - -##### Returns - -[`UntypedOption`](UntypedOption.md) - -## Methods - -### toJSON() - -> **toJSON**(): `object` - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:63](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L63) - -#### Returns - -`object` - -##### from - -> **from**: `object` - -###### from.isForcedSome - -> **from.isForcedSome**: `boolean` - -###### from.isSome - -> **from.isSome**: `boolean` - -###### from.value - -> **from.value**: `string`[] - -##### path - -> **path**: `string` - -##### to - -> **to**: `object` - -###### to.isForcedSome - -> **to.isForcedSome**: `boolean` - -###### to.isSome - -> **to.isSome**: `boolean` - -###### to.value - -> **to.value**: `string`[] - -*** - -### toProvable() - -> **toProvable**(): [`ProvableStateTransition`](../../protocol/classes/ProvableStateTransition.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L55) - -Converts a StateTransition to a ProvableStateTransition, -while enforcing the 'from' property to be 'Some' in all cases. - -#### Returns - -[`ProvableStateTransition`](../../protocol/classes/ProvableStateTransition.md) - -*** - -### fromJSON() - -> `static` **fromJSON**(`__namedParameters`): [`UntypedStateTransition`](UntypedStateTransition.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L19) - -#### Parameters - -##### \_\_namedParameters - -###### from - -\{ `isForcedSome`: `boolean`; `isSome`: `boolean`; `value`: `string`[]; \} - -###### from.isForcedSome - -`boolean` - -###### from.isSome - -`boolean` - -###### from.value - -`string`[] - -###### path - -`string` - -###### to - -\{ `isForcedSome`: `boolean`; `isSome`: `boolean`; `value`: `string`[]; \} - -###### to.isForcedSome - -`boolean` - -###### to.isSome - -`boolean` - -###### to.value - -`string`[] - -#### Returns - -[`UntypedStateTransition`](UntypedStateTransition.md) - -*** - -### fromStateTransition() - -> `static` **fromStateTransition**\<`Value`\>(`st`): [`UntypedStateTransition`](UntypedStateTransition.md) - -Defined in: [packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts#L11) - -#### Type Parameters - -• **Value** - -#### Parameters - -##### st - -[`StateTransition`](../../protocol/classes/StateTransition.md)\<`Value`\> - -#### Returns - -[`UntypedStateTransition`](UntypedStateTransition.md) diff --git a/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md b/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md deleted file mode 100644 index a8a2f13..0000000 --- a/src/pages/docs/reference/sequencer/classes/VanillaTaskWorkerModules.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -title: VanillaTaskWorkerModules ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / VanillaTaskWorkerModules - -# Class: VanillaTaskWorkerModules - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:131](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L131) - -## Constructors - -### new VanillaTaskWorkerModules() - -> **new VanillaTaskWorkerModules**(): [`VanillaTaskWorkerModules`](VanillaTaskWorkerModules.md) - -#### Returns - -[`VanillaTaskWorkerModules`](VanillaTaskWorkerModules.md) - -## Methods - -### allTasks() - -> `static` **allTasks**(): `object` - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:145](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L145) - -#### Returns - -`object` - -##### BlockBuildingTask - -> **BlockBuildingTask**: *typeof* [`NewBlockTask`](NewBlockTask.md) = `NewBlockTask` - -##### BlockReductionTask - -> **BlockReductionTask**: *typeof* `BlockReductionTask` - -##### CircuitCompilerTask - -> **CircuitCompilerTask**: *typeof* `CircuitCompilerTask` - -##### RuntimeProvingTask - -> **RuntimeProvingTask**: *typeof* [`RuntimeProvingTask`](RuntimeProvingTask.md) - -##### SettlementProvingTask - -> **SettlementProvingTask**: *typeof* [`SettlementProvingTask`](SettlementProvingTask.md) - -##### StateTransitionReductionTask - -> **StateTransitionReductionTask**: *typeof* [`StateTransitionReductionTask`](StateTransitionReductionTask.md) - -##### StateTransitionTask - -> **StateTransitionTask**: *typeof* [`StateTransitionTask`](StateTransitionTask.md) - -##### TransactionProvingTask - -> **TransactionProvingTask**: *typeof* [`TransactionProvingTask`](TransactionProvingTask.md) - -##### WorkerRegistrationTask - -> **WorkerRegistrationTask**: *typeof* `WorkerRegistrationTask` - -*** - -### defaultConfig() - -> `static` **defaultConfig**(): `object` - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:152](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L152) - -#### Returns - -`object` - -##### BlockBuildingTask - -> **BlockBuildingTask**: `object` = `{}` - -##### BlockReductionTask - -> **BlockReductionTask**: `object` = `{}` - -##### CircuitCompilerTask - -> **CircuitCompilerTask**: `object` = `{}` - -##### RuntimeProvingTask - -> **RuntimeProvingTask**: `object` = `{}` - -##### SettlementProvingTask - -> **SettlementProvingTask**: `object` = `{}` - -##### StateTransitionReductionTask - -> **StateTransitionReductionTask**: `object` = `{}` - -##### StateTransitionTask - -> **StateTransitionTask**: `object` = `{}` - -##### TransactionProvingTask - -> **TransactionProvingTask**: `object` = `{}` - -##### WorkerRegistrationTask - -> **WorkerRegistrationTask**: `object` = `{}` - -*** - -### withoutSettlement() - -> `static` **withoutSettlement**(): `object` - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:132](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L132) - -#### Returns - -`object` - -##### BlockBuildingTask - -> **BlockBuildingTask**: *typeof* [`NewBlockTask`](NewBlockTask.md) = `NewBlockTask` - -##### BlockReductionTask - -> **BlockReductionTask**: *typeof* `BlockReductionTask` - -##### CircuitCompilerTask - -> **CircuitCompilerTask**: *typeof* `CircuitCompilerTask` - -##### RuntimeProvingTask - -> **RuntimeProvingTask**: *typeof* [`RuntimeProvingTask`](RuntimeProvingTask.md) - -##### StateTransitionReductionTask - -> **StateTransitionReductionTask**: *typeof* [`StateTransitionReductionTask`](StateTransitionReductionTask.md) - -##### StateTransitionTask - -> **StateTransitionTask**: *typeof* [`StateTransitionTask`](StateTransitionTask.md) - -##### TransactionProvingTask - -> **TransactionProvingTask**: *typeof* [`TransactionProvingTask`](TransactionProvingTask.md) - -##### WorkerRegistrationTask - -> **WorkerRegistrationTask**: *typeof* `WorkerRegistrationTask` diff --git a/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md b/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md deleted file mode 100644 index a0bdb3b..0000000 --- a/src/pages/docs/reference/sequencer/classes/VerificationKeySerializer.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: VerificationKeySerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / VerificationKeySerializer - -# Class: VerificationKeySerializer - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L5) - -## Constructors - -### new VerificationKeySerializer() - -> **new VerificationKeySerializer**(): [`VerificationKeySerializer`](VerificationKeySerializer.md) - -#### Returns - -[`VerificationKeySerializer`](VerificationKeySerializer.md) - -## Methods - -### fromJSON() - -> `static` **fromJSON**(`json`): `VerificationKey` - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L13) - -#### Parameters - -##### json - -[`VerificationKeyJSON`](../type-aliases/VerificationKeyJSON.md) - -#### Returns - -`VerificationKey` - -*** - -### toJSON() - -> `static` **toJSON**(`verificationKey`): [`VerificationKeyJSON`](../type-aliases/VerificationKeyJSON.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L6) - -#### Parameters - -##### verificationKey - -`VerificationKey` - -#### Returns - -[`VerificationKeyJSON`](../type-aliases/VerificationKeyJSON.md) diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md b/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md deleted file mode 100644 index ee29a2a..0000000 --- a/src/pages/docs/reference/sequencer/classes/WithdrawalEvent.md +++ /dev/null @@ -1,489 +0,0 @@ ---- -title: WithdrawalEvent ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / WithdrawalEvent - -# Class: WithdrawalEvent - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L24) - -## Extends - -- `object` - -## Constructors - -### new WithdrawalEvent() - -> **new WithdrawalEvent**(`value`): [`WithdrawalEvent`](WithdrawalEvent.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -[`WithdrawalEvent`](WithdrawalEvent.md) - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).constructor` - -## Properties - -### key - -> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L25) - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).key` - -*** - -### value - -> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L26) - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).value` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### key - -> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -##### value - -> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### key - -> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -##### value - -> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### key - -\{ `index`: `string`; `tokenId`: `string`; \} = `WithdrawalKey` - -###### key.index - -`string` = `Field` - -###### key.tokenId - -`string` = `Field` - -###### value - -\{ `address`: `string`; `amount`: `string`; `tokenId`: `string`; \} = `Withdrawal` - -###### value.address - -`string` - -###### value.amount - -`string` - -###### value.tokenId - -`string` - -#### Returns - -`object` - -##### key - -> **key**: [`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -##### value - -> **value**: [`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`object` - -##### key - -> **key**: `object` = `WithdrawalKey` - -###### key.index - -> **key.index**: `string` = `Field` - -###### key.tokenId - -> **key.tokenId**: `string` = `Field` - -##### value - -> **value**: `object` = `Withdrawal` - -###### value.address - -> **value.address**: `string` - -###### value.amount - -> **value.amount**: `string` - -###### value.tokenId - -> **value.tokenId**: `string` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### key - -[`WithdrawalKey`](WithdrawalKey.md) = `WithdrawalKey` - -###### value - -[`Withdrawal`](../../protocol/classes/Withdrawal.md) = `Withdrawal` - -#### Returns - -`object` - -##### key - -> **key**: `object` = `WithdrawalKey` - -###### key.index - -> **key.index**: `bigint` = `Field` - -###### key.tokenId - -> **key.tokenId**: `bigint` = `Field` - -##### value - -> **value**: `object` = `Withdrawal` - -###### value.address - -> **value.address**: `object` - -###### value.address.isOdd - -> **value.address.isOdd**: `boolean` - -###### value.address.x - -> **value.address.x**: `bigint` - -###### value.amount - -> **value.amount**: `bigint` - -###### value.tokenId - -> **value.tokenId**: `bigint` - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ key: WithdrawalKey, value: Withdrawal, }).sizeInFields` diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md b/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md deleted file mode 100644 index 71bf3f1..0000000 --- a/src/pages/docs/reference/sequencer/classes/WithdrawalKey.md +++ /dev/null @@ -1,421 +0,0 @@ ---- -title: WithdrawalKey ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / WithdrawalKey - -# Class: WithdrawalKey - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L19) - -## Extends - -- `object` - -## Constructors - -### new WithdrawalKey() - -> **new WithdrawalKey**(`value`): [`WithdrawalKey`](WithdrawalKey.md) - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103 - -#### Parameters - -##### value - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -[`WithdrawalKey`](WithdrawalKey.md) - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).constructor` - -## Properties - -### index - -> **index**: `Field` = `Field` - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L20) - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).index` - -*** - -### tokenId - -> **tokenId**: `Field` = `Field` - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L21) - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).tokenId` - -*** - -### \_isStruct - -> `static` **\_isStruct**: `true` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104 - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, })._isStruct` - -*** - -### check() - -> `static` **check**: (`value`) => `void` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60 - -Add assertions to the proof to check if `value` is a valid member of type `T`. -This function does not return anything, instead it creates any number of assertions to prove that `value` is a valid member of the type `T`. - -For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0. - -#### Parameters - -##### value - -the element of type `T` to put assertions on. - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`void` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).check` - -*** - -### empty() - -> `static` **empty**: () => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113 - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).empty` - -*** - -### fromFields() - -> `static` **fromFields**: (`fields`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:78 - -#### Parameters - -##### fields - -`Field`[] - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).fromFields` - -*** - -### fromJSON() - -> `static` **fromJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112 - -#### Parameters - -##### x - -###### index - -`string` = `Field` - -###### tokenId - -`string` = `Field` - -#### Returns - -`object` - -##### index - -> **index**: `Field` = `Field` - -##### tokenId - -> **tokenId**: `Field` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).fromJSON` - -*** - -### fromValue - -> `static` **fromValue**: (`x`) => `object` & (`value`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68 - -Convert provable type from a normal JS type. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).fromValue` - -*** - -### toAuxiliary() - -> `static` **toAuxiliary**: (`value`?) => `any`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34 - -A function that takes `value` (optional), an element of type `T`, as argument and -returns an array of any type that make up the "auxiliary" (non-provable) data of `value`. - -#### Parameters - -##### value? - -the element of type `T` to generate the auxiliary data array from, optional. -If not provided, a default value for auxiliary data is returned. - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`any`[] - -An array of any type describing how this `T` element is made up of "auxiliary" (non-provable) data. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toAuxiliary` - -*** - -### toFields() - -> `static` **toFields**: (`value`) => `Field`[] - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24 - -A function that takes `value`, an element of type `T`, as argument and returns -an array of Field elements that make up the provable data of `value`. - -#### Parameters - -##### value - -the element of type `T` to generate the Field array from. - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`Field`[] - -A Field array describing how this `T` element is made up of Field elements. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toFields` - -*** - -### toInput() - -> `static` **toInput**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107 - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### fields? - -> `optional` **fields**: `Field`[] - -##### packed? - -> `optional` **packed**: \[`Field`, `number`\][] - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toInput` - -*** - -### toJSON() - -> `static` **toJSON**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111 - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### index - -> **index**: `string` = `Field` - -##### tokenId - -> **tokenId**: `string` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toJSON` - -*** - -### toValue() - -> `static` **toValue**: (`x`) => `object` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64 - -Convert provable type to a normal JS type. - -#### Parameters - -##### x - -###### index - -`Field` = `Field` - -###### tokenId - -`Field` = `Field` - -#### Returns - -`object` - -##### index - -> **index**: `bigint` = `Field` - -##### tokenId - -> **tokenId**: `bigint` = `Field` - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).toValue` - -## Methods - -### sizeInFields() - -> `static` **sizeInFields**(): `number` - -Defined in: node\_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51 - -Return the size of the `T` type in terms of Field type, as Field is the primitive type. - -#### Returns - -`number` - -A `number` representing the size of the `T` type in terms of Field type. - -#### Inherited from - -`Struct({ index: Field, tokenId: Field, }).sizeInFields` diff --git a/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md b/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md deleted file mode 100644 index 41c2de3..0000000 --- a/src/pages/docs/reference/sequencer/classes/WithdrawalQueue.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -title: WithdrawalQueue ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / WithdrawalQueue - -# Class: WithdrawalQueue - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L44) - -This interface allows the SettlementModule to retrieve information about -pending L2-dispatched (outgoing) messages that it can then use to roll -them up on the L1 contract. - -In the future, this interface should be flexibly typed so that the -outgoing message type is not limited to Withdrawals - -## Extends - -- [`SequencerModule`](SequencerModule.md) - -## Implements - -- [`OutgoingMessageQueue`](../interfaces/OutgoingMessageQueue.md) - -## Constructors - -### new WithdrawalQueue() - -> **new WithdrawalQueue**(`sequencer`): [`WithdrawalQueue`](WithdrawalQueue.md) - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L54) - -#### Parameters - -##### sequencer - -[`Sequencer`](Sequencer.md)\<\{ `BlockTrigger`: *typeof* [`BlockTriggerBase`](BlockTriggerBase.md); `SettlementModule`: *typeof* [`SettlementModule`](SettlementModule.md); \}\> - -#### Returns - -[`WithdrawalQueue`](WithdrawalQueue.md) - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`constructor`](SequencerModule.md#constructors) - -## Properties - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`currentConfig`](SequencerModule.md#currentconfig) - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> = `{}` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L18) - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`presets`](SequencerModule.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`config`](SequencerModule.md#config) - -## Methods - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: packages/common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`SequencerModule`](SequencerModule.md).[`create`](SequencerModule.md#create) - -*** - -### length() - -> **length**(): `number` - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:74](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L74) - -#### Returns - -`number` - -#### Implementation of - -[`OutgoingMessageQueue`](../interfaces/OutgoingMessageQueue.md).[`length`](../interfaces/OutgoingMessageQueue.md#length) - -*** - -### peek() - -> **peek**(`num`): [`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L64) - -#### Parameters - -##### num - -`number` - -#### Returns - -[`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] - -#### Implementation of - -[`OutgoingMessageQueue`](../interfaces/OutgoingMessageQueue.md).[`peek`](../interfaces/OutgoingMessageQueue.md#peek) - -*** - -### pop() - -> **pop**(`num`): [`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:68](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L68) - -#### Parameters - -##### num - -`number` - -#### Returns - -[`OutgoingMessage`](../interfaces/OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] - -#### Implementation of - -[`OutgoingMessageQueue`](../interfaces/OutgoingMessageQueue.md).[`pop`](../interfaces/OutgoingMessageQueue.md#pop) - -*** - -### start() - -> **start**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:78](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L78) - -Start the module and all it's functionality. -The returned Promise has to resolve after initialization, -since it will block in the sequencer init. -That means that you mustn't await server.start() for example. - -#### Returns - -`Promise`\<`void`\> - -#### Overrides - -[`SequencerModule`](SequencerModule.md).[`start`](SequencerModule.md#start) diff --git a/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md b/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md deleted file mode 100644 index 45aa36d..0000000 --- a/src/pages/docs/reference/sequencer/classes/WorkerReadyModule.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: WorkerReadyModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / WorkerReadyModule - -# Class: WorkerReadyModule - -Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L11) - -Module to safely wait for the finish of the worker startup -Behaves like a noop for non-worker appchain configurations - -## Constructors - -### new WorkerReadyModule() - -> **new WorkerReadyModule**(`localTaskWorkerModule`): [`WorkerReadyModule`](WorkerReadyModule.md) - -Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L12) - -#### Parameters - -##### localTaskWorkerModule - -`undefined` | [`LocalTaskWorkerModule`](LocalTaskWorkerModule.md)\<`any`\> - -#### Returns - -[`WorkerReadyModule`](WorkerReadyModule.md) - -## Methods - -### waitForReady() - -> **waitForReady**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/worker/WorkerReadyModule.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/WorkerReadyModule.ts#L20) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/functions/closeable.md b/src/pages/docs/reference/sequencer/functions/closeable.md deleted file mode 100644 index 8ef1914..0000000 --- a/src/pages/docs/reference/sequencer/functions/closeable.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: closeable ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / closeable - -# Function: closeable() - -> **closeable**(): (`target`) => `void` - -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/Closeable.ts#L7) - -## Returns - -`Function` - -### Parameters - -#### target - -[`TypedClass`](../type-aliases/TypedClass.md)\<[`Closeable`](../interfaces/Closeable.md)\> - -### Returns - -`void` diff --git a/src/pages/docs/reference/sequencer/functions/distinct.md b/src/pages/docs/reference/sequencer/functions/distinct.md deleted file mode 100644 index d73f662..0000000 --- a/src/pages/docs/reference/sequencer/functions/distinct.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: distinct ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / distinct - -# Function: distinct() - -> **distinct**\<`Value`\>(`value`, `index`, `array`): `boolean` - -Defined in: [packages/sequencer/src/helpers/utils.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L7) - -## Type Parameters - -• **Value** - -## Parameters - -### value - -`Value` - -### index - -`number` - -### array - -`Value`[] - -## Returns - -`boolean` diff --git a/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md b/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md deleted file mode 100644 index e7aa629..0000000 --- a/src/pages/docs/reference/sequencer/functions/distinctByPredicate.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: distinctByPredicate ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / distinctByPredicate - -# Function: distinctByPredicate() - -> **distinctByPredicate**\<`Value`\>(`predicate`): (`value`, `index`, `array`) => `boolean` - -Defined in: [packages/sequencer/src/helpers/utils.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L15) - -## Type Parameters - -• **Value** - -## Parameters - -### predicate - -(`a`, `b`) => `boolean` - -## Returns - -`Function` - -### Parameters - -#### value - -`Value` - -#### index - -`number` - -#### array - -`Value`[] - -### Returns - -`boolean` diff --git a/src/pages/docs/reference/sequencer/functions/distinctByString.md b/src/pages/docs/reference/sequencer/functions/distinctByString.md deleted file mode 100644 index fd24635..0000000 --- a/src/pages/docs/reference/sequencer/functions/distinctByString.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: distinctByString ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / distinctByString - -# Function: distinctByString() - -> **distinctByString**\<`Value`\>(`value`, `index`, `array`): `boolean` - -Defined in: [packages/sequencer/src/helpers/utils.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L23) - -## Type Parameters - -• **Value** *extends* `object` - -## Parameters - -### value - -`Value` - -### index - -`number` - -### array - -`Value`[] - -## Returns - -`boolean` diff --git a/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md b/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md deleted file mode 100644 index fe8e3ec..0000000 --- a/src/pages/docs/reference/sequencer/functions/executeWithExecutionContext.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: executeWithExecutionContext ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / executeWithExecutionContext - -# Function: executeWithExecutionContext() - -> **executeWithExecutionContext**\<`MethodResult`\>(`method`, `contextInputs`, `runSimulated`): `Promise`\<[`RuntimeContextReducedExecutionResult`](../type-aliases/RuntimeContextReducedExecutionResult.md) & `object`\> - -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:109](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L109) - -## Type Parameters - -• **MethodResult** - -## Parameters - -### method - -() => `Promise`\<`MethodResult`\> - -### contextInputs - -[`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) - -### runSimulated - -`boolean` = `false` - -## Returns - -`Promise`\<[`RuntimeContextReducedExecutionResult`](../type-aliases/RuntimeContextReducedExecutionResult.md) & `object`\> diff --git a/src/pages/docs/reference/sequencer/functions/sequencerModule.md b/src/pages/docs/reference/sequencer/functions/sequencerModule.md deleted file mode 100644 index 7ac1266..0000000 --- a/src/pages/docs/reference/sequencer/functions/sequencerModule.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: sequencerModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / sequencerModule - -# Function: sequencerModule() - -> **sequencerModule**(): (`target`) => `void` - -Defined in: [packages/sequencer/src/sequencer/builder/SequencerModule.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/SequencerModule.ts#L33) - -Marks the decorated class as a sequencer module, while also -making it injectable with our dependency injection solution. - -## Returns - -`Function` - -### Parameters - -#### target - -[`StaticConfigurableModule`](../../common/interfaces/StaticConfigurableModule.md)\<`unknown`\> & [`TypedClass`](../type-aliases/TypedClass.md)\<[`SequencerModule`](../classes/SequencerModule.md)\<`unknown`\>\> - -### Returns - -`void` diff --git a/src/pages/docs/reference/sequencer/globals.md b/src/pages/docs/reference/sequencer/globals.md deleted file mode 100644 index 7eb0500..0000000 --- a/src/pages/docs/reference/sequencer/globals.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -title: "@proto-kit/sequencer" ---- - -[**@proto-kit/sequencer**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/sequencer - -# @proto-kit/sequencer - -## Classes - -- [AbstractTaskQueue](classes/AbstractTaskQueue.md) -- [ArtifactRecordSerializer](classes/ArtifactRecordSerializer.md) -- [BatchProducerModule](classes/BatchProducerModule.md) -- [BlockProducerModule](classes/BlockProducerModule.md) -- [BlockProofSerializer](classes/BlockProofSerializer.md) -- [BlockTaskFlowService](classes/BlockTaskFlowService.md) -- [BlockTriggerBase](classes/BlockTriggerBase.md) -- [CachedMerkleTreeStore](classes/CachedMerkleTreeStore.md) -- [CachedStateService](classes/CachedStateService.md) -- [CompressedSignature](classes/CompressedSignature.md) -- [DatabasePruneModule](classes/DatabasePruneModule.md) -- [DecodedStateSerializer](classes/DecodedStateSerializer.md) -- [DummyStateService](classes/DummyStateService.md) -- [DynamicProofTaskSerializer](classes/DynamicProofTaskSerializer.md) -- [Flow](classes/Flow.md) -- [FlowCreator](classes/FlowCreator.md) -- [FlowTaskWorker](classes/FlowTaskWorker.md) -- [InMemoryAsyncMerkleTreeStore](classes/InMemoryAsyncMerkleTreeStore.md) -- [InMemoryBatchStorage](classes/InMemoryBatchStorage.md) -- [InMemoryBlockStorage](classes/InMemoryBlockStorage.md) -- [InMemoryDatabase](classes/InMemoryDatabase.md) -- [InMemoryMessageStorage](classes/InMemoryMessageStorage.md) -- [InMemorySettlementStorage](classes/InMemorySettlementStorage.md) -- [InMemoryTransactionStorage](classes/InMemoryTransactionStorage.md) -- [ListenerList](classes/ListenerList.md) -- [LocalTaskQueue](classes/LocalTaskQueue.md) -- [LocalTaskWorkerModule](classes/LocalTaskWorkerModule.md) -- [ManualBlockTrigger](classes/ManualBlockTrigger.md) -- [MinaBaseLayer](classes/MinaBaseLayer.md) -- [MinaIncomingMessageAdapter](classes/MinaIncomingMessageAdapter.md) -- [MinaSimulationService](classes/MinaSimulationService.md) -- [MinaTransactionSender](classes/MinaTransactionSender.md) -- [MinaTransactionSimulator](classes/MinaTransactionSimulator.md) -- [NetworkStateQuery](classes/NetworkStateQuery.md) -- [NewBlockProvingParametersSerializer](classes/NewBlockProvingParametersSerializer.md) -- [NewBlockTask](classes/NewBlockTask.md) -- [NoopBaseLayer](classes/NoopBaseLayer.md) -- [PairProofTaskSerializer](classes/PairProofTaskSerializer.md) -- [PendingTransaction](classes/PendingTransaction.md) -- [PreFilledStateService](classes/PreFilledStateService.md) -- [PrivateMempool](classes/PrivateMempool.md) -- [ProofTaskSerializer](classes/ProofTaskSerializer.md) -- [ProvenSettlementPermissions](classes/ProvenSettlementPermissions.md) -- [ReductionTaskFlow](classes/ReductionTaskFlow.md) -- [RuntimeProofParametersSerializer](classes/RuntimeProofParametersSerializer.md) -- [RuntimeProvingTask](classes/RuntimeProvingTask.md) -- [RuntimeVerificationKeyAttestationSerializer](classes/RuntimeVerificationKeyAttestationSerializer.md) -- [Sequencer](classes/Sequencer.md) -- [SequencerModule](classes/SequencerModule.md) -- [SequencerStartupModule](classes/SequencerStartupModule.md) -- [SettlementModule](classes/SettlementModule.md) -- [SettlementProvingTask](classes/SettlementProvingTask.md) -- [SignedSettlementPermissions](classes/SignedSettlementPermissions.md) -- [SomeProofSubclass](classes/SomeProofSubclass.md) -- [StateTransitionParametersSerializer](classes/StateTransitionParametersSerializer.md) -- [StateTransitionReductionTask](classes/StateTransitionReductionTask.md) -- [StateTransitionTask](classes/StateTransitionTask.md) -- [SyncCachedMerkleTreeStore](classes/SyncCachedMerkleTreeStore.md) -- [TaskWorkerModule](classes/TaskWorkerModule.md) -- [TimedBlockTrigger](classes/TimedBlockTrigger.md) -- [TransactionExecutionService](classes/TransactionExecutionService.md) -- [TransactionProvingTask](classes/TransactionProvingTask.md) -- [TransactionProvingTaskParameterSerializer](classes/TransactionProvingTaskParameterSerializer.md) -- [TransactionTraceService](classes/TransactionTraceService.md) -- [UnsignedTransaction](classes/UnsignedTransaction.md) -- [UntypedOption](classes/UntypedOption.md) -- [UntypedStateTransition](classes/UntypedStateTransition.md) -- [VanillaTaskWorkerModules](classes/VanillaTaskWorkerModules.md) -- [VerificationKeySerializer](classes/VerificationKeySerializer.md) -- [WithdrawalEvent](classes/WithdrawalEvent.md) -- [WithdrawalKey](classes/WithdrawalKey.md) -- [WithdrawalQueue](classes/WithdrawalQueue.md) -- [WorkerReadyModule](classes/WorkerReadyModule.md) - -## Interfaces - -- [AsyncMerkleTreeStore](interfaces/AsyncMerkleTreeStore.md) -- [AsyncStateService](interfaces/AsyncStateService.md) -- [BaseLayer](interfaces/BaseLayer.md) -- [BaseLayerContractPermissions](interfaces/BaseLayerContractPermissions.md) -- [BaseLayerDependencyRecord](interfaces/BaseLayerDependencyRecord.md) -- [Batch](interfaces/Batch.md) -- [BatchStorage](interfaces/BatchStorage.md) -- [BatchTransaction](interfaces/BatchTransaction.md) -- [Block](interfaces/Block.md) -- [BlockConfig](interfaces/BlockConfig.md) -- [BlockProverParameters](interfaces/BlockProverParameters.md) -- [BlockQueue](interfaces/BlockQueue.md) -- [BlockResult](interfaces/BlockResult.md) -- [BlockStorage](interfaces/BlockStorage.md) -- [BlockTrace](interfaces/BlockTrace.md) -- [BlockTrigger](interfaces/BlockTrigger.md) -- [BlockWithMaybeResult](interfaces/BlockWithMaybeResult.md) -- [BlockWithPreviousResult](interfaces/BlockWithPreviousResult.md) -- [BlockWithResult](interfaces/BlockWithResult.md) -- [Closeable](interfaces/Closeable.md) -- [Database](interfaces/Database.md) -- [HistoricalBatchStorage](interfaces/HistoricalBatchStorage.md) -- [HistoricalBlockStorage](interfaces/HistoricalBlockStorage.md) -- [IncomingMessageAdapter](interfaces/IncomingMessageAdapter.md) -- [InstantiatedQueue](interfaces/InstantiatedQueue.md) -- [LocalTaskQueueConfig](interfaces/LocalTaskQueueConfig.md) -- [Mempool](interfaces/Mempool.md) -- [MerkleTreeNode](interfaces/MerkleTreeNode.md) -- [MerkleTreeNodeQuery](interfaces/MerkleTreeNodeQuery.md) -- [MessageStorage](interfaces/MessageStorage.md) -- [MinaBaseLayerConfig](interfaces/MinaBaseLayerConfig.md) -- [NetworkStateTransportModule](interfaces/NetworkStateTransportModule.md) -- [NewBlockProverParameters](interfaces/NewBlockProverParameters.md) -- [OutgoingMessage](interfaces/OutgoingMessage.md) -- [OutgoingMessageQueue](interfaces/OutgoingMessageQueue.md) -- [PairingDerivedInput](interfaces/PairingDerivedInput.md) -- [QueryGetterState](interfaces/QueryGetterState.md) -- [QueryGetterStateMap](interfaces/QueryGetterStateMap.md) -- [QueryTransportModule](interfaces/QueryTransportModule.md) -- [RuntimeProofParameters](interfaces/RuntimeProofParameters.md) -- [Sequenceable](interfaces/Sequenceable.md) -- [SettleableBatch](interfaces/SettleableBatch.md) -- [Settlement](interfaces/Settlement.md) -- [SettlementModuleConfig](interfaces/SettlementModuleConfig.md) -- [SettlementStorage](interfaces/SettlementStorage.md) -- [StateEntry](interfaces/StateEntry.md) -- [StateTransitionProofParameters](interfaces/StateTransitionProofParameters.md) -- [StorageDependencyFactory](interfaces/StorageDependencyFactory.md) -- [StorageDependencyMinimumDependencies](interfaces/StorageDependencyMinimumDependencies.md) -- [Task](interfaces/Task.md) -- [TaskPayload](interfaces/TaskPayload.md) -- [TaskQueue](interfaces/TaskQueue.md) -- [TaskSerializer](interfaces/TaskSerializer.md) -- [TimedBlockTriggerConfig](interfaces/TimedBlockTriggerConfig.md) -- [TimedBlockTriggerEvent](interfaces/TimedBlockTriggerEvent.md) -- [TransactionExecutionResult](interfaces/TransactionExecutionResult.md) -- [TransactionStorage](interfaces/TransactionStorage.md) -- [TransactionTrace](interfaces/TransactionTrace.md) -- [TxEvents](interfaces/TxEvents.md) - -## Type Aliases - -- [AllTaskWorkerModules](type-aliases/AllTaskWorkerModules.md) -- [BlockEvents](type-aliases/BlockEvents.md) -- [ChainStateTaskArgs](type-aliases/ChainStateTaskArgs.md) -- [DatabasePruneConfig](type-aliases/DatabasePruneConfig.md) -- [JSONEncodableState](type-aliases/JSONEncodableState.md) -- [MapStateMapToQuery](type-aliases/MapStateMapToQuery.md) -- [MapStateToQuery](type-aliases/MapStateToQuery.md) -- [MempoolEvents](type-aliases/MempoolEvents.md) -- [ModuleQuery](type-aliases/ModuleQuery.md) -- [NewBlockProvingParameters](type-aliases/NewBlockProvingParameters.md) -- [PairTuple](type-aliases/PairTuple.md) -- [PickByType](type-aliases/PickByType.md) -- [PickStateMapProperties](type-aliases/PickStateMapProperties.md) -- [PickStateProperties](type-aliases/PickStateProperties.md) -- [Query](type-aliases/Query.md) -- [RuntimeContextReducedExecutionResult](type-aliases/RuntimeContextReducedExecutionResult.md) -- [SequencerModulesRecord](type-aliases/SequencerModulesRecord.md) -- [SerializedArtifactRecord](type-aliases/SerializedArtifactRecord.md) -- [SettlementModuleEvents](type-aliases/SettlementModuleEvents.md) -- [SomeRuntimeMethod](type-aliases/SomeRuntimeMethod.md) -- [StateRecord](type-aliases/StateRecord.md) -- [TaskStateRecord](type-aliases/TaskStateRecord.md) -- [TaskWorkerModulesRecord](type-aliases/TaskWorkerModulesRecord.md) -- [TaskWorkerModulesWithoutSettlement](type-aliases/TaskWorkerModulesWithoutSettlement.md) -- [TransactionProvingTaskParameters](type-aliases/TransactionProvingTaskParameters.md) -- [TransactionTaskArgs](type-aliases/TransactionTaskArgs.md) -- [TransactionTaskResult](type-aliases/TransactionTaskResult.md) -- [TypedClass](type-aliases/TypedClass.md) -- [UnsignedTransactionBody](type-aliases/UnsignedTransactionBody.md) -- [VerificationKeyJSON](type-aliases/VerificationKeyJSON.md) - -## Variables - -- [Block](variables/Block.md) -- [BlockWithResult](variables/BlockWithResult.md) -- [JSONTaskSerializer](variables/JSONTaskSerializer.md) -- [QueryBuilderFactory](variables/QueryBuilderFactory.md) - -## Functions - -- [closeable](functions/closeable.md) -- [distinct](functions/distinct.md) -- [distinctByPredicate](functions/distinctByPredicate.md) -- [distinctByString](functions/distinctByString.md) -- [executeWithExecutionContext](functions/executeWithExecutionContext.md) -- [sequencerModule](functions/sequencerModule.md) diff --git a/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md b/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md deleted file mode 100644 index c6499e4..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/AsyncMerkleTreeStore.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: AsyncMerkleTreeStore ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / AsyncMerkleTreeStore - -# Interface: AsyncMerkleTreeStore - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L10) - -## Properties - -### commit() - -> **commit**: () => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L13) - -#### Returns - -`Promise`\<`void`\> - -*** - -### getNodesAsync() - -> **getNodesAsync**: (`nodes`) => `Promise`\<(`undefined` \| `bigint`)[]\> - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L17) - -#### Parameters - -##### nodes - -[`MerkleTreeNodeQuery`](MerkleTreeNodeQuery.md)[] - -#### Returns - -`Promise`\<(`undefined` \| `bigint`)[]\> - -*** - -### openTransaction() - -> **openTransaction**: () => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L11) - -#### Returns - -`Promise`\<`void`\> - -*** - -### writeNodes() - -> **writeNodes**: (`nodes`) => `void` - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L15) - -#### Parameters - -##### nodes - -[`MerkleTreeNode`](MerkleTreeNode.md)[] - -#### Returns - -`void` diff --git a/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md b/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md deleted file mode 100644 index 0daacaf..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/AsyncStateService.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: AsyncStateService ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / AsyncStateService - -# Interface: AsyncStateService - -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L13) - -This Interface should be implemented for services that store the state -in an external storage (like a DB). This can be used in conjunction with -CachedStateService to preload keys for In-Circuit usage. - -## Properties - -### commit() - -> **commit**: () => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L16) - -#### Returns - -`Promise`\<`void`\> - -*** - -### get() - -> **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> - -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L22) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| `Field`[]\> - -*** - -### getMany() - -> **getMany**: (`keys`) => `Promise`\<[`StateEntry`](StateEntry.md)[]\> - -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L20) - -#### Parameters - -##### keys - -`Field`[] - -#### Returns - -`Promise`\<[`StateEntry`](StateEntry.md)[]\> - -*** - -### openTransaction() - -> **openTransaction**: () => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L14) - -#### Returns - -`Promise`\<`void`\> - -*** - -### writeStates() - -> **writeStates**: (`entries`) => `void` - -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L18) - -#### Parameters - -##### entries - -[`StateEntry`](StateEntry.md)[] - -#### Returns - -`void` diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md deleted file mode 100644 index 5f571b8..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BaseLayer.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: BaseLayer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BaseLayer - -# Interface: BaseLayer - -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L16) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Extends - -- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) - -## Properties - -### dependencies() - -> **dependencies**: () => [`BaseLayerDependencyRecord`](BaseLayerDependencyRecord.md) - -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L17) - -#### Returns - -[`BaseLayerDependencyRecord`](BaseLayerDependencyRecord.md) - -#### Overrides - -[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md deleted file mode 100644 index 35ffe87..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BaseLayerContractPermissions.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: BaseLayerContractPermissions ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BaseLayerContractPermissions - -# Interface: BaseLayerContractPermissions - -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L3) - -## Methods - -### bridgeContractMina() - -> **bridgeContractMina**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L6) - -#### Returns - -`Permissions` - -*** - -### bridgeContractToken() - -> **bridgeContractToken**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L9) - -#### Returns - -`Permissions` - -*** - -### dispatchContract() - -> **dispatchContract**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L5) - -#### Returns - -`Permissions` - -*** - -### settlementContract() - -> **settlementContract**(): `Permissions` - -Defined in: [packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/permissions/BaseLayerContractPermissions.ts#L4) - -#### Returns - -`Permissions` diff --git a/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md b/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md deleted file mode 100644 index 7f86217..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BaseLayerDependencyRecord.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: BaseLayerDependencyRecord ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BaseLayerDependencyRecord - -# Interface: BaseLayerDependencyRecord - -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L10) - -## Extends - -- [`DependencyRecord`](../../common/type-aliases/DependencyRecord.md) - -## Indexable - -\[`key`: `string`\]: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<`unknown`\> & `object` - -## Properties - -### IncomingMessageAdapter - -> **IncomingMessageAdapter**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`IncomingMessageAdapter`](IncomingMessageAdapter.md)\> - -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L11) - -*** - -### OutgoingMessageQueue - -> **OutgoingMessageQueue**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`OutgoingMessageQueue`](OutgoingMessageQueue.md)\> - -Defined in: [packages/sequencer/src/protocol/baselayer/BaseLayer.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/BaseLayer.ts#L13) diff --git a/src/pages/docs/reference/sequencer/interfaces/Batch.md b/src/pages/docs/reference/sequencer/interfaces/Batch.md deleted file mode 100644 index e989032..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/Batch.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Batch ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Batch - -# Interface: Batch - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L12) - -## Extended by - -- [`SettleableBatch`](SettleableBatch.md) - -## Properties - -### blockHashes - -> **blockHashes**: `string`[] - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L14) - -*** - -### height - -> **height**: `number` - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L15) - -*** - -### proof - -> **proof**: `JsonProof` - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L13) diff --git a/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md b/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md deleted file mode 100644 index 7274178..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BatchStorage.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: BatchStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BatchStorage - -# Interface: BatchStorage - -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L3) - -## Properties - -### getCurrentBatchHeight() - -> **getCurrentBatchHeight**: () => `Promise`\<`number`\> - -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L5) - -#### Returns - -`Promise`\<`number`\> - -*** - -### getLatestBatch() - -> **getLatestBatch**: () => `Promise`\<`undefined` \| [`Batch`](Batch.md)\> - -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L6) - -#### Returns - -`Promise`\<`undefined` \| [`Batch`](Batch.md)\> - -*** - -### pushBatch() - -> **pushBatch**: (`block`) => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L7) - -#### Parameters - -##### block - -[`Batch`](Batch.md) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md b/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md deleted file mode 100644 index cbd449f..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BatchTransaction.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: BatchTransaction ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BatchTransaction - -# Interface: BatchTransaction - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L6) - -## Properties - -### status - -> **status**: `boolean` - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L8) - -*** - -### statusMessage? - -> `optional` **statusMessage**: `string` - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L9) - -*** - -### tx - -> **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L7) diff --git a/src/pages/docs/reference/sequencer/interfaces/Block.md b/src/pages/docs/reference/sequencer/interfaces/Block.md deleted file mode 100644 index fd17788..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/Block.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: Block ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Block - -# Interface: Block - -Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L22) - -## Properties - -### fromBlockHashRoot - -> **fromBlockHashRoot**: `Field` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L33) - -*** - -### fromEternalTransactionsHash - -> **fromEternalTransactionsHash**: `Field` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L32) - -*** - -### fromMessagesHash - -> **fromMessagesHash**: `Field` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L34) - -*** - -### hash - -> **hash**: `Field` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L23) - -*** - -### height - -> **height**: `Field` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L24) - -*** - -### networkState - -> **networkState**: `object` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L25) - -#### before - -> **before**: [`NetworkState`](../../protocol/classes/NetworkState.md) - -#### during - -> **during**: [`NetworkState`](../../protocol/classes/NetworkState.md) - -*** - -### previousBlockHash - -> **previousBlockHash**: `undefined` \| `Field` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L36) - -*** - -### toEternalTransactionsHash - -> **toEternalTransactionsHash**: `Field` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L31) - -*** - -### toMessagesHash - -> **toMessagesHash**: `Field` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L35) - -*** - -### transactions - -> **transactions**: [`TransactionExecutionResult`](TransactionExecutionResult.md)[] - -Defined in: [packages/sequencer/src/storage/model/Block.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L29) - -*** - -### transactionsHash - -> **transactionsHash**: `Field` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L30) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md b/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md deleted file mode 100644 index 47a588f..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BlockConfig.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: BlockConfig ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockConfig - -# Interface: BlockConfig - -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L33) - -## Properties - -### allowEmptyBlock? - -> `optional` **allowEmptyBlock**: `boolean` - -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L34) - -*** - -### maximumBlockSize? - -> `optional` **maximumBlockSize**: `number` - -Defined in: [packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts#L35) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md b/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md deleted file mode 100644 index 35ac65d..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BlockProverParameters.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: BlockProverParameters ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockProverParameters - -# Interface: BlockProverParameters - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L35) - -## Properties - -### executionData - -> **executionData**: [`BlockProverExecutionData`](../../protocol/classes/BlockProverExecutionData.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L37) - -*** - -### publicInput - -> **publicInput**: [`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L36) - -*** - -### startingState - -> **startingState**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L38) - -*** - -### verificationKeyAttestation - -> **verificationKeyAttestation**: [`RuntimeVerificationKeyAttestation`](../../protocol/classes/RuntimeVerificationKeyAttestation.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L39) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md b/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md deleted file mode 100644 index b9b5c58..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BlockQueue.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: BlockQueue ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockQueue - -# Interface: BlockQueue - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L9) - -## Properties - -### getLatestBlockAndResult() - -> **getLatestBlockAndResult**: () => `Promise`\<`undefined` \| [`BlockWithMaybeResult`](BlockWithMaybeResult.md)\> - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L13) - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithMaybeResult`](BlockWithMaybeResult.md)\> - -*** - -### getNewBlocks() - -> **getNewBlocks**: () => `Promise`\<[`BlockWithPreviousResult`](BlockWithPreviousResult.md)[]\> - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L12) - -#### Returns - -`Promise`\<[`BlockWithPreviousResult`](BlockWithPreviousResult.md)[]\> - -*** - -### pushBlock() - -> **pushBlock**: (`block`) => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L10) - -#### Parameters - -##### block - -[`Block`](Block.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### pushResult() - -> **pushResult**: (`result`) => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L11) - -#### Parameters - -##### result - -[`BlockResult`](BlockResult.md) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockResult.md deleted file mode 100644 index 0f37213..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BlockResult.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: BlockResult ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockResult - -# Interface: BlockResult - -Defined in: [packages/sequencer/src/storage/model/Block.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L50) - -## Properties - -### afterNetworkState - -> **afterNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) - -Defined in: [packages/sequencer/src/storage/model/Block.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L54) - -*** - -### blockHash - -> **blockHash**: `bigint` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L51) - -*** - -### blockHashRoot - -> **blockHashRoot**: `bigint` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L53) - -*** - -### blockHashWitness - -> **blockHashWitness**: [`BlockHashMerkleTreeWitness`](../../protocol/classes/BlockHashMerkleTreeWitness.md) - -Defined in: [packages/sequencer/src/storage/model/Block.ts:56](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L56) - -*** - -### blockStateTransitions - -> **blockStateTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] - -Defined in: [packages/sequencer/src/storage/model/Block.ts:55](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L55) - -*** - -### stateRoot - -> **stateRoot**: `bigint` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L52) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md b/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md deleted file mode 100644 index 840e68a..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BlockStorage.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: BlockStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockStorage - -# Interface: BlockStorage - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L16) - -## Properties - -### getCurrentBlockHeight() - -> **getCurrentBlockHeight**: () => `Promise`\<`number`\> - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L17) - -#### Returns - -`Promise`\<`number`\> - -*** - -### getLatestBlock() - -> **getLatestBlock**: () => `Promise`\<`undefined` \| [`BlockWithResult`](BlockWithResult.md)\> - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L18) - -#### Returns - -`Promise`\<`undefined` \| [`BlockWithResult`](BlockWithResult.md)\> - -*** - -### pushBlock() - -> **pushBlock**: (`block`) => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L19) - -#### Parameters - -##### block - -[`Block`](Block.md) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md b/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md deleted file mode 100644 index 6451685..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BlockTrace.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: BlockTrace ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockTrace - -# Interface: BlockTrace - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L43) - -## Properties - -### block - -> **block**: [`NewBlockProverParameters`](NewBlockProverParameters.md) - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L44) - -*** - -### stateTransitionProver - -> **stateTransitionProver**: [`StateTransitionProofParameters`](StateTransitionProofParameters.md)[] - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:45](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L45) - -*** - -### transactions - -> **transactions**: [`TransactionTrace`](TransactionTrace.md)[] - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:46](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L46) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md b/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md deleted file mode 100644 index 1ef8b51..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BlockTrigger.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: BlockTrigger ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockTrigger - -# Interface: BlockTrigger - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L24) - -A BlockTrigger is the primary method to start the production of a block and -all associated processes. diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md deleted file mode 100644 index e6b54f3..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BlockWithMaybeResult.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: BlockWithMaybeResult ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockWithMaybeResult - -# Interface: BlockWithMaybeResult - -Defined in: [packages/sequencer/src/storage/model/Block.ts:64](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L64) - -## Properties - -### block - -> **block**: [`Block`](Block.md) - -Defined in: [packages/sequencer/src/storage/model/Block.ts:65](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L65) - -*** - -### result? - -> `optional` **result**: [`BlockResult`](BlockResult.md) - -Defined in: [packages/sequencer/src/storage/model/Block.ts:66](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L66) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md deleted file mode 100644 index b92848f..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BlockWithPreviousResult.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: BlockWithPreviousResult ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockWithPreviousResult - -# Interface: BlockWithPreviousResult - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L49) - -## Properties - -### block - -> **block**: [`BlockWithResult`](BlockWithResult.md) - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:50](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L50) - -*** - -### lastBlockResult? - -> `optional` **lastBlockResult**: [`BlockResult`](BlockResult.md) - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:51](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L51) diff --git a/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md b/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md deleted file mode 100644 index 4e6c318..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/BlockWithResult.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: BlockWithResult ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockWithResult - -# Interface: BlockWithResult - -Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L59) - -## Extended by - -- [`IndexBlockTaskParameters`](../../indexer/interfaces/IndexBlockTaskParameters.md) - -## Properties - -### block - -> **block**: [`Block`](Block.md) - -Defined in: [packages/sequencer/src/storage/model/Block.ts:60](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L60) - -*** - -### result - -> **result**: [`BlockResult`](BlockResult.md) - -Defined in: [packages/sequencer/src/storage/model/Block.ts:61](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L61) diff --git a/src/pages/docs/reference/sequencer/interfaces/Closeable.md b/src/pages/docs/reference/sequencer/interfaces/Closeable.md deleted file mode 100644 index c245565..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/Closeable.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Closeable ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Closeable - -# Interface: Closeable - -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/Closeable.ts#L3) - -## Extended by - -- [`InstantiatedQueue`](InstantiatedQueue.md) -- [`Database`](Database.md) - -## Properties - -### close() - -> **close**: () => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/Database.md b/src/pages/docs/reference/sequencer/interfaces/Database.md deleted file mode 100644 index a966282..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/Database.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: Database ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Database - -# Interface: Database - -Defined in: [packages/sequencer/src/storage/Database.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/Database.ts#L5) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Extends - -- [`StorageDependencyFactory`](StorageDependencyFactory.md).[`Closeable`](Closeable.md) - -## Properties - -### close() - -> **close**: () => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`Closeable`](Closeable.md).[`close`](Closeable.md#close) - -*** - -### dependencies() - -> **dependencies**: () => [`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) - -#### Returns - -[`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) - -#### Inherited from - -[`StorageDependencyFactory`](StorageDependencyFactory.md).[`dependencies`](StorageDependencyFactory.md#dependencies) - -## Methods - -### executeInTransaction() - -> **executeInTransaction**(`f`): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/Database.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/Database.ts#L13) - -#### Parameters - -##### f - -() => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -*** - -### pruneDatabase() - -> **pruneDatabase**(): `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/Database.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/Database.ts#L11) - -Prunes all data from the database connection. -Note: This function should only be called immediately at startup, -everything else will lead to unexpected behaviour and errors - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md b/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md deleted file mode 100644 index cae4d47..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/HistoricalBatchStorage.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: HistoricalBatchStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / HistoricalBatchStorage - -# Interface: HistoricalBatchStorage - -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:10](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L10) - -## Properties - -### getBatchAt() - -> **getBatchAt**: (`height`) => `Promise`\<`undefined` \| [`Batch`](Batch.md)\> - -Defined in: [packages/sequencer/src/storage/repositories/BatchStorage.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BatchStorage.ts#L11) - -#### Parameters - -##### height - -`number` - -#### Returns - -`Promise`\<`undefined` \| [`Batch`](Batch.md)\> diff --git a/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md b/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md deleted file mode 100644 index 95c8fa8..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/HistoricalBlockStorage.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: HistoricalBlockStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / HistoricalBlockStorage - -# Interface: HistoricalBlockStorage - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L22) - -## Properties - -### getBlock() - -> **getBlock**: (`hash`) => `Promise`\<`undefined` \| [`Block`](Block.md)\> - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L24) - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<`undefined` \| [`Block`](Block.md)\> - -*** - -### getBlockAt() - -> **getBlockAt**: (`height`) => `Promise`\<`undefined` \| [`Block`](Block.md)\> - -Defined in: [packages/sequencer/src/storage/repositories/BlockStorage.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/BlockStorage.ts#L23) - -#### Parameters - -##### height - -`number` - -#### Returns - -`Promise`\<`undefined` \| [`Block`](Block.md)\> diff --git a/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md b/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md deleted file mode 100644 index ff4d8a9..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/IncomingMessageAdapter.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: IncomingMessageAdapter ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / IncomingMessageAdapter - -# Interface: IncomingMessageAdapter - -Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L11) - -An interface provided by the BaseLayer via DependencyFactory, -which implements a function that allows us to retrieve -unconsumed incoming messages from the BaseLayer -(Dispatched Deposit Actions for example) - -## Properties - -### getPendingMessages() - -> **getPendingMessages**: (`address`, `params`) => `Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](../classes/PendingTransaction.md)[]; `to`: `string`; \}\> - -Defined in: [packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/IncomingMessageAdapter.ts#L12) - -#### Parameters - -##### address - -`PublicKey` - -##### params - -###### fromActionHash - -`string` - -###### fromL1BlockHeight - -`number` - -###### toActionHash - -`string` - -#### Returns - -`Promise`\<\{ `from`: `string`; `messages`: [`PendingTransaction`](../classes/PendingTransaction.md)[]; `to`: `string`; \}\> diff --git a/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md b/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md deleted file mode 100644 index b06b612..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/InstantiatedQueue.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: InstantiatedQueue ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / InstantiatedQueue - -# Interface: InstantiatedQueue - -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L20) - -Object that abstracts a concrete connection to a queue instance. - -## Extends - -- [`Closeable`](Closeable.md) - -## Properties - -### addTask() - -> **addTask**: (`payload`, `taskId`?) => `Promise`\<\{ `taskId`: `string`; \}\> - -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L26) - -Adds a specific payload to the queue and returns a unique jobId - -#### Parameters - -##### payload - -[`TaskPayload`](TaskPayload.md) - -##### taskId? - -`string` - -#### Returns - -`Promise`\<\{ `taskId`: `string`; \}\> - -*** - -### close() - -> **close**: () => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/sequencer/builder/Closeable.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/builder/Closeable.ts#L4) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`Closeable`](Closeable.md).[`close`](Closeable.md#close) - -*** - -### name - -> **name**: `string` - -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L21) - -*** - -### offCompleted() - -> **offCompleted**: (`listenerId`) => `void` - -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L38) - -#### Parameters - -##### listenerId - -`number` - -#### Returns - -`void` - -*** - -### onCompleted() - -> **onCompleted**: (`listener`) => `Promise`\<`number`\> - -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L34) - -Registers a listener for the completion of jobs - -#### Parameters - -##### listener - -(`payload`) => `Promise`\<`void`\> - -#### Returns - -`Promise`\<`number`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md b/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md deleted file mode 100644 index ddb55a9..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/LocalTaskQueueConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: LocalTaskQueueConfig ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / LocalTaskQueueConfig - -# Interface: LocalTaskQueueConfig - -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L22) - -## Properties - -### simulatedDuration? - -> `optional` **simulatedDuration**: `number` - -Defined in: [packages/sequencer/src/worker/queue/LocalTaskQueue.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/LocalTaskQueue.ts#L23) diff --git a/src/pages/docs/reference/sequencer/interfaces/Mempool.md b/src/pages/docs/reference/sequencer/interfaces/Mempool.md deleted file mode 100644 index b7dba63..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/Mempool.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Mempool ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Mempool - -# Interface: Mempool\ - -Defined in: [packages/sequencer/src/mempool/Mempool.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/Mempool.ts#L9) - -## Extends - -- [`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md)\<`Events`\> - -## Type Parameters - -• **Events** *extends* [`MempoolEvents`](../type-aliases/MempoolEvents.md) = [`MempoolEvents`](../type-aliases/MempoolEvents.md) - -## Properties - -### add() - -> **add**: (`tx`) => `Promise`\<`boolean`\> - -Defined in: [packages/sequencer/src/mempool/Mempool.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/Mempool.ts#L15) - -Add a transaction to the mempool - -#### Parameters - -##### tx - -[`PendingTransaction`](../classes/PendingTransaction.md) - -#### Returns - -`Promise`\<`boolean`\> - -The new commitment to the mempool - -*** - -### events - -> **events**: [`EventEmitter`](../../common/classes/EventEmitter.md)\<`Events`\> - -Defined in: packages/common/dist/events/EventEmittingComponent.d.ts:4 - -#### Inherited from - -[`EventEmittingComponent`](../../common/interfaces/EventEmittingComponent.md).[`events`](../../common/interfaces/EventEmittingComponent.md#events) - -*** - -### getTxs() - -> **getTxs**: (`limit`?) => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> - -Defined in: [packages/sequencer/src/mempool/Mempool.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/Mempool.ts#L20) - -Retrieve all transactions that are currently in the mempool - -#### Parameters - -##### limit? - -`number` - -#### Returns - -`Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> diff --git a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md deleted file mode 100644 index c4beb51..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNode.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: MerkleTreeNode ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MerkleTreeNode - -# Interface: MerkleTreeNode - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L6) - -## Extends - -- [`MerkleTreeNodeQuery`](MerkleTreeNodeQuery.md) - -## Properties - -### key - -> **key**: `bigint` - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) - -#### Inherited from - -[`MerkleTreeNodeQuery`](MerkleTreeNodeQuery.md).[`key`](MerkleTreeNodeQuery.md#key) - -*** - -### level - -> **level**: `number` - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) - -#### Inherited from - -[`MerkleTreeNodeQuery`](MerkleTreeNodeQuery.md).[`level`](MerkleTreeNodeQuery.md#level) - -*** - -### value - -> **value**: `bigint` - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L7) diff --git a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md b/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md deleted file mode 100644 index 5628bd9..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/MerkleTreeNodeQuery.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: MerkleTreeNodeQuery ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MerkleTreeNodeQuery - -# Interface: MerkleTreeNodeQuery - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L1) - -## Extended by - -- [`MerkleTreeNode`](MerkleTreeNode.md) - -## Properties - -### key - -> **key**: `bigint` - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:2](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L2) - -*** - -### level - -> **level**: `number` - -Defined in: [packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncMerkleTreeStore.ts#L3) diff --git a/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md b/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md deleted file mode 100644 index baffdd2..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/MessageStorage.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: MessageStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MessageStorage - -# Interface: MessageStorage - -Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/MessageStorage.ts#L6) - -Interface to store Messages previously fetched by a IncomingMessageadapter - -## Properties - -### getMessages() - -> **getMessages**: (`fromMessagesHash`) => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> - -Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/MessageStorage.ts#L12) - -#### Parameters - -##### fromMessagesHash - -`string` - -#### Returns - -`Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> - -*** - -### pushMessages() - -> **pushMessages**: (`fromMessagesHash`, `toMessagesHash`, `messages`) => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/repositories/MessageStorage.ts:7](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/MessageStorage.ts#L7) - -#### Parameters - -##### fromMessagesHash - -`string` - -##### toMessagesHash - -`string` - -##### messages - -[`PendingTransaction`](../classes/PendingTransaction.md)[] - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md b/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md deleted file mode 100644 index f7fb3f8..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/MinaBaseLayerConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: MinaBaseLayerConfig ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MinaBaseLayerConfig - -# Interface: MinaBaseLayerConfig - -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L16) - -## Properties - -### network - -> **network**: \{ `type`: `"local"`; \} \| \{ `accountManager`: `string`; `archive`: `string`; `graphql`: `string`; `type`: `"lightnet"`; \} \| \{ `archive`: `string`; `graphql`: `string`; `type`: `"remote"`; \} - -Defined in: [packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts#L17) diff --git a/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md b/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md deleted file mode 100644 index eb14415..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/NetworkStateTransportModule.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: NetworkStateTransportModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NetworkStateTransportModule - -# Interface: NetworkStateTransportModule - -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L3) - -## Properties - -### getProvenNetworkState() - -> **getProvenNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L6) - -#### Returns - -`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -*** - -### getStagedNetworkState() - -> **getStagedNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L5) - -#### Returns - -`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -*** - -### getUnprovenNetworkState() - -> **getUnprovenNetworkState**: () => `Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> - -Defined in: [packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/NetworkStateTransportModule.ts#L4) - -#### Returns - -`Promise`\<`undefined` \| [`NetworkState`](../../protocol/classes/NetworkState.md)\> diff --git a/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md b/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md deleted file mode 100644 index f412b01..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/NewBlockProverParameters.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: NewBlockProverParameters ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NewBlockProverParameters - -# Interface: NewBlockProverParameters - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L30) - -## Properties - -### blockWitness - -> **blockWitness**: [`BlockHashMerkleTreeWitness`](../../protocol/classes/BlockHashMerkleTreeWitness.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L33) - -*** - -### networkState - -> **networkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L32) - -*** - -### publicInput - -> **publicInput**: [`BlockProverPublicInput`](../../protocol/classes/BlockProverPublicInput.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L31) - -*** - -### startingState - -> **startingState**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:34](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L34) diff --git a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md deleted file mode 100644 index 1591331..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessage.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: OutgoingMessage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / OutgoingMessage - -# Interface: OutgoingMessage\ - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L13) - -## Type Parameters - -• **Type** - -## Properties - -### index - -> **index**: `number` - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L14) - -*** - -### value - -> **value**: `Type` - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L15) diff --git a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md b/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md deleted file mode 100644 index 1cc47e5..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/OutgoingMessageQueue.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: OutgoingMessageQueue ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / OutgoingMessageQueue - -# Interface: OutgoingMessageQueue - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L37) - -This interface allows the SettlementModule to retrieve information about -pending L2-dispatched (outgoing) messages that it can then use to roll -them up on the L1 contract. - -In the future, this interface should be flexibly typed so that the -outgoing message type is not limited to Withdrawals - -## Properties - -### length() - -> **length**: () => `number` - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L40) - -#### Returns - -`number` - -*** - -### peek() - -> **peek**: (`num`) => [`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L38) - -#### Parameters - -##### num - -`number` - -#### Returns - -[`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] - -*** - -### pop() - -> **pop**: (`num`) => [`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] - -Defined in: [packages/sequencer/src/settlement/messages/WithdrawalQueue.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/messages/WithdrawalQueue.ts#L39) - -#### Parameters - -##### num - -`number` - -#### Returns - -[`OutgoingMessage`](OutgoingMessage.md)\<[`Withdrawal`](../../protocol/classes/Withdrawal.md)\>[] diff --git a/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md b/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md deleted file mode 100644 index 1713dfc..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/PairingDerivedInput.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: PairingDerivedInput ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PairingDerivedInput - -# Interface: PairingDerivedInput\ - -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L16) - -This type is used to consistently define the input type of a MapReduce flow - that is depenend on the result a pairing. - -## Type Parameters - -• **Input1** - -• **Input2** - -• **AdditionalParameters** - -## Properties - -### input1 - -> **input1**: `Input1` - -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L17) - -*** - -### input2 - -> **input2**: `Input2` - -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L18) - -*** - -### params - -> **params**: `AdditionalParameters` - -Defined in: [packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/flow/ReductionTaskFlow.ts#L19) diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md b/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md deleted file mode 100644 index 5f35a7a..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/QueryGetterState.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: QueryGetterState ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / QueryGetterState - -# Interface: QueryGetterState\ - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L24) - -## Type Parameters - -• **Value** - -## Properties - -### get() - -> **get**: () => `Promise`\<`undefined` \| `Value`\> - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L25) - -#### Returns - -`Promise`\<`undefined` \| `Value`\> - -*** - -### merkleWitness() - -> **merkleWitness**: () => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L27) - -#### Returns - -`Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> - -*** - -### path() - -> **path**: () => `string` - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L26) - -#### Returns - -`string` diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md b/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md deleted file mode 100644 index f600f6d..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/QueryGetterStateMap.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: QueryGetterStateMap ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / QueryGetterStateMap - -# Interface: QueryGetterStateMap\ - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L30) - -## Type Parameters - -• **Key** - -• **Value** - -## Properties - -### get() - -> **get**: (`key`) => `Promise`\<`undefined` \| `Value`\> - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L31) - -#### Parameters - -##### key - -`Key` - -#### Returns - -`Promise`\<`undefined` \| `Value`\> - -*** - -### merkleWitness() - -> **merkleWitness**: (`key`) => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L33) - -#### Parameters - -##### key - -`Key` - -#### Returns - -`Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> - -*** - -### path() - -> **path**: (`key`) => `string` - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L32) - -#### Parameters - -##### key - -`Key` - -#### Returns - -`string` diff --git a/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md b/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md deleted file mode 100644 index 72d5eb7..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/QueryTransportModule.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: QueryTransportModule ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / QueryTransportModule - -# Interface: QueryTransportModule - -Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L4) - -## Properties - -### get() - -> **get**: (`key`) => `Promise`\<`undefined` \| `Field`[]\> - -Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L5) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| `Field`[]\> - -*** - -### merkleWitness() - -> **merkleWitness**: (`key`) => `Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> - -Defined in: [packages/sequencer/src/helpers/query/QueryTransportModule.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryTransportModule.ts#L6) - -#### Parameters - -##### key - -`Field` - -#### Returns - -`Promise`\<`undefined` \| [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)\> diff --git a/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md b/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md deleted file mode 100644 index 8cf017f..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/RuntimeProofParameters.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: RuntimeProofParameters ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / RuntimeProofParameters - -# Interface: RuntimeProofParameters - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L26) - -## Properties - -### networkState - -> **networkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L28) - -*** - -### state - -> **state**: [`TaskStateRecord`](../type-aliases/TaskStateRecord.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L29) - -*** - -### tx - -> **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L27) diff --git a/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md b/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md deleted file mode 100644 index a380a9a..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/Sequenceable.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Sequenceable ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Sequenceable - -# Interface: Sequenceable - -Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L1) - -## Properties - -### start() - -> **start**: () => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/sequencer/executor/Sequenceable.ts:2](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequenceable.ts#L2) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md b/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md deleted file mode 100644 index bf97107..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/SettleableBatch.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: SettleableBatch ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettleableBatch - -# Interface: SettleableBatch - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L18) - -## Extends - -- [`Batch`](Batch.md) - -## Properties - -### blockHashes - -> **blockHashes**: `string`[] - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L14) - -#### Inherited from - -[`Batch`](Batch.md).[`blockHashes`](Batch.md#blockhashes) - -*** - -### fromNetworkState - -> **fromNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L19) - -*** - -### height - -> **height**: `number` - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L15) - -#### Inherited from - -[`Batch`](Batch.md).[`height`](Batch.md#height) - -*** - -### proof - -> **proof**: `JsonProof` - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L13) - -#### Inherited from - -[`Batch`](Batch.md).[`proof`](Batch.md#proof) - -*** - -### toNetworkState - -> **toNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) - -Defined in: [packages/sequencer/src/storage/model/Batch.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Batch.ts#L20) diff --git a/src/pages/docs/reference/sequencer/interfaces/Settlement.md b/src/pages/docs/reference/sequencer/interfaces/Settlement.md deleted file mode 100644 index 2cf3737..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/Settlement.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Settlement ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Settlement - -# Interface: Settlement - -Defined in: [packages/sequencer/src/storage/model/Settlement.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Settlement.ts#L1) - -## Properties - -### batches - -> **batches**: `number`[] - -Defined in: [packages/sequencer/src/storage/model/Settlement.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Settlement.ts#L6) - -*** - -### promisedMessagesHash - -> **promisedMessagesHash**: `string` - -Defined in: [packages/sequencer/src/storage/model/Settlement.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Settlement.ts#L5) diff --git a/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md b/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md deleted file mode 100644 index b451c62..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/SettlementModuleConfig.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: SettlementModuleConfig ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettlementModuleConfig - -# Interface: SettlementModuleConfig - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L52) - -## Properties - -### address? - -> `optional` **address**: `PublicKey` - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L54) - -*** - -### feepayer - -> **feepayer**: `PrivateKey` - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:53](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L53) diff --git a/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md b/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md deleted file mode 100644 index db2dfa5..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/SettlementStorage.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: SettlementStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettlementStorage - -# Interface: SettlementStorage - -Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L3) - -## Properties - -### pushSettlement() - -> **pushSettlement**: (`settlement`) => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/storage/repositories/SettlementStorage.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/SettlementStorage.ts#L4) - -#### Parameters - -##### settlement - -[`Settlement`](Settlement.md) - -#### Returns - -`Promise`\<`void`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/StateEntry.md b/src/pages/docs/reference/sequencer/interfaces/StateEntry.md deleted file mode 100644 index e992e4d..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/StateEntry.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: StateEntry ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateEntry - -# Interface: StateEntry - -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L3) - -## Properties - -### key - -> **key**: `Field` - -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L4) - -*** - -### value - -> **value**: `undefined` \| `Field`[] - -Defined in: [packages/sequencer/src/state/async/AsyncStateService.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/state/async/AsyncStateService.ts#L5) diff --git a/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md b/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md deleted file mode 100644 index d127f12..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/StateTransitionProofParameters.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: StateTransitionProofParameters ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateTransitionProofParameters - -# Interface: StateTransitionProofParameters - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L27) - -## Properties - -### merkleWitnesses - -> **merkleWitnesses**: [`RollupMerkleTreeWitness`](../../common/classes/RollupMerkleTreeWitness.md)[] - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:33](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L33) - -*** - -### publicInput - -> **publicInput**: [`StateTransitionProverPublicInput`](../../protocol/classes/StateTransitionProverPublicInput.md) - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L28) - -*** - -### stateTransitions - -> **stateTransitions**: `object`[] - -Defined in: [packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/StateTransitionTask.ts#L29) - -#### transition - -> **transition**: [`ProvableStateTransition`](../../protocol/classes/ProvableStateTransition.md) - -#### type - -> **type**: [`ProvableStateTransitionType`](../../protocol/classes/ProvableStateTransitionType.md) diff --git a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md deleted file mode 100644 index e932628..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyFactory.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: StorageDependencyFactory ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StorageDependencyFactory - -# Interface: StorageDependencyFactory - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L30) - -This is an abstract class for creating DependencyFactories, a pattern -to bundle multiple smaller services into one and register them into the -injection context. - -This can for example be a StorageDependencyFactory that creates dependencies -like StateService, MerkleWitnessService, etc. So in general, services that -are not ConfigurableModules, but still are their own logical unit. - -DependencyFactories are designed to only be used statically for sets of -deps that are necessary for the sequencer to work. - -## Extends - -- [`DependencyFactory`](../../common/interfaces/DependencyFactory.md) - -## Extended by - -- [`Database`](Database.md) - -## Properties - -### dependencies() - -> **dependencies**: () => [`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L31) - -#### Returns - -[`StorageDependencyMinimumDependencies`](StorageDependencyMinimumDependencies.md) - -#### Overrides - -[`DependencyFactory`](../../common/interfaces/DependencyFactory.md).[`dependencies`](../../common/interfaces/DependencyFactory.md#dependencies) diff --git a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md b/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md deleted file mode 100644 index 6956718..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/StorageDependencyMinimumDependencies.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: StorageDependencyMinimumDependencies ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StorageDependencyMinimumDependencies - -# Interface: StorageDependencyMinimumDependencies - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L16) - -## Extends - -- [`DependencyRecord`](../../common/type-aliases/DependencyRecord.md) - -## Indexable - -\[`key`: `string`\]: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<`unknown`\> & `object` - -## Properties - -### asyncMerkleStore - -> **asyncMerkleStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L18) - -*** - -### asyncStateService - -> **asyncStateService**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncStateService`](AsyncStateService.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L17) - -*** - -### batchStorage - -> **batchStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BatchStorage`](BatchStorage.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L19) - -*** - -### blockQueue - -> **blockQueue**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BlockQueue`](BlockQueue.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L20) - -*** - -### blockStorage - -> **blockStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`BlockStorage`](BlockStorage.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L21) - -*** - -### blockTreeStore - -> **blockTreeStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L24) - -*** - -### messageStorage - -> **messageStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`MessageStorage`](MessageStorage.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L25) - -*** - -### settlementStorage - -> **settlementStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`SettlementStorage`](SettlementStorage.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L26) - -*** - -### transactionStorage - -> **transactionStorage**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`TransactionStorage`](TransactionStorage.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L27) - -*** - -### unprovenMerkleStore - -> **unprovenMerkleStore**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncMerkleTreeStore`](AsyncMerkleTreeStore.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L23) - -*** - -### unprovenStateService - -> **unprovenStateService**: [`DependencyDeclaration`](../../common/type-aliases/DependencyDeclaration.md)\<[`AsyncStateService`](AsyncStateService.md)\> - -Defined in: [packages/sequencer/src/storage/StorageDependencyFactory.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/StorageDependencyFactory.ts#L22) diff --git a/src/pages/docs/reference/sequencer/interfaces/Task.md b/src/pages/docs/reference/sequencer/interfaces/Task.md deleted file mode 100644 index 1a805a4..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/Task.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Task ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Task - -# Interface: Task\ - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:1](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L1) - -## Type Parameters - -• **Input** - -• **Result** - -## Properties - -### compute() - -> **compute**: (`input`) => `Promise`\<`Result`\> - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L6) - -#### Parameters - -##### input - -`Input` - -#### Returns - -`Promise`\<`Result`\> - -*** - -### inputSerializer() - -> **inputSerializer**: () => [`TaskSerializer`](TaskSerializer.md)\<`Input`\> - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L8) - -#### Returns - -[`TaskSerializer`](TaskSerializer.md)\<`Input`\> - -*** - -### name - -> **name**: `string` - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:2](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L2) - -*** - -### prepare() - -> **prepare**: () => `Promise`\<`void`\> - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L4) - -#### Returns - -`Promise`\<`void`\> - -*** - -### resultSerializer() - -> **resultSerializer**: () => [`TaskSerializer`](TaskSerializer.md)\<`Result`\> - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L9) - -#### Returns - -[`TaskSerializer`](TaskSerializer.md)\<`Result`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md b/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md deleted file mode 100644 index 9a2213a..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/TaskPayload.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: TaskPayload ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskPayload - -# Interface: TaskPayload - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L17) - -## Properties - -### flowId - -> **flowId**: `string` - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L22) - -*** - -### name - -> **name**: `string` - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L19) - -*** - -### payload - -> **payload**: `string` - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:20](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L20) - -*** - -### status? - -> `optional` **status**: `"error"` \| `"success"` - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L18) - -*** - -### taskId? - -> `optional` **taskId**: `string` - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:21](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L21) diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md b/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md deleted file mode 100644 index a834bd6..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/TaskQueue.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: TaskQueue ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskQueue - -# Interface: TaskQueue - -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:8](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L8) - -Definition of a connection-object that can generate queues and workers -for a specific connection type (e.g. BullMQ, In-memory) - -## Properties - -### createWorker() - -> **createWorker**: (`name`, `executor`, `options`?) => [`Closeable`](Closeable.md) - -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L11) - -#### Parameters - -##### name - -`string` - -##### executor - -(`data`) => `Promise`\<[`TaskPayload`](TaskPayload.md)\> - -##### options? - -###### concurrency - -`number` - -#### Returns - -[`Closeable`](Closeable.md) - -*** - -### getQueue() - -> **getQueue**: (`name`) => `Promise`\<[`InstantiatedQueue`](InstantiatedQueue.md)\> - -Defined in: [packages/sequencer/src/worker/queue/TaskQueue.ts:9](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/queue/TaskQueue.ts#L9) - -#### Parameters - -##### name - -`string` - -#### Returns - -`Promise`\<[`InstantiatedQueue`](InstantiatedQueue.md)\> diff --git a/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md b/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md deleted file mode 100644 index bcb4ec4..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/TaskSerializer.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: TaskSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskSerializer - -# Interface: TaskSerializer\ - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:12](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L12) - -## Type Parameters - -• **Type** - -## Properties - -### fromJSON() - -> **fromJSON**: (`json`) => `Type` \| `Promise`\<`Type`\> - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L14) - -#### Parameters - -##### json - -`string` - -#### Returns - -`Type` \| `Promise`\<`Type`\> - -*** - -### toJSON() - -> **toJSON**: (`input`) => `string` \| `Promise`\<`string`\> - -Defined in: [packages/sequencer/src/worker/flow/Task.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/Task.ts#L13) - -#### Parameters - -##### input - -`Type` - -#### Returns - -`string` \| `Promise`\<`string`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md deleted file mode 100644 index afa54ef..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerConfig.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: TimedBlockTriggerConfig ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TimedBlockTriggerConfig - -# Interface: TimedBlockTriggerConfig - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L16) - -## Properties - -### blockInterval - -> **blockInterval**: `number` - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:26](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L26) - -*** - -### produceEmptyBlocks? - -> `optional` **produceEmptyBlocks**: `boolean` - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:27](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L27) - -*** - -### settlementInterval? - -> `optional` **settlementInterval**: `number` - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L25) - -*** - -### tick? - -> `optional` **tick**: `number` - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L24) - -Interval for the tick event to be fired. -The time x of any block trigger time is always guaranteed to be -tick % x == 0. -Value has to be a divisor of gcd(blockInterval, settlementInterval). -If it doesn't satisfy this requirement, this config will not be respected diff --git a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md b/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md deleted file mode 100644 index 892910e..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/TimedBlockTriggerEvent.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: TimedBlockTriggerEvent ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TimedBlockTriggerEvent - -# Interface: TimedBlockTriggerEvent - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L30) - -## Extends - -- [`BlockEvents`](../type-aliases/BlockEvents.md) - -## Properties - -### batch-produced - -> **batch-produced**: \[[`Batch`](Batch.md)\] - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L31) - -#### Inherited from - -`BlockEvents.batch-produced` - -*** - -### block-metadata-produced - -> **block-metadata-produced**: \[[`BlockWithResult`](BlockWithResult.md)\] - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:30](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L30) - -#### Inherited from - -`BlockEvents.block-metadata-produced` - -*** - -### block-produced - -> **block-produced**: \[[`Block`](Block.md)\] - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:29](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L29) - -#### Inherited from - -`BlockEvents.block-produced` - -*** - -### tick - -> **tick**: \[`number`\] - -Defined in: [packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:31](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts#L31) diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md b/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md deleted file mode 100644 index fc1fb93..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/TransactionExecutionResult.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: TransactionExecutionResult ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionExecutionResult - -# Interface: TransactionExecutionResult - -Defined in: [packages/sequencer/src/storage/model/Block.ts:13](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L13) - -## Properties - -### events - -> **events**: `object`[] - -Defined in: [packages/sequencer/src/storage/model/Block.ts:19](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L19) - -#### data - -> **data**: `Field`[] - -#### eventName - -> **eventName**: `string` - -*** - -### protocolTransitions - -> **protocolTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] - -Defined in: [packages/sequencer/src/storage/model/Block.ts:16](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L16) - -*** - -### stateTransitions - -> **stateTransitions**: [`UntypedStateTransition`](../classes/UntypedStateTransition.md)[] - -Defined in: [packages/sequencer/src/storage/model/Block.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L15) - -*** - -### status - -> **status**: `Bool` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L17) - -*** - -### statusMessage? - -> `optional` **statusMessage**: `string` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L18) - -*** - -### tx - -> **tx**: [`PendingTransaction`](../classes/PendingTransaction.md) - -Defined in: [packages/sequencer/src/storage/model/Block.ts:14](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L14) diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md b/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md deleted file mode 100644 index 801c203..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/TransactionStorage.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: TransactionStorage ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionStorage - -# Interface: TransactionStorage - -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L3) - -## Properties - -### findTransaction() - -> **findTransaction**: (`hash`) => `Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../classes/PendingTransaction.md); \}\> - -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:15](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L15) - -Finds a transaction by its hash. -It returns both pending transaction and already included transactions -In case the transaction has been included, it also returns the block hash -and batch number where applicable. - -#### Parameters - -##### hash - -`string` - -#### Returns - -`Promise`\<`undefined` \| \{ `batch`: `number`; `block`: `string`; `transaction`: [`PendingTransaction`](../classes/PendingTransaction.md); \}\> - -*** - -### getPendingUserTransactions() - -> **getPendingUserTransactions**: () => `Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> - -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:6](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L6) - -#### Returns - -`Promise`\<[`PendingTransaction`](../classes/PendingTransaction.md)[]\> - -*** - -### pushUserTransaction() - -> **pushUserTransaction**: (`tx`) => `Promise`\<`boolean`\> - -Defined in: [packages/sequencer/src/storage/repositories/TransactionStorage.ts:4](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/repositories/TransactionStorage.ts#L4) - -#### Parameters - -##### tx - -[`PendingTransaction`](../classes/PendingTransaction.md) - -#### Returns - -`Promise`\<`boolean`\> diff --git a/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md b/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md deleted file mode 100644 index cac492d..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/TransactionTrace.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: TransactionTrace ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionTrace - -# Interface: TransactionTrace - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L37) - -## Properties - -### blockProver - -> **blockProver**: [`BlockProverParameters`](BlockProverParameters.md) - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L40) - -*** - -### runtimeProver - -> **runtimeProver**: [`RuntimeProofParameters`](RuntimeProofParameters.md) - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L38) - -*** - -### stateTransitionProver - -> **stateTransitionProver**: [`StateTransitionProofParameters`](StateTransitionProofParameters.md)[] - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:39](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L39) diff --git a/src/pages/docs/reference/sequencer/interfaces/TxEvents.md b/src/pages/docs/reference/sequencer/interfaces/TxEvents.md deleted file mode 100644 index 81cbe34..0000000 --- a/src/pages/docs/reference/sequencer/interfaces/TxEvents.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: TxEvents ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TxEvents - -# Interface: TxEvents - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L22) - -## Extends - -- [`EventsRecord`](../../common/type-aliases/EventsRecord.md) - -## Indexable - -\[`key`: `string`\]: `unknown`[] - -## Properties - -### included - -> **included**: \[\{ `hash`: `string`; \}\] - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:24](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L24) - -*** - -### rejected - -> **rejected**: \[`any`\] - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L25) - -*** - -### sent - -> **sent**: \[\{ `hash`: `string`; \}\] - -Defined in: [packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts:23](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/transactions/MinaTransactionSender.ts#L23) diff --git a/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md b/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md deleted file mode 100644 index fa266d1..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/AllTaskWorkerModules.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: AllTaskWorkerModules ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / AllTaskWorkerModules - -# Type Alias: AllTaskWorkerModules - -> **AllTaskWorkerModules**: [`ReturnType`](../../protocol/type-aliases/ReturnType.md)\<*typeof* [`allTasks`](../classes/VanillaTaskWorkerModules.md#alltasks)\> - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:172](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L172) diff --git a/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md b/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md deleted file mode 100644 index 993b841..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/BlockEvents.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: BlockEvents ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockEvents - -# Type Alias: BlockEvents - -> **BlockEvents**: `object` - -Defined in: [packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:28](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts#L28) - -## Type declaration - -### batch-produced - -> **batch-produced**: \[[`Batch`](../interfaces/Batch.md)\] - -### block-metadata-produced - -> **block-metadata-produced**: \[[`BlockWithResult`](../interfaces/BlockWithResult.md)\] - -### block-produced - -> **block-produced**: \[[`Block`](../interfaces/Block.md)\] diff --git a/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md b/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md deleted file mode 100644 index 02b8a46..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/ChainStateTaskArgs.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: ChainStateTaskArgs ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ChainStateTaskArgs - -# Type Alias: ChainStateTaskArgs - -> **ChainStateTaskArgs**: `object` - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:44](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L44) - -## Type declaration - -### accounts - -> **accounts**: `Account`[] - -### graphql - -> **graphql**: `string` \| `undefined` diff --git a/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md b/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md deleted file mode 100644 index 4fba72a..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/DatabasePruneConfig.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: DatabasePruneConfig ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / DatabasePruneConfig - -# Type Alias: DatabasePruneConfig - -> **DatabasePruneConfig**: `object` - -Defined in: [packages/sequencer/src/storage/DatabasePruneModule.ts:11](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/DatabasePruneModule.ts#L11) - -## Type declaration - -### pruneOnStartup? - -> `optional` **pruneOnStartup**: `boolean` diff --git a/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md b/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md deleted file mode 100644 index fc00272..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/JSONEncodableState.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: JSONEncodableState ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / JSONEncodableState - -# Type Alias: JSONEncodableState - -> **JSONEncodableState**: `Record`\<`string`, `string`[]\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/RuntimeProvingTask.ts#L32) diff --git a/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md b/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md deleted file mode 100644 index c69c63d..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/MapStateMapToQuery.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: MapStateMapToQuery ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MapStateMapToQuery - -# Type Alias: MapStateMapToQuery\ - -> **MapStateMapToQuery**\<`StateProperty`\>: `StateProperty` *extends* [`StateMap`](../../protocol/classes/StateMap.md)\ ? [`QueryGetterStateMap`](../interfaces/QueryGetterStateMap.md)\<`Key`, `Value`\> : `never` - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:43](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L43) - -## Type Parameters - -• **StateProperty** diff --git a/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md b/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md deleted file mode 100644 index 679ec3f..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/MapStateToQuery.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: MapStateToQuery ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MapStateToQuery - -# Type Alias: MapStateToQuery\ - -> **MapStateToQuery**\<`StateProperty`\>: `StateProperty` *extends* [`State`](../../protocol/classes/State.md)\ ? [`QueryGetterState`](../interfaces/QueryGetterState.md)\<`Value`\> : `never` - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:40](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L40) - -## Type Parameters - -• **StateProperty** diff --git a/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md b/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md deleted file mode 100644 index a060446..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/MempoolEvents.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: MempoolEvents ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / MempoolEvents - -# Type Alias: MempoolEvents - -> **MempoolEvents**: `object` - -Defined in: [packages/sequencer/src/mempool/Mempool.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/Mempool.ts#L5) - -## Type declaration - -### mempool-transaction-added - -> **mempool-transaction-added**: \[[`PendingTransaction`](../classes/PendingTransaction.md)\] diff --git a/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md b/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md deleted file mode 100644 index 3905403..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/ModuleQuery.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: ModuleQuery ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / ModuleQuery - -# Type Alias: ModuleQuery\ - -> **ModuleQuery**\<`Module`\>: `{ [Key in keyof PickStateMapProperties]: MapStateMapToQuery[Key]> }` & `{ [Key in keyof PickStateProperties]: MapStateToQuery[Key]> }` - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:48](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L48) - -## Type Parameters - -• **Module** diff --git a/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md b/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md deleted file mode 100644 index 6d6da7f..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/NewBlockProvingParameters.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: NewBlockProvingParameters ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / NewBlockProvingParameters - -# Type Alias: NewBlockProvingParameters - -> **NewBlockProvingParameters**: [`PairingDerivedInput`](../interfaces/PairingDerivedInput.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md), `BlockProof`, [`NewBlockProverParameters`](../interfaces/NewBlockProverParameters.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/NewBlockTask.ts#L37) diff --git a/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md b/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md deleted file mode 100644 index 54f9999..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/PairTuple.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: PairTuple ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PairTuple - -# Type Alias: PairTuple\ - -> **PairTuple**\<`Type`\>: \[`Type`, `Type`\] - -Defined in: [packages/sequencer/src/helpers/utils.ts:162](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/utils.ts#L162) - -## Type Parameters - -• **Type** diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickByType.md b/src/pages/docs/reference/sequencer/type-aliases/PickByType.md deleted file mode 100644 index 88cf4c4..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/PickByType.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: PickByType ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PickByType - -# Type Alias: PickByType\ - -> **PickByType**\<`Type`, `Value`\>: \{ \[Key in keyof Type as Type\[Key\] extends Value \| undefined ? Key : never\]: Type\[Key\] \} - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:18](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L18) - -## Type Parameters - -• **Type** - -• **Value** diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md b/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md deleted file mode 100644 index b8cf264..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/PickStateMapProperties.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: PickStateMapProperties ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PickStateMapProperties - -# Type Alias: PickStateMapProperties\ - -> **PickStateMapProperties**\<`Type`\>: [`PickByType`](PickByType.md)\<`Type`, [`StateMap`](../../protocol/classes/StateMap.md)\<`any`, `any`\>\> - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:38](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L38) - -## Type Parameters - -• **Type** diff --git a/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md b/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md deleted file mode 100644 index f42d2ed..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/PickStateProperties.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: PickStateProperties ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / PickStateProperties - -# Type Alias: PickStateProperties\ - -> **PickStateProperties**\<`Type`\>: [`PickByType`](PickByType.md)\<`Type`, [`State`](../../protocol/classes/State.md)\<`any`\>\> - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:36](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L36) - -## Type Parameters - -• **Type** diff --git a/src/pages/docs/reference/sequencer/type-aliases/Query.md b/src/pages/docs/reference/sequencer/type-aliases/Query.md deleted file mode 100644 index 5a2dbd8..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/Query.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Query ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Query - -# Type Alias: Query\ - -> **Query**\<`ModuleType`, `ModuleRecord`\>: `{ [Key in keyof ModuleRecord]: ModuleQuery> }` - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:58](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L58) - -## Type Parameters - -• **ModuleType** - -• **ModuleRecord** *extends* `Record`\<`string`, [`TypedClass`](TypedClass.md)\<`ModuleType`\>\> diff --git a/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md b/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md deleted file mode 100644 index bc2b5a4..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/RuntimeContextReducedExecutionResult.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: RuntimeContextReducedExecutionResult ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / RuntimeContextReducedExecutionResult - -# Type Alias: RuntimeContextReducedExecutionResult - -> **RuntimeContextReducedExecutionResult**: `Pick`\<[`RuntimeProvableMethodExecutionResult`](../../protocol/classes/RuntimeProvableMethodExecutionResult.md), `"stateTransitions"` \| `"status"` \| `"statusMessage"` \| `"stackTrace"` \| `"events"`\> - -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:37](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L37) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md b/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md deleted file mode 100644 index 1511997..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/SequencerModulesRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: SequencerModulesRecord ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SequencerModulesRecord - -# Type Alias: SequencerModulesRecord - -> **SequencerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](TypedClass.md)\<[`SequencerModule`](../classes/SequencerModule.md)\<`unknown`\>\>\> - -Defined in: [packages/sequencer/src/sequencer/executor/Sequencer.ts:25](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/sequencer/executor/Sequencer.ts#L25) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md b/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md deleted file mode 100644 index bd145a3..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/SerializedArtifactRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: SerializedArtifactRecord ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SerializedArtifactRecord - -# Type Alias: SerializedArtifactRecord - -> **SerializedArtifactRecord**: `Record`\<`string`, \{ `verificationKey`: \{ `data`: `string`; `hash`: `string`; \}; \}\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts:5](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/ArtifactionRecordSerializer.ts#L5) diff --git a/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md b/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md deleted file mode 100644 index bfad475..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/SettlementModuleEvents.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: SettlementModuleEvents ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SettlementModuleEvents - -# Type Alias: SettlementModuleEvents - -> **SettlementModuleEvents**: `object` - -Defined in: [packages/sequencer/src/settlement/SettlementModule.ts:57](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/SettlementModule.ts#L57) - -## Type declaration - -### settlement-submitted - -> **settlement-submitted**: \[[`Batch`](../interfaces/Batch.md)\] diff --git a/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md b/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md deleted file mode 100644 index e62b2c5..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/SomeRuntimeMethod.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: SomeRuntimeMethod ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / SomeRuntimeMethod - -# Type Alias: SomeRuntimeMethod() - -> **SomeRuntimeMethod**: (...`args`) => `Promise`\<`unknown`\> - -Defined in: [packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/sequencing/TransactionExecutionService.ts#L35) - -## Parameters - -### args - -...`unknown`[] - -## Returns - -`Promise`\<`unknown`\> diff --git a/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md b/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md deleted file mode 100644 index d6f1387..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/StateRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: StateRecord ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / StateRecord - -# Type Alias: StateRecord - -> **StateRecord**: `Record`\<`string`, `Field`[] \| `undefined`\> - -Defined in: [packages/sequencer/src/protocol/production/BatchProducerModule.ts:35](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/BatchProducerModule.ts#L35) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md b/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md deleted file mode 100644 index 07c9400..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/TaskStateRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: TaskStateRecord ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskStateRecord - -# Type Alias: TaskStateRecord - -> **TaskStateRecord**: `Record`\<`string`, `Field`[]\> - -Defined in: [packages/sequencer/src/protocol/production/TransactionTraceService.ts:32](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/TransactionTraceService.ts#L32) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md deleted file mode 100644 index fac3d94..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesRecord.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: TaskWorkerModulesRecord ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskWorkerModulesRecord - -# Type Alias: TaskWorkerModulesRecord - -> **TaskWorkerModulesRecord**: [`ModulesRecord`](../../common/interfaces/ModulesRecord.md)\<[`TypedClass`](TypedClass.md)\<[`TaskWorkerModule`](../classes/TaskWorkerModule.md) & [`Task`](../interfaces/Task.md)\<`any`, `any`\>\>\> - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:41](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L41) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md b/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md deleted file mode 100644 index 99ae1f6..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/TaskWorkerModulesWithoutSettlement.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: TaskWorkerModulesWithoutSettlement ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TaskWorkerModulesWithoutSettlement - -# Type Alias: TaskWorkerModulesWithoutSettlement - -> **TaskWorkerModulesWithoutSettlement**: [`ReturnType`](../../protocol/type-aliases/ReturnType.md)\<*typeof* [`withoutSettlement`](../classes/VanillaTaskWorkerModules.md#withoutsettlement)\> - -Defined in: [packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts:169](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/worker/LocalTaskWorkerModule.ts#L169) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md deleted file mode 100644 index 50580fc..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/TransactionProvingTaskParameters.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: TransactionProvingTaskParameters ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionProvingTaskParameters - -# Type Alias: TransactionProvingTaskParameters - -> **TransactionProvingTaskParameters**: [`PairingDerivedInput`](../interfaces/PairingDerivedInput.md)\<[`StateTransitionProof`](../../protocol/type-aliases/StateTransitionProof.md), `RuntimeProof`, [`BlockProverParameters`](../interfaces/BlockProverParameters.md)\> - -Defined in: [packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts:42](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/TransactionProvingTask.ts#L42) diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md deleted file mode 100644 index fc22d80..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskArgs.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: TransactionTaskArgs ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionTaskArgs - -# Type Alias: TransactionTaskArgs - -> **TransactionTaskArgs**: `object` - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:49](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L49) - -## Type declaration - -### chainState - -> **chainState**: [`ChainStateTaskArgs`](ChainStateTaskArgs.md) - -### transaction - -> **transaction**: `Transaction`\<`false`, `true`\> diff --git a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md b/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md deleted file mode 100644 index 86adce1..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/TransactionTaskResult.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: TransactionTaskResult ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TransactionTaskResult - -# Type Alias: TransactionTaskResult - -> **TransactionTaskResult**: `object` - -Defined in: [packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts:54](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/settlement/tasks/SettlementProvingTask.ts#L54) - -## Type declaration - -### transaction - -> **transaction**: `Mina.Transaction`\<`true`, `true`\> diff --git a/src/pages/docs/reference/sequencer/type-aliases/TypedClass.md b/src/pages/docs/reference/sequencer/type-aliases/TypedClass.md deleted file mode 100644 index d03b937..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/TypedClass.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: TypedClass ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / TypedClass - -# Type Alias: TypedClass()\ - -> **TypedClass**\<`Class`\>: (...`args`) => `Class` - -Defined in: packages/common/dist/types.d.ts:2 - -## Type Parameters - -• **Class** - -## Parameters - -### args - -...`any`[] - -## Returns - -`Class` diff --git a/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md b/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md deleted file mode 100644 index 3bd4dae..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/UnsignedTransactionBody.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: UnsignedTransactionBody ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / UnsignedTransactionBody - -# Type Alias: UnsignedTransactionBody - -> **UnsignedTransactionBody**: `object` - -Defined in: [packages/sequencer/src/mempool/PendingTransaction.ts:17](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/mempool/PendingTransaction.ts#L17) - -## Type declaration - -### argsFields - -> **argsFields**: `Field`[] - -### auxiliaryData - -> **auxiliaryData**: `string`[] - -Used to transport non-provable data, mainly proof data for now -These values will not be part of the signature message or transaction hash - -### isMessage - -> **isMessage**: `boolean` - -### methodId - -> **methodId**: `Field` - -### nonce - -> **nonce**: `UInt64` - -### sender - -> **sender**: `PublicKey` diff --git a/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md b/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md deleted file mode 100644 index ab15181..0000000 --- a/src/pages/docs/reference/sequencer/type-aliases/VerificationKeyJSON.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: VerificationKeyJSON ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / VerificationKeyJSON - -# Type Alias: VerificationKeyJSON - -> **VerificationKeyJSON**: `object` - -Defined in: [packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/protocol/production/tasks/serializers/VerificationKeySerializer.ts#L3) - -## Type declaration - -### data - -> **data**: `string` - -### hash - -> **hash**: `string` diff --git a/src/pages/docs/reference/sequencer/variables/Block.md b/src/pages/docs/reference/sequencer/variables/Block.md deleted file mode 100644 index 485e4b8..0000000 --- a/src/pages/docs/reference/sequencer/variables/Block.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Block ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / Block - -# Variable: Block - -> **Block**: `object` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:22](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L22) - -## Type declaration - -### calculateHash() - -#### Parameters - -##### height - -`Field` - -##### transactionsHash - -`Field` - -#### Returns - -`Field` - -### hash() - -#### Parameters - -##### block - -`Omit`\<[`Block`](../interfaces/Block.md), `"hash"`\> - -#### Returns - -`Field` diff --git a/src/pages/docs/reference/sequencer/variables/BlockWithResult.md b/src/pages/docs/reference/sequencer/variables/BlockWithResult.md deleted file mode 100644 index 398ce6d..0000000 --- a/src/pages/docs/reference/sequencer/variables/BlockWithResult.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: BlockWithResult ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / BlockWithResult - -# Variable: BlockWithResult - -> **BlockWithResult**: `object` - -Defined in: [packages/sequencer/src/storage/model/Block.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/storage/model/Block.ts#L59) - -## Type declaration - -### createEmpty() - -> **createEmpty**: () => `object` - -#### Returns - -`object` - -##### block - -> **block**: `object` - -###### block.fromBlockHashRoot - -> **block.fromBlockHashRoot**: `Field` - -###### block.fromEternalTransactionsHash - -> **block.fromEternalTransactionsHash**: `Field` - -###### block.fromMessagesHash - -> **block.fromMessagesHash**: `Field` - -###### block.hash - -> **block.hash**: `Field` - -###### block.height - -> **block.height**: `Field` - -###### block.networkState - -> **block.networkState**: `object` - -###### block.networkState.before - -> **block.networkState.before**: [`NetworkState`](../../protocol/classes/NetworkState.md) - -###### block.networkState.during - -> **block.networkState.during**: [`NetworkState`](../../protocol/classes/NetworkState.md) - -###### block.previousBlockHash - -> **block.previousBlockHash**: `undefined` = `undefined` - -###### block.toEternalTransactionsHash - -> **block.toEternalTransactionsHash**: `Field` - -###### block.toMessagesHash - -> **block.toMessagesHash**: `Field` = `ACTIONS_EMPTY_HASH` - -###### block.transactions - -> **block.transactions**: `never`[] = `[]` - -###### block.transactionsHash - -> **block.transactionsHash**: `Field` - -##### result - -> **result**: `object` - -###### result.afterNetworkState - -> **result.afterNetworkState**: [`NetworkState`](../../protocol/classes/NetworkState.md) - -###### result.blockHash - -> **result.blockHash**: `bigint` = `0n` - -###### result.blockHashRoot - -> **result.blockHashRoot**: `bigint` = `BlockHashMerkleTree.EMPTY_ROOT` - -###### result.blockHashWitness - -> **result.blockHashWitness**: [`AbstractMerkleWitness`](../../common/interfaces/AbstractMerkleWitness.md) - -###### result.blockStateTransitions - -> **result.blockStateTransitions**: `never`[] = `[]` - -###### result.stateRoot - -> **result.stateRoot**: `bigint` = `RollupMerkleTree.EMPTY_ROOT` diff --git a/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md b/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md deleted file mode 100644 index 062147b..0000000 --- a/src/pages/docs/reference/sequencer/variables/JSONTaskSerializer.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: JSONTaskSerializer ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / JSONTaskSerializer - -# Variable: JSONTaskSerializer - -> `const` **JSONTaskSerializer**: `object` - -Defined in: [packages/sequencer/src/worker/flow/JSONTaskSerializer.ts:3](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/worker/flow/JSONTaskSerializer.ts#L3) - -## Type declaration - -### fromType() - -#### Type Parameters - -• **Type** - -#### Returns - -[`TaskSerializer`](../interfaces/TaskSerializer.md)\<`Type`\> diff --git a/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md b/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md deleted file mode 100644 index de92d95..0000000 --- a/src/pages/docs/reference/sequencer/variables/QueryBuilderFactory.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: QueryBuilderFactory ---- - -[**@proto-kit/sequencer**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/sequencer](../README.md) / QueryBuilderFactory - -# Variable: QueryBuilderFactory - -> `const` **QueryBuilderFactory**: `object` - -Defined in: [packages/sequencer/src/helpers/query/QueryBuilderFactory.ts:71](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/sequencer/src/helpers/query/QueryBuilderFactory.ts#L71) - -## Type declaration - -### fillQuery() - -#### Type Parameters - -• **Module** *extends* `Object` - -#### Parameters - -##### runtimeModule - -`Module` - -##### queryTransportModule - -[`QueryTransportModule`](../interfaces/QueryTransportModule.md) - -#### Returns - -[`ModuleQuery`](../type-aliases/ModuleQuery.md)\<`Module`\> - -### fromProtocol() - -#### Type Parameters - -• **ProtocolModules** *extends* [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & [`ProtocolModulesRecord`](../../protocol/type-aliases/ProtocolModulesRecord.md) - -#### Parameters - -##### protocol - -[`Protocol`](../../protocol/classes/Protocol.md)\<`ProtocolModules`\> - -##### queryTransportModule - -[`QueryTransportModule`](../interfaces/QueryTransportModule.md) - -#### Returns - -[`Query`](../type-aliases/Query.md)\<[`ProtocolModule`](../../protocol/classes/ProtocolModule.md)\<`unknown`\>, `ProtocolModules`\> - -### fromRuntime() - -#### Type Parameters - -• **RuntimeModules** *extends* [`RuntimeModulesRecord`](../../module/type-aliases/RuntimeModulesRecord.md) - -#### Parameters - -##### runtime - -[`Runtime`](../../module/classes/Runtime.md)\<`RuntimeModules`\> - -##### queryTransportModule - -[`QueryTransportModule`](../interfaces/QueryTransportModule.md) - -#### Returns - -[`Query`](../type-aliases/Query.md)\<[`RuntimeModule`](../../module/classes/RuntimeModule.md)\<`unknown`\>, `RuntimeModules`\> diff --git a/src/pages/docs/reference/stack/README.md b/src/pages/docs/reference/stack/README.md deleted file mode 100644 index 1fee6ba..0000000 --- a/src/pages/docs/reference/stack/README.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "@proto-kit/stack" ---- - -**@proto-kit/stack** - -*** - -[Documentation](../../README.md) / @proto-kit/stack - -`docker-compose up --build` - -Select services to use in .env using profiles - -See deployment `README.md` for more information diff --git a/src/pages/docs/reference/stack/_meta.tsx b/src/pages/docs/reference/stack/_meta.tsx deleted file mode 100644 index 997bed8..0000000 --- a/src/pages/docs/reference/stack/_meta.tsx +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "README": "Overview","classes": "Classes","functions": "Functions","globals": "Globals" -}; \ No newline at end of file diff --git a/src/pages/docs/reference/stack/classes/TestBalances.md b/src/pages/docs/reference/stack/classes/TestBalances.md deleted file mode 100644 index 8cbca3b..0000000 --- a/src/pages/docs/reference/stack/classes/TestBalances.md +++ /dev/null @@ -1,491 +0,0 @@ ---- -title: TestBalances ---- - -[**@proto-kit/stack**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/stack](../README.md) / TestBalances - -# Class: TestBalances - -Defined in: [stack/src/scripts/graphql/server.ts:52](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/stack/src/scripts/graphql/server.ts#L52) - -Base class for runtime modules providing the necessary utilities. - -## Extends - -- [`Balances`](../../library/classes/Balances.md) - -## Constructors - -### new TestBalances() - -> **new TestBalances**(): [`TestBalances`](TestBalances.md) - -Defined in: module/dist/runtime/RuntimeModule.d.ts:31 - -#### Returns - -[`TestBalances`](TestBalances.md) - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`constructor`](../../library/classes/Balances.md#constructors) - -## Properties - -### balances - -> **balances**: [`StateMap`](../../protocol/classes/StateMap.md)\<[`BalancesKey`](../../library/classes/BalancesKey.md), [`Balance`](../../library/classes/Balance.md)\> - -Defined in: library/dist/runtime/Balances.d.ts:84 - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`balances`](../../library/classes/Balances.md#balances) - -*** - -### currentConfig - -> `protected` **currentConfig**: `undefined` \| [`NoConfig`](../../common/type-aliases/NoConfig.md) - -Defined in: common/dist/config/ConfigurableModule.d.ts:17 - -Store the config separately, so that we can apply additional -checks when retrieving it via the getter - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`currentConfig`](../../library/classes/Balances.md#currentconfig) - -*** - -### events? - -> `optional` **events**: [`RuntimeEvents`](../../module/classes/RuntimeEvents.md)\<`any`\> - -Defined in: module/dist/runtime/RuntimeModule.d.ts:30 - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`events`](../../library/classes/Balances.md#events) - -*** - -### isRuntimeModule - -> **isRuntimeModule**: `boolean` - -Defined in: module/dist/runtime/RuntimeModule.d.ts:27 - -This property exists only to typecheck that the RuntimeModule -was extended correctly in e.g. a decorator. We need at least -one non-optional property in this class to make the typechecking work. - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`isRuntimeModule`](../../library/classes/Balances.md#isruntimemodule) - -*** - -### name? - -> `optional` **name**: `string` - -Defined in: module/dist/runtime/RuntimeModule.d.ts:28 - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`name`](../../library/classes/Balances.md#name) - -*** - -### runtime? - -> `optional` **runtime**: [`RuntimeEnvironment`](../../module/interfaces/RuntimeEnvironment.md) - -Defined in: module/dist/runtime/RuntimeModule.d.ts:29 - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`runtime`](../../library/classes/Balances.md#runtime) - -*** - -### runtimeMethodNames - -> `readonly` **runtimeMethodNames**: `string`[] - -Defined in: module/dist/runtime/RuntimeModule.d.ts:21 - -Holds all method names that are callable throw transactions - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`runtimeMethodNames`](../../library/classes/Balances.md#runtimemethodnames) - -*** - -### totalSupply - -> **totalSupply**: [`State`](../../protocol/classes/State.md)\<[`UInt64`](../../library/classes/UInt64.md)\> - -Defined in: [stack/src/scripts/graphql/server.ts:59](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/stack/src/scripts/graphql/server.ts#L59) - -We use `satisfies` here in order to be able to access -presets by key in a type safe way. - -*** - -### presets - -> `static` **presets**: [`Presets`](../../common/type-aliases/Presets.md)\<`unknown`\> - -Defined in: module/dist/runtime/RuntimeModule.d.ts:17 - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`presets`](../../library/classes/Balances.md#presets) - -## Accessors - -### config - -#### Get Signature - -> **get** **config**(): `Config` - -Defined in: common/dist/config/ConfigurableModule.d.ts:18 - -##### Returns - -`Config` - -#### Set Signature - -> **set** **config**(`config`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:19 - -##### Parameters - -###### config - -`Config` - -##### Returns - -`void` - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`config`](../../library/classes/Balances.md#config) - -*** - -### network - -#### Get Signature - -> **get** **network**(): [`NetworkState`](../../protocol/classes/NetworkState.md) - -Defined in: module/dist/runtime/RuntimeModule.d.ts:34 - -##### Returns - -[`NetworkState`](../../protocol/classes/NetworkState.md) - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`network`](../../library/classes/Balances.md#network) - -*** - -### transaction - -#### Get Signature - -> **get** **transaction**(): [`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -Defined in: module/dist/runtime/RuntimeModule.d.ts:33 - -##### Returns - -[`RuntimeTransaction`](../../protocol/classes/RuntimeTransaction.md) - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`transaction`](../../library/classes/Balances.md#transaction) - -## Methods - -### addBalance() - -> **addBalance**(`tokenId`, `address`, `balance`): `Promise`\<`void`\> - -Defined in: [stack/src/scripts/graphql/server.ts:70](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/stack/src/scripts/graphql/server.ts#L70) - -#### Parameters - -##### tokenId - -[`TokenId`](../../library/classes/TokenId.md) - -##### address - -`PublicKey` - -##### balance - -[`UInt64`](../../library/classes/UInt64.md) - -#### Returns - -`Promise`\<`void`\> - -*** - -### burn() - -> **burn**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> - -Defined in: library/dist/runtime/Balances.d.ts:89 - -#### Parameters - -##### tokenId - -[`TokenId`](../../library/classes/TokenId.md) - -##### address - -`PublicKey` - -##### amount - -[`Balance`](../../library/classes/Balance.md) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`burn`](../../library/classes/Balances.md#burn) - -*** - -### create() - -> **create**(`childContainerProvider`): `void` - -Defined in: common/dist/config/ConfigurableModule.d.ts:20 - -#### Parameters - -##### childContainerProvider - -[`ChildContainerProvider`](../../common/interfaces/ChildContainerProvider.md) - -#### Returns - -`void` - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`create`](../../library/classes/Balances.md#create) - -*** - -### getBalance() - -> **getBalance**(`tokenId`, `address`): `Promise`\<[`Balance`](../../library/classes/Balance.md)\> - -Defined in: library/dist/runtime/Balances.d.ts:85 - -#### Parameters - -##### tokenId - -[`TokenId`](../../library/classes/TokenId.md) - -##### address - -`PublicKey` - -#### Returns - -`Promise`\<[`Balance`](../../library/classes/Balance.md)\> - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`getBalance`](../../library/classes/Balances.md#getbalance) - -*** - -### getBalanceForUser() - -> **getBalanceForUser**(`tokenId`, `address`): `Promise`\<[`Balance`](../../library/classes/Balance.md)\> - -Defined in: [stack/src/scripts/graphql/server.ts:62](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/stack/src/scripts/graphql/server.ts#L62) - -#### Parameters - -##### tokenId - -[`TokenId`](../../library/classes/TokenId.md) - -##### address - -`PublicKey` - -#### Returns - -`Promise`\<[`Balance`](../../library/classes/Balance.md)\> - -*** - -### getInputs() - -> **getInputs**(): [`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) - -Defined in: module/dist/runtime/RuntimeModule.d.ts:32 - -#### Returns - -[`RuntimeMethodExecutionData`](../../protocol/interfaces/RuntimeMethodExecutionData.md) - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`getInputs`](../../library/classes/Balances.md#getinputs) - -*** - -### mint() - -> **mint**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> - -Defined in: library/dist/runtime/Balances.d.ts:88 - -#### Parameters - -##### tokenId - -[`TokenId`](../../library/classes/TokenId.md) - -##### address - -`PublicKey` - -##### amount - -[`Balance`](../../library/classes/Balance.md) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`mint`](../../library/classes/Balances.md#mint) - -*** - -### setBalance() - -> **setBalance**(`tokenId`, `address`, `amount`): `Promise`\<`void`\> - -Defined in: library/dist/runtime/Balances.d.ts:86 - -#### Parameters - -##### tokenId - -[`TokenId`](../../library/classes/TokenId.md) - -##### address - -`PublicKey` - -##### amount - -[`Balance`](../../library/classes/Balance.md) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`setBalance`](../../library/classes/Balances.md#setbalance) - -*** - -### transfer() - -> **transfer**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> - -Defined in: library/dist/runtime/Balances.d.ts:87 - -#### Parameters - -##### tokenId - -[`TokenId`](../../library/classes/TokenId.md) - -##### from - -`PublicKey` - -##### to - -`PublicKey` - -##### amount - -[`Balance`](../../library/classes/Balance.md) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`transfer`](../../library/classes/Balances.md#transfer) - -*** - -### transferSigned() - -> **transferSigned**(`tokenId`, `from`, `to`, `amount`): `Promise`\<`void`\> - -Defined in: library/dist/runtime/Balances.d.ts:90 - -#### Parameters - -##### tokenId - -[`TokenId`](../../library/classes/TokenId.md) - -##### from - -`PublicKey` - -##### to - -`PublicKey` - -##### amount - -[`Balance`](../../library/classes/Balance.md) - -#### Returns - -`Promise`\<`void`\> - -#### Inherited from - -[`Balances`](../../library/classes/Balances.md).[`transferSigned`](../../library/classes/Balances.md#transfersigned) diff --git a/src/pages/docs/reference/stack/functions/startServer.md b/src/pages/docs/reference/stack/functions/startServer.md deleted file mode 100644 index e7e56d8..0000000 --- a/src/pages/docs/reference/stack/functions/startServer.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: startServer ---- - -[**@proto-kit/stack**](../README.md) - -*** - -[Documentation](../../../README.md) / [@proto-kit/stack](../README.md) / startServer - -# Function: startServer() - -> **startServer**(): `Promise`\<[`AppChain`](../../sdk/classes/AppChain.md)\<`object` & `object`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `Graphql`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md)\<\{ `BatchStorageResolver`: *typeof* [`BatchStorageResolver`](../../api/classes/BatchStorageResolver.md); `BlockResolver`: *typeof* [`BlockResolver`](../../api/classes/BlockResolver.md); `MempoolResolver`: *typeof* [`MempoolResolver`](../../api/classes/MempoolResolver.md); `MerkleWitnessResolver`: *typeof* [`MerkleWitnessResolver`](../../api/classes/MerkleWitnessResolver.md); `NodeStatusResolver`: *typeof* [`NodeStatusResolver`](../../api/classes/NodeStatusResolver.md); `QueryGraphqlModule`: *typeof* [`QueryGraphqlModule`](../../api/classes/QueryGraphqlModule.md); \}\>\>; `GraphqlServer`: *typeof* [`GraphqlServer`](../../api/classes/GraphqlServer.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `SequencerStartupModule`: *typeof* [`SequencerStartupModule`](../../sequencer/classes/SequencerStartupModule.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](../../sdk/classes/BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](../../sdk/classes/StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](../../sdk/classes/InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](../../sdk/classes/InMemoryTransactionSender.md); \}\>\> - -Defined in: [stack/src/scripts/graphql/server.ts:88](https://github.com/proto-kit/framework/blob/4d6b3b6da51b3edee0fbf25ce72c1f59ec61e891/packages/stack/src/scripts/graphql/server.ts#L88) - -## Returns - -`Promise`\<[`AppChain`](../../sdk/classes/AppChain.md)\<`object` & `object`, [`MandatoryProtocolModulesRecord`](../../protocol/type-aliases/MandatoryProtocolModulesRecord.md) & `object`, \{ `BaseLayer`: *typeof* [`NoopBaseLayer`](../../sequencer/classes/NoopBaseLayer.md); `BatchProducerModule`: *typeof* [`BatchProducerModule`](../../sequencer/classes/BatchProducerModule.md); `BlockProducerModule`: *typeof* [`BlockProducerModule`](../../sequencer/classes/BlockProducerModule.md); `BlockTrigger`: *typeof* [`ManualBlockTrigger`](../../sequencer/classes/ManualBlockTrigger.md); `Database`: *typeof* [`InMemoryDatabase`](../../sequencer/classes/InMemoryDatabase.md); `Graphql`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`GraphqlSequencerModule`](../../api/classes/GraphqlSequencerModule.md)\<\{ `BatchStorageResolver`: *typeof* [`BatchStorageResolver`](../../api/classes/BatchStorageResolver.md); `BlockResolver`: *typeof* [`BlockResolver`](../../api/classes/BlockResolver.md); `MempoolResolver`: *typeof* [`MempoolResolver`](../../api/classes/MempoolResolver.md); `MerkleWitnessResolver`: *typeof* [`MerkleWitnessResolver`](../../api/classes/MerkleWitnessResolver.md); `NodeStatusResolver`: *typeof* [`NodeStatusResolver`](../../api/classes/NodeStatusResolver.md); `QueryGraphqlModule`: *typeof* [`QueryGraphqlModule`](../../api/classes/QueryGraphqlModule.md); \}\>\>; `GraphqlServer`: *typeof* [`GraphqlServer`](../../api/classes/GraphqlServer.md); `LocalTaskWorkerModule`: [`TypedClass`](../../common/type-aliases/TypedClass.md)\<[`LocalTaskWorkerModule`](../../sequencer/classes/LocalTaskWorkerModule.md)\<\{ `BlockBuildingTask`: *typeof* [`NewBlockTask`](../../sequencer/classes/NewBlockTask.md); `BlockReductionTask`: *typeof* `BlockReductionTask`; `CircuitCompilerTask`: *typeof* `CircuitCompilerTask`; `RuntimeProvingTask`: *typeof* [`RuntimeProvingTask`](../../sequencer/classes/RuntimeProvingTask.md); `StateTransitionReductionTask`: *typeof* [`StateTransitionReductionTask`](../../sequencer/classes/StateTransitionReductionTask.md); `StateTransitionTask`: *typeof* [`StateTransitionTask`](../../sequencer/classes/StateTransitionTask.md); `TransactionProvingTask`: *typeof* [`TransactionProvingTask`](../../sequencer/classes/TransactionProvingTask.md); `WorkerRegistrationTask`: *typeof* `WorkerRegistrationTask`; \}\>\>; `Mempool`: *typeof* [`PrivateMempool`](../../sequencer/classes/PrivateMempool.md); `SequencerStartupModule`: *typeof* [`SequencerStartupModule`](../../sequencer/classes/SequencerStartupModule.md); `TaskQueue`: *typeof* [`LocalTaskQueue`](../../sequencer/classes/LocalTaskQueue.md); \}, \{ `NetworkStateTransportModule`: *typeof* [`BlockStorageNetworkStateModule`](../../sdk/classes/BlockStorageNetworkStateModule.md); `QueryTransportModule`: *typeof* [`StateServiceQueryModule`](../../sdk/classes/StateServiceQueryModule.md); `Signer`: *typeof* [`InMemorySigner`](../../sdk/classes/InMemorySigner.md); `TransactionSender`: *typeof* [`InMemoryTransactionSender`](../../sdk/classes/InMemoryTransactionSender.md); \}\>\> diff --git a/src/pages/docs/reference/stack/globals.md b/src/pages/docs/reference/stack/globals.md deleted file mode 100644 index d85433c..0000000 --- a/src/pages/docs/reference/stack/globals.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "@proto-kit/stack" ---- - -[**@proto-kit/stack**](README.md) - -*** - -[Documentation](../../README.md) / @proto-kit/stack - -# @proto-kit/stack - -## Classes - -- [TestBalances](classes/TestBalances.md) - -## Functions - -- [startServer](functions/startServer.md) From 673081afeab47654dc6196591342decd945d6a25 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 11:24:12 +0100 Subject: [PATCH 20/37] use https instead of ssh to pull the framework repo --- generate-typedoc.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/generate-typedoc.sh b/generate-typedoc.sh index 655f620..2855737 100755 --- a/generate-typedoc.sh +++ b/generate-typedoc.sh @@ -1,6 +1,6 @@ # needs to be cloned to a one-up directory, otherwise README.md auto-discovery # in framework's typedoc includes website's README.md, which is not desired -git clone git@github.com:proto-kit/framework.git ./../framework-typedoc +git clone https://github.com/proto-kit/framework.git ./../framework-typedoc cd ./../framework-typedoc # git checkout develop git checkout develop From eec71e6b3590f3d34c19cf7718b90a0a4b743357 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 11:32:04 +0100 Subject: [PATCH 21/37] create a directory for references if it does not exist --- generate-typedoc.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/generate-typedoc.sh b/generate-typedoc.sh index 2855737..bfae405 100755 --- a/generate-typedoc.sh +++ b/generate-typedoc.sh @@ -10,6 +10,7 @@ npm run build npm run typedoc cd ./../website rm -rf *./src/pages/docs/reference +mkdir -p ./src/pages/docs/reference cp -r ./../framework-typedoc/docs/@proto-kit/ ./src/pages/docs/reference node generate-reference-meta.mjs rm -rf ./../framework-typedoc From c2910ab7d10e78796a608047519c8d80f8153a7b Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 11:53:34 +0100 Subject: [PATCH 22/37] make the framework typedoc folder context dependant --- generate-typedoc.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/generate-typedoc.sh b/generate-typedoc.sh index bfae405..2b544c0 100755 --- a/generate-typedoc.sh +++ b/generate-typedoc.sh @@ -1,5 +1,6 @@ # needs to be cloned to a one-up directory, otherwise README.md auto-discovery # in framework's typedoc includes website's README.md, which is not desired +REPO=$(pwd) git clone https://github.com/proto-kit/framework.git ./../framework-typedoc cd ./../framework-typedoc # git checkout develop @@ -8,7 +9,7 @@ npm ci --force npm run prisma:generate npm run build npm run typedoc -cd ./../website +cd $REPO rm -rf *./src/pages/docs/reference mkdir -p ./src/pages/docs/reference cp -r ./../framework-typedoc/docs/@proto-kit/ ./src/pages/docs/reference From d06bf4cce856f420f206aab3ab6ff3dc77c1342b Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 13:40:32 +0100 Subject: [PATCH 23/37] add logging to reference meta generation for debug purposes --- generate-reference-meta.mjs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/generate-reference-meta.mjs b/generate-reference-meta.mjs index 6aff7c8..bf27c9f 100644 --- a/generate-reference-meta.mjs +++ b/generate-reference-meta.mjs @@ -39,6 +39,8 @@ references.forEach((reference) => { })} };`; + console.log(metaTsxPath, metaTsx); + fs.writeFileSync(metaTsxPath, metaTsx); }); @@ -48,4 +50,6 @@ const metaTsx = `export default { return `"${reference}": "${referenceToSidebarTitle(reference)}"`; })} };`; + +console.log(metaTsxPath, metaTsx); fs.writeFileSync(metaTsxPath, metaTsx); From 40654a9b80f8f438c0ce22909522a2511bf6bcfa Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 14:05:36 +0100 Subject: [PATCH 24/37] added a log message to typedoc meta generator script --- generate-reference-meta.mjs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/generate-reference-meta.mjs b/generate-reference-meta.mjs index bf27c9f..16a4baf 100644 --- a/generate-reference-meta.mjs +++ b/generate-reference-meta.mjs @@ -23,6 +23,8 @@ function referenceToSidebarTitle(reference) { return `@proto-kit/${reference}`; } +console.log("generating typedoc meta files..."); + references.forEach((reference) => { const metaTsxPath = `./src/pages/docs/reference/${reference}/_meta.tsx`; fs.rmSync(metaTsxPath, { force: true }); From 2706638951b0f05e2e499b837a214e2694e34e7f Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 15:27:22 +0100 Subject: [PATCH 25/37] change copy paths for typedoc generation --- generate-typedoc.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/generate-typedoc.sh b/generate-typedoc.sh index 2b544c0..e699ad8 100755 --- a/generate-typedoc.sh +++ b/generate-typedoc.sh @@ -12,7 +12,7 @@ npm run typedoc cd $REPO rm -rf *./src/pages/docs/reference mkdir -p ./src/pages/docs/reference -cp -r ./../framework-typedoc/docs/@proto-kit/ ./src/pages/docs/reference +cp -r ./../framework-typedoc/docs/@proto-kit ./src/pages/docs/reference node generate-reference-meta.mjs rm -rf ./../framework-typedoc echo "Typedoc generated successfully" \ No newline at end of file From c29fbc3f4e9c48dcaa15db13c112fb45c104f61b Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Tue, 4 Feb 2025 16:12:17 +0100 Subject: [PATCH 26/37] update command for copying reference docs --- generate-typedoc.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/generate-typedoc.sh b/generate-typedoc.sh index e699ad8..c44ed13 100755 --- a/generate-typedoc.sh +++ b/generate-typedoc.sh @@ -12,7 +12,7 @@ npm run typedoc cd $REPO rm -rf *./src/pages/docs/reference mkdir -p ./src/pages/docs/reference -cp -r ./../framework-typedoc/docs/@proto-kit ./src/pages/docs/reference +cp -r ./../framework-typedoc/docs/@proto-kit/ ./src/pages/docs/reference/ node generate-reference-meta.mjs rm -rf ./../framework-typedoc echo "Typedoc generated successfully" \ No newline at end of file From 074b8aaeade92f8da88f26981be37c32d9dda144 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 13:55:25 +0100 Subject: [PATCH 27/37] parametrize the typedoc generation script --- generate-reference-meta.mjs | 3 --- generate-typedoc.sh | 20 ++++++++++++-------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/generate-reference-meta.mjs b/generate-reference-meta.mjs index 16a4baf..51d8007 100644 --- a/generate-reference-meta.mjs +++ b/generate-reference-meta.mjs @@ -41,8 +41,6 @@ references.forEach((reference) => { })} };`; - console.log(metaTsxPath, metaTsx); - fs.writeFileSync(metaTsxPath, metaTsx); }); @@ -53,5 +51,4 @@ const metaTsx = `export default { })} };`; -console.log(metaTsxPath, metaTsx); fs.writeFileSync(metaTsxPath, metaTsx); diff --git a/generate-typedoc.sh b/generate-typedoc.sh index c44ed13..5624f78 100755 --- a/generate-typedoc.sh +++ b/generate-typedoc.sh @@ -1,18 +1,22 @@ # needs to be cloned to a one-up directory, otherwise README.md auto-discovery # in framework's typedoc includes website's README.md, which is not desired REPO=$(pwd) -git clone https://github.com/proto-kit/framework.git ./../framework-typedoc -cd ./../framework-typedoc -# git checkout develop -git checkout develop +: "${FRAMEWORK_TYPEDOC_FOLDER:=./../framework-typedoc}" +: "${FRAMEWORK_BRANCH:=develop}" +: "${WEBSITE_REFERENCE_DOCS:=./src/pages/docs/reference/}" +echo "Generating typedoc for framework branch \"$FRAMEWORK_BRANCH\" in \"$FRAMEWORK_TYPEDOC_FOLDER\""; +rm -rf $FRAMEWORK_TYPEDOC_FOLDER +git clone https://github.com/proto-kit/framework.git $FRAMEWORK_TYPEDOC_FOLDER +cd "$FRAMEWORK_TYPEDOC_FOLDER" +git checkout $FRAMEWORK_BRANCH npm ci --force npm run prisma:generate npm run build npm run typedoc cd $REPO -rm -rf *./src/pages/docs/reference -mkdir -p ./src/pages/docs/reference -cp -r ./../framework-typedoc/docs/@proto-kit/ ./src/pages/docs/reference/ +rm -rf $WEBSITE_REFERENCE_DOCS +mkdir -p $WEBSITE_REFERENCE_DOCS +cp -r "$FRAMEWORK_TYPEDOC_FOLDER/docs/@proto-kit/." $WEBSITE_REFERENCE_DOCS node generate-reference-meta.mjs -rm -rf ./../framework-typedoc +rm -rf $FRAMEWORK_TYPEDOC_FOLDER echo "Typedoc generated successfully" \ No newline at end of file From 206472bc495d5ddc8e0b2c999d99e1e6afc8d69a Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 14:28:42 +0100 Subject: [PATCH 28/37] added a netlify build & deploy workflow --- .github/workflows/deploy.yml | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/workflows/deploy.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..7433b54 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,34 @@ +name: Build and Deploy to Netlify +on: + push: + pull_request: + repository_dispatch: + types: [trigger-workflow] + +jobs: + build: + runs-on: ubuntu-22.04 + environment: netlify + steps: + - uses: actions/checkout@v4 + + - name: build + - uses: actions/setup-node@v3 + with: + node-version: 20.8.0 + cache: npm + run: | + pnpm i + pnpm run build + + - name: Deploy to Netlify + uses: nwtgck/actions-netlify@v3.0 + with: + publish-dir: '.next' + production-branch: main + github-token: ${{ secrets.GITHUB_TOKEN }} + deploy-message: "Deploy from GitHub Actions" + env: + NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} + timeout-minutes: 1 \ No newline at end of file From d8520dd647a888c7977fce4ee207c103e538aec0 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 14:29:04 +0100 Subject: [PATCH 29/37] renamed workflow --- .github/workflows/{deploy.yml => build-and-deploy.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{deploy.yml => build-and-deploy.yml} (100%) diff --git a/.github/workflows/deploy.yml b/.github/workflows/build-and-deploy.yml similarity index 100% rename from .github/workflows/deploy.yml rename to .github/workflows/build-and-deploy.yml From 1018423ff0c9695dcddc16241b306e7398f96f76 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 14:31:07 +0100 Subject: [PATCH 30/37] fix syntax issues with workflow --- .github/workflows/build-and-deploy.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index 7433b54..4a6bb3e 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -11,12 +11,11 @@ jobs: environment: netlify steps: - uses: actions/checkout@v4 - - - name: build - - uses: actions/setup-node@v3 + - uses: actions/setup-node@v3 with: node-version: 20.8.0 cache: npm + - name: Build run: | pnpm i pnpm run build From 5476102dfc5b2ed40dc95e2397b66de5637cde54 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 14:32:03 +0100 Subject: [PATCH 31/37] remove cache from workflow --- .github/workflows/build-and-deploy.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index 4a6bb3e..c90b19f 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -14,7 +14,6 @@ jobs: - uses: actions/setup-node@v3 with: node-version: 20.8.0 - cache: npm - name: Build run: | pnpm i From a42fe7989b1ac9fdceaf0217360d94d6760e4cd9 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 14:35:02 +0100 Subject: [PATCH 32/37] switch workflow to pnpm --- .github/workflows/build-and-deploy.yml | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index c90b19f..b1250a6 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -11,12 +11,21 @@ jobs: environment: netlify steps: - uses: actions/checkout@v4 - - uses: actions/setup-node@v3 + - uses: pnpm/action-setup@v4 with: - node-version: 20.8.0 - - name: Build + version: 10 + + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: 'pnpm' + + - name: Install dependencies run: | pnpm i + + - name: Build + run: | pnpm run build - name: Deploy to Netlify From d5e0c09f44c172f263da0c39a41237be783bb494 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 14:35:36 +0100 Subject: [PATCH 33/37] fix syntax issues in workflow --- .github/workflows/build-and-deploy.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index b1250a6..a1a660f 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -16,9 +16,9 @@ jobs: version: 10 - uses: actions/setup-node@v4 - with: - node-version: 20 - cache: 'pnpm' + with: + node-version: 20 + cache: 'pnpm' - name: Install dependencies run: | From 25470c91c15bea2f636517a38c12a7f56cd6a52a Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 14:58:57 +0100 Subject: [PATCH 34/37] update publish dir for website --- .github/workflows/build-and-deploy.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index a1a660f..6e67514 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -6,7 +6,7 @@ on: types: [trigger-workflow] jobs: - build: + build_and_deploy: runs-on: ubuntu-22.04 environment: netlify steps: @@ -31,7 +31,7 @@ jobs: - name: Deploy to Netlify uses: nwtgck/actions-netlify@v3.0 with: - publish-dir: '.next' + publish-dir: '/.next' production-branch: main github-token: ${{ secrets.GITHUB_TOKEN }} deploy-message: "Deploy from GitHub Actions" From cd24b73f66e6e075dc3e84fa295649370d75093b Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 14:59:58 +0100 Subject: [PATCH 35/37] update publish dir for website --- .github/workflows/build-and-deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index 6e67514..f0726c8 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -31,7 +31,7 @@ jobs: - name: Deploy to Netlify uses: nwtgck/actions-netlify@v3.0 with: - publish-dir: '/.next' + publish-dir: './.next' production-branch: main github-token: ${{ secrets.GITHUB_TOKEN }} deploy-message: "Deploy from GitHub Actions" From f6732717bedea6262915212fa16ee0f7e618cb96 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 15:11:42 +0100 Subject: [PATCH 36/37] remove workflow for deployment --- .github/workflows/build-and-deploy.yml | 41 -------------------------- 1 file changed, 41 deletions(-) delete mode 100644 .github/workflows/build-and-deploy.yml diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml deleted file mode 100644 index f0726c8..0000000 --- a/.github/workflows/build-and-deploy.yml +++ /dev/null @@ -1,41 +0,0 @@ -name: Build and Deploy to Netlify -on: - push: - pull_request: - repository_dispatch: - types: [trigger-workflow] - -jobs: - build_and_deploy: - runs-on: ubuntu-22.04 - environment: netlify - steps: - - uses: actions/checkout@v4 - - uses: pnpm/action-setup@v4 - with: - version: 10 - - - uses: actions/setup-node@v4 - with: - node-version: 20 - cache: 'pnpm' - - - name: Install dependencies - run: | - pnpm i - - - name: Build - run: | - pnpm run build - - - name: Deploy to Netlify - uses: nwtgck/actions-netlify@v3.0 - with: - publish-dir: './.next' - production-branch: main - github-token: ${{ secrets.GITHUB_TOKEN }} - deploy-message: "Deploy from GitHub Actions" - env: - NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} - NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} - timeout-minutes: 1 \ No newline at end of file From 880a1ca6b998552039ef67c17b30cf77c0e7fe81 Mon Sep 17 00:00:00 2001 From: Matej Sima Date: Wed, 5 Feb 2025 16:13:02 +0100 Subject: [PATCH 37/37] make sidebar items in 3rd level of nesting not overflow --- src/assets/globals.css | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/assets/globals.css b/src/assets/globals.css index 935caa0..6bf5a15 100644 --- a/src/assets/globals.css +++ b/src/assets/globals.css @@ -58,3 +58,11 @@ @apply bg-background text-foreground; } } + +.nextra-sidebar-container ul > li ul > li ul > li a { + text-overflow: ellipsis; + white-space: nowrap; + max-width: 152px; + display: inline-block; + overflow: hidden; +}